DataNavoAPI / APIS / DOUYIN

Douyin user search

Douyin user search: inspect inputs, account fields, pagination and limits, then run a local simulated request.

LOCAL SIMULATIONAll displayed records are fictional fixtures. Live APIs, payments and external email are disabled.中文版 ↗
01

What this capability does

Douyin user search uses /v1/douyin/users/search; GET returns data.items with account objects.

This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.

  • Capability: douyin.users.search
  • Pagination: use the signed cursor from the response and request each page explicitly.
02

Input contract

Inspect meanings, examples and conditional rules for the selected method. view and fields control the response without changing the TEST unit price.

  • Only send fields defined for this method; unknown fields are rejected before execution.
MethodFieldTypeRequirementMeaningEnum or boundExample
GETquerystringRequiredSearch terms—"博物馆"
GETcursorstringOptional / conditionalThe `next_cursor` of the previous page. A new page is a new call.——
GETviewstringOptional / conditionalHow much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).["compact","standard","full"]—
GETfieldsarrayOptional / conditionalReturn only these fields of each item, by path (`author.name`).maxItems: 64—
03

Try it locally

Use demo to inspect the fields, then explicitly select simulated with a customer test key to exercise settlement. Never put a customer key in a URL.

json
{
  "capability": "douyin.users.search",
  "method": "GET",
  "params": {
    "query": "博物馆"
  }
}
04

Output fields and interpretation

The account object permits missing or null values; do not replace missing measurements with zero. This table shows the main structure; the object reference covers nested fields.

FieldTypeMeaningSource scope
idstring | nullIDDouyin
usernamestring | nullHandleDouyin
namestring | nullDisplay nameDouyin
urlstring | nullLink to the profileDouyin
biostring | nullBioDouyin
avatar_urlstring | nullAvatar (standard view and up)Douyin
verifiedboolean | nullWhether the account is verified (standard view and up)Douyin
created_atstring | nullWhen the account was created (standard view and up)Douyin
metricsobject | nullAccount countsDouyin
metrics.followersinteger | nullFollowersDouyin
metrics.followinginteger | nullFollowingDouyin
metrics.postsinteger | nullPosts publishedDouyin
approximatearray | nullWhich numbers of this item are approximate or lower bounds; absent when all are exactDouyin
approximate[].fieldstring | nullPath of the field, such as metrics.viewsDouyin
approximate[].kindstring | nullApproximate, or a lower boundDouyin
extobject—Douyin
ext.likesinteger | nullLikes received in all, on videos, articles and posts: the number the profile shows (full view)Douyin
ext.uidstring | nullThe account's numeric ID (uid): what the account history and trend-index creator endpoints take, not the Douyin handle (username) (full view)Douyin
ext.is_liveboolean | nullWhether the account was live when the profile was fetched (full view)Douyin
ext.live_room_idstring | nullID of the live room while the account is live; null when it is not (full view)Douyin
ext.has_shopboolean | nullWhether the profile has a product showcase (橱窗) entry (full view)Douyin
ext.live_commerceboolean | nullWhether the platform marks the account as able to sell in live streams (full view)Douyin
ext.verified_labelstring | nullThe line beside the verification badge, in the platform's words (such as 店铺账号, a shop account); null without a badge (full view)Douyin
ext.is_businessboolean | nullWhether it carries an organisation's, business's or shop's verification (the blue V), not a person's (full view)Douyin
ext.ip_locationstring | nullIP location as the platform shows it (a province or a country, without the IP属地 label); null for an account that shows none (full view)Douyin
05

Unavailable fields

These published contract notes describe the capability boundary; fixtures do not establish live availability.

FieldReason
usernamecapability
biocapability
verifiedcapability
created_atplatform
metrics.followingcapability
06

Limits and checks

A successful request does not establish full coverage. Preserve the request ID, observation time, parameters and cursor, and inspect the returned items before analysis.

Local simulation uses TEST credits only. Real provider calls, real payments and external email are disabled. Historical reference-site prices are not DataNavoAPI prices.

  • Verify media URLs, counts and optional fields individually.
TRY THE CONTRACT

Clear inputs. Inspectable output.

Each click runs a local fixture. Advanced JSON inputs are checked against the selected method. Editing does not execute a request.

Copying does not execute. CLI quote is read-only and needs a local customer TEST key. Configure MCP in demo mode first. GET and POST batches both return only fictional local fixtures.

Download contract example (no execution) ↗

For TEST budgets, Key scopes or failure scenarios, open the account console. Customer sandbox ↗