# SocialCrawl API: douyin endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/douyin

## GET /v1/douyin/search
Search Douyin videos
Credit cost: 5-125 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front - the default limit of 10 holds 50 and the 25 maximum holds 125 - and settles down to the rows actually delivered, so a narrow query that returns 3 videos costs 15 credits however high `limit` was set
Parameters:
- query (required): Search keywords, for example 美食 or coffee.
- limit (optional, integer): Rows to return, 1 to 25. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- sort (optional, enum: relevance | most_liked | latest): Result ordering: relevance, most_liked, or latest. Default relevance.
- published (optional, enum: all | day | week | half_year): Recency window: all, day, week, or half_year. Default all.
- duration (optional, enum: all | under_1m | one_to_five_m | over_5m): Length filter: all, under_1m, one_to_five_m, or over_5m. Default all.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
curl -G "https://www.socialcrawl.dev/v1/douyin/search" \
  --data-urlencode "query=美食" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/profile
Get a Douyin creator profile
Credit cost: 6 (override; tier advanced)
Parameters:
- handle (optional, string): Douyin sec_uid, the MS4wLjAB... string in a profile URL, or the numeric user ID.
- url (optional, string): Full Douyin profile URL, for example https://www.douyin.com/user/MS4wLjABAAAA...
- id (optional, string): Numeric Douyin user ID.
- Constraint: one of handle, url, id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/douyin/profile" \
  --data-urlencode "url=https://www.douyin.com/user/MS4wLjABAAAAtxsy7VmVkU3RN9oIX0vdkh_6-LlQAb0gwI-tDf-bYNg" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/profile/posts
List a Douyin creator's videos
Credit cost: 5-125 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front - the default limit of 10 holds 50 and the 25 maximum holds 125 - and settles down to the videos actually delivered, so a creator with 4 recent videos costs 20 credits however high `limit` was set. `recent_days` and `exclude_pinned` narrow the result set BEFORE billing settles, so they lower the charge as well as the noise
Parameters:
- handle (optional, string): Douyin sec_uid, the MS4wLjAB... string in a profile URL, or the numeric user ID.
- url (optional, string): Full Douyin profile URL.
- id (optional, string): Numeric Douyin user ID.
- limit (optional, integer): Rows to return, 1 to 25. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- recent_days (optional, integer): Only return videos published in the last N days. Leave unset for the newest regardless of age.
- exclude_pinned (optional, boolean): Set true to skip videos pinned to the top of the profile, which can be old.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- Constraint: one of handle, url, id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/douyin/profile/posts" \
  --data-urlencode "url=https://www.douyin.com/user/MS4wLjABAAAAtxsy7VmVkU3RN9oIX0vdkh_6-LlQAb0gwI-tDf-bYNg" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/post
Get a Douyin video
Credit cost: 10 (premium)
Parameters:
- url (required): Douyin video URL, for example https://www.douyin.com/video/7681266289940544369, or the bare numeric aweme ID.
curl -G "https://www.socialcrawl.dev/v1/douyin/post" \
  --data-urlencode "url=https://www.douyin.com/video/7681266289940544369" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/post/comments
Get Douyin video comments
Credit cost: 2-100 (metered): 1 credit per comment RETURNED, with a floor of 2. The call holds `limit x 1` up front - the default limit of 20 holds 20 and the 100 maximum holds 100 - and settles down to the comments actually delivered, so a video with four comments does not cost a twenty-comment request
Parameters:
- url (required): Douyin video URL or the bare numeric aweme ID.
- limit (optional, integer): Comments to return, 1 to 100. Default 20. Each comment costs 1 credit and you are charged only for comments returned.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
curl -G "https://www.socialcrawl.dev/v1/douyin/post/comments" \
  --data-urlencode "url=https://www.douyin.com/video/7681266289940544369" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/comment/replies
Get replies to a Douyin comment
Credit cost: 5-250 (metered): 5 credits per reply RETURNED. The call holds `limit x 5` up front - the default limit of 10 holds 50 and the 50 maximum holds 250 - and settles down to the replies actually delivered. Only a comment with a non-zero `engagement.replies` has a thread, so check that on the parent row before spending a call here With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- url (required): Douyin video URL or the bare numeric aweme ID the comment sits under.
- comment_id (required): The comment to expand, taken from the id field of a GET /v1/douyin/post/comments row. Only comments with a non-zero engagement.replies have a thread.
- limit (optional, integer): Replies to return, 1 to 50. Default 10. Each reply costs 5 credits and you are charged only for replies returned.
- cursor (optional, string): Continuation token from a previous response's pagination block. Omit for the first page.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
curl -G "https://www.socialcrawl.dev/v1/douyin/comment/replies" \
  --data-urlencode "url=https://www.douyin.com/video/7681266289940544369" \
  --data-urlencode "comment_id=7682735175344833317" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/search/users
Search Douyin creators
Credit cost: 5-125 (metered): 5 credits per creator RETURNED. The call holds `limit x 5` up front - the default limit of 10 holds 50 and the 25 maximum holds 125 - and settles down to the creators actually delivered With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- query (required): Search keywords, for example 美食 or a brand name.
- limit (optional, integer): Rows to return, 1 to 25. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- cursor (optional, string): Continuation token from a previous response's pagination block. Omit for the first page.
- followers (optional, enum: all | under_1k | 1k_to_10k | 10k_to_100k | 100k_to_1m | over_1m): Follower band: all, under_1k, 1k_to_10k, 10k_to_100k, 100k_to_1m, or over_1m. Default all.
- user_type (optional, enum: all | regular_user | enterprise_verified | individual_verified): Account type: all, regular_user, enterprise_verified, or individual_verified. Default all.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
curl -G "https://www.socialcrawl.dev/v1/douyin/search/users" \
  --data-urlencode "query=美食" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/douyin/trending
Get the Douyin hot-search board
Credit cost: 25 (override; tier advanced)
curl "https://www.socialcrawl.dev/v1/douyin/trending" \
  -H "x-api-key: YOUR_API_KEY"