AGagentkey
ecommerce/tiktok_shop

Best-selling / trending product listings on TikTok Shop, optionally within a category. Returns a normalized Product page.

The platform's own best-seller or trending ranking on TikTok Shop. Pass a category when the platform ranks per category. Normalized to the Product object; page with next_cursor.

Fixed price: 0.2 credits per successful call, whichever provider serves it.

post/v2/ops/ecommerce.tiktok_shop.product.rank

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/ecommerce.tiktok_shop.product.rank
  • Auth
    HTTP bearer

Request body

categorystring

Numeric TikTok Shop category id (required on TikTok Shop: the upstream lists products per category only; e.g. 601152 Beauty & Personal Care, 601739 Phones & Electronics).

cursorstring

Opaque pagination cursor from the previous response's next_cursor. Send the same parameters with it.

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

limitinteger

Maximum number of products to return.

providerstring

Shorthand for routing.only = [provider].

region'US' | 'GB' | 'SG' | 'MY' | 'PH' | 'TH' | 'VN' | 'ID'

TikTok Shop market (ISO 3166-1 alpha-2).

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.