# Douyin on Onekey

> 8 endpoints for Douyin (0 stable, 8 beta), 2 to 3 credits each. Category: Social networks. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 8 of 8 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/douyin
Reference (Markdown): https://onekey.dev/docs/api/douyin.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 8 mapped Douyin endpoints return each:

- `author.username` (string): 7
- `engagement.likes` (integer): 6
- `content.createdAt` (ISO 8601 date): 5
- `content.id` (string): 5
- `content.text` (string): 5
- `engagement.comments` (integer): 5
- `author.avatarUrl` (URL): 4
- `engagement.views` (integer): 4
- `media.thumbnailUrl` (URL): 4
- `content.title` (string): 3
- `content.url` (URL): 3
- `engagement.shares` (integer): 3
- `author.displayName` (string): 2
- `author.followers` (integer): 2
- `author.id` (string): 2
- `author.verified` (boolean): 2
- `author.bio` (string): 1
- `author.contentCount` (integer): 1
- `author.following` (integer): 1
- `author.url` (URL): 1
- `entity.id` (string): 1
- `entity.name` (string): 1
- `entity.url` (URL): 1
- plus 4 platform-specific fields under `ext.`

## Endpoints

### douyin.comment_replies

Get replies to a Douyin comment.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/comment_replies?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7123456789012345678&comment_id=1234567890` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Url (URL)
  - `comment_id` (string, required): Comment id
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `author.username`, `author.avatarUrl`
- Reference: https://onekey.dev/docs/api/douyin/comment_replies.md

### douyin.post

Get a Douyin video.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/douyin/post?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7123456789012345678` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Url (URL)
- Fields returned: `content.id`, `content.url`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `engagement.shares`, `engagement.views`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/douyin/post.md

### douyin.post_comments

Get Douyin video comments.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/post_comments?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7123456789012345678` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Url (URL)
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `author.username`, `author.avatarUrl`
- Reference: https://onekey.dev/docs/api/douyin/post_comments.md

### douyin.profile

Get a Douyin creator profile.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/douyin/profile?handle=natgeo` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, optional): Handle
  - `sec_user_id` (string, optional): Douyin sec_user_id (alternative to handle)
  - `url` (string, optional): Full URL of the Douyin profile (alternative to handle)
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.bio`, `author.followers`, `author.following`, `author.contentCount`, `author.verified`, `author.avatarUrl`, `author.url`
- Reference: https://onekey.dev/docs/api/douyin/profile.md

### douyin.profile_posts

List a Douyin creator's videos.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/profile_posts?handle=natgeo` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, optional): Handle
  - `sec_user_id` (string, optional): Douyin sec_user_id (alternative to handle)
  - `url` (string, optional): Full URL of the Douyin profile (alternative to handle)
- Fields returned: `content.id`, `content.url`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `engagement.shares`, `engagement.views`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/douyin/profile_posts.md

### douyin.search

Search Douyin videos.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/search?query=coffee` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Query
- Fields returned: `content.id`, `content.url`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `engagement.shares`, `engagement.views`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/douyin/search.md

### douyin.search_users

Search Douyin creators.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/search_users?query=coffee` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.followers`, `author.verified`, `author.avatarUrl`
- Reference: https://onekey.dev/docs/api/douyin/search_users.md

### douyin.trending

Douyin hot-search board.
- Price: 3 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/douyin/trending` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `engagement.views`, `engagement.likes`, `media.thumbnailUrl`, `ext.rank`, `ext.postCount`, `ext.hotValue`, `ext.ctr`
- Reference: https://onekey.dev/docs/api/douyin/trending.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/douyin/post?url=https%3A%2F%2Fwww.douyin.com%2Fvideo%2F7123456789012345678" \
  -H "x-api-key: YOUR_API_KEY"
```