TikTok Shop
Retrieve shop with the TikTok API. Input fields and response shapes depend on the selected implementation. Use it for catalog research or marketplace monitoring. Choose an implementation and check its published request fields, examples, and usage pricing before integrating.
- Selected price
- $0.00095 / callPublished pricing
- Sellers / implementations
- 4 / 29
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
Current TikTok Shop Search · POST | $0.00095 / call | — | —successP50— | |
| TikTok Shop Search Suggestions · POST | $0.00095 / call | —Select to load statistics | —successP50— | |
| TikTok Shop User Showcase · POST | $0.0012 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Product Reviews · POST | $0.00095 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Product · POST | $0.00095 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Creator · POST | $0.0055 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Store Products · POST | $0.0012 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Categories · POST | $0.0012 / call | —Select to load statistics | —successP50— | |
| TikTok Shop Product Details API (V1) · GET | $0.015385 / call | —Select to load statistics | —successP50— | |
| TikTok Shop — User Showcase · GET | $0.00188 / call | —Select to load statistics | —successP50— | |
| TikTok Shop — Product Reviews · GET | $0.00188 / call | —Select to load statistics | —successP50— | |
| TikTok Shop — Product Details · GET | $0.00188 / call | —Select to load statistics | —successP50— | |
| TikTok Shop — Shop Products · GET | $0.00188 / call | —Select to load statistics | —successP50— | |
| TikTok Shop — Shop Search · GET | $0.00188 / call | —Select to load statistics | —successP50— | |
| Get product detail V3 (Full Data) · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get shopping creator information · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get hot selling products list · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get Product ID by Share Link · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get search keyword suggestions V2 (Mobile) · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get product detail V2 (Less Data) · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get seller products list V2 (Mobile, US only) · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get seller products list V1 · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get product category list · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get products by category ID · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get Showcase Product List · POST | $0.001 / call | —Select to load statistics | —successP50— | |
| Get live room product list data V2 · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get product detail V1 · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get product reviews V2 · GET | $0.001 / call | —Select to load statistics | —successP50— | |
| Get live room product list data · GET | $0.001 / call | —Select to load statistics | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
outputobjectdataobjectitemsobject[]currencystringdiscountPctintegerimagestringoriginalPricenumberpricenumberproductIdstringratingnumberreviewCountintegersellerIdstringshopNamestringsoldCountintegertitlestringurlstring
foundboolean
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
output?: {
data?: {
items?: Array<{
currency?: string;
discountPct?: number;
image?: string;
originalPrice?: number;
price?: number;
productId?: string;
rating?: number;
reviewCount?: number;
sellerId?: string;
shopName?: string;
soldCount?: number;
title?: string;
url?: string;
}>;
};
found?: boolean;
};
};- Method
- POST
- Endpoint
https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"limit": 3,
"query": "phone case"
}'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
fields | URL query parametersquery | string | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. |
max_items | URL query parametersquery | integer | No | Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost. minimum: 0 |
summary | URL query parametersquery | boolean | No | Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost. |
jq | URL query parametersquery | string | No | Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost. |
max_cost_usd | URL query parametersquery | string | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. |
Idempotency-Key | Request headersheaders | string | No | Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict. minLength: 1 · maxLength: 255 |
allowFallbacks | JSON request bodybody | boolean | No | Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price. |
country | JSON request bodybody | string | No | Country code of the TikTok Shop market to search (e.g. US). enum: "US", "VN", "TH", "PH", "MY", "ID", "GB", "SG", "ES", "MX", "DE", "IT", "FR", "BR", "JP" |
ignoreSources | JSON request bodybody | array | No | Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way.Nested fields and variants
|
limit | JSON request bodybody | integer | No | Maximum products to return, honoured on US searches up to 30. Other countries and larger values return every product TikTok Shop gives for the query, typically about 30 and occasionally more than 50. The price per call is the same either way. minimum: 1 |
preferLatencyUnderMs | JSON request bodybody | integer | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. minimum: 1 |
query | JSON request bodybody | string | Yes | Search keyword for TikTok Shop products (e.g. wireless earbuds). |
requireFields | JSON request bodybody | array | No | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `currency`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge.Nested fields and variants
|
source | JSON request bodybody | array | No | Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`.Nested fields and variants
|
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Configured HTTP 200; actual status is unverified. Example from the provider's documentation. Field values in your results will differ.
{
"output": {
"data": {
"items": [
{
"currency": "USD",
"discountPct": 35,
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/casecraft-clear-magsafe~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 19.99,
"price": 12.99,
"productId": "1729511239487602341",
"rating": 4.6,
"reviewCount": 6412,
"sellerId": "7398201134587690001",
"shopName": "CaseCraft Official Store",
"soldCount": 84200,
"title": "MagSafe Compatible Clear Phone Case with Card Holder, Shockproof",
"url": "https://www.tiktok.com/shop/pdp/magsafe-compatible-clear-phone-case-with-card-holder-shockproof/1729511239487602341"
},
{
"currency": "USD",
"discountPct": 37,
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/gripguard-silicone-ring~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 14.99,
"price": 9.49,
"productId": "1729511239487602358",
"rating": 4.4,
"reviewCount": 2107,
"sellerId": "7398201134587690088",
"shopName": "GripGuard Store",
"soldCount": 31500,
"title": "Silicone Phone Case with Ring Holder, Drop Protection",
"url": "https://www.tiktok.com/shop/pdp/silicone-phone-case-with-ring-holder-drop-protection/1729511239487602358"
},
{
"currency": "USD",
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/wander-leather-wallet~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 16.99,
"price": 16.99,
"productId": "1729511239487602372",
"rating": 4.8,
"reviewCount": 843,
"sellerId": "7398201134587690123",
"shopName": "Wander Leather Co",
"soldCount": 9860,
"title": "Leather Wallet Phone Case, Detachable Strap",
"url": "https://www.tiktok.com/shop/pdp/leather-wallet-phone-case-detachable-strap/1729511239487602372"
}
]
},
"found": true
}
}Composite rule pricing
Calculated from input parameters and actual returned quantities. Estimate the maximum cost before calling.
Only requests matching a listed pricing variant are accepted. One matching variant replaces the base fee. Matching add-ons and quantity charges are added.
| Fee item | Price | Metering source | When | Quantity limit |
|---|---|---|---|---|
| Variant · 指定来源且关闭回退时的原厂基础费 | $0.000950 | Request conditions | selected_source eq ["anonymous-flamingo"] AND allow_fallbacks eq false | — |
Each quantity charge is rounded before summing: ceil. Requests exceeding this cost limit are rejected; it is not a price cap: $0.000950.
Pricing parameters and defaults
[
{
"default": [
"anonymous-flamingo"
],
"id": "selected_source",
"location": "body",
"pointer": "/source",
"required": false,
"type": "array"
},
{
"default": false,
"id": "allow_fallbacks",
"location": "body",
"pointer": "/allowFallbacks",
"required": false,
"type": "boolean"
}
]Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# TikTok Shop
Retrieve shop with the TikTok API. Input fields and response shapes depend on the selected implementation. Use it for catalog research or marketplace monitoring. Choose an implementation and check its published request fields, examples, and usage pricing before integrating.
## Available implementations
anyapi · TikTok Shop Search: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=0ac9a489-499a-48af-ae7a-5678216febcc · $0.00095 / call
anyapi · TikTok Shop Search Suggestions: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=4712350c-9fc7-4a52-85ac-98875be6c113 · $0.00095 / call
anyapi · TikTok Shop User Showcase: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=766d6ac3-87dd-4b9b-ad72-a3c3f2eaca95 · $0.0012 / call
anyapi · TikTok Shop Product Reviews: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=99d34728-7477-47ff-8093-418d8f70c78c · $0.00095 / call
anyapi · TikTok Shop Product: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=caab410e-e520-4807-becf-9f57956d981a · $0.00095 / call
anyapi · TikTok Shop Creator: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=e90e34f8-4416-4712-81ac-f0f59bf41d6b · $0.0055 / call
anyapi · TikTok Shop Store Products: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=eaf5fa93-a4fd-4f1a-aaec-1860cdffe041 · $0.0012 / call
anyapi · TikTok Shop Categories: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=fafd5003-198b-4030-960f-327f2a03dd32 · $0.0012 / call
justoneapi · TikTok Shop Product Details API (V1): https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=df986cb0-f77d-4779-9d1b-b4b2059db390 · $0.015385 / call
scrapecreators · TikTok Shop — User Showcase: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=4a27ef6e-316e-4159-80d3-e3e9fda4f4d9 · $0.00188 / call
scrapecreators · TikTok Shop — Product Reviews: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=55100c0c-b685-4ed3-967e-05db196c2d9d · $0.00188 / call
scrapecreators · TikTok Shop — Product Details: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=5f0f32fb-94a6-4e67-9c19-d3dbeee02700 · $0.00188 / call
scrapecreators · TikTok Shop — Shop Products: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=6104284d-5e31-47eb-b316-be81d4f10a88 · $0.00188 / call
scrapecreators · TikTok Shop — Shop Search: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=e9cdddfc-8e60-4c2e-b4a8-b53415a9329c · $0.00188 / call
tikhub · Get product detail V3 (Full Data): https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=13340da3-921c-4279-9b86-498d3c5b61eb · $0.001 / call
tikhub · Get shopping creator information: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=30728936-8c3d-4272-b631-24a91ae1510e · $0.001 / call
tikhub · Get hot selling products list: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=383ec77f-4b92-4bcf-bf83-221b51455997 · $0.001 / call
tikhub · Get Product ID by Share Link: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=499c305f-ed26-40b6-b275-d6e4bb875e50 · $0.001 / call
tikhub · Get search keyword suggestions V2 (Mobile): https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=783072b8-3a43-4ac8-93f6-797c9f45d3e1 · $0.001 / call
tikhub · Get product detail V2 (Less Data): https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=7e9f6532-03ed-47b0-86fd-2e984ab4c1f2 · $0.001 / call
tikhub · Get seller products list V2 (Mobile, US only): https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=8396964b-744d-4ce7-a894-3b791171d7db · $0.001 / call
tikhub · Get seller products list V1: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=842b8214-285d-4793-8614-edd5186112a6 · $0.001 / call
tikhub · Get product category list: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=911f93a5-04b8-43ba-9e32-f1f6a6f704ca · $0.001 / call
tikhub · Get products by category ID: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=9a5dda62-1951-48cd-bfc6-fb2222f4c108 · $0.001 / call
tikhub · Get Showcase Product List: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=c3c46b32-a145-4296-b211-8bab3ded7b58 · $0.001 / call
tikhub · Get live room product list data V2: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=e2cc06e4-b370-497b-aca2-260b73348325 · $0.001 / call
tikhub · Get product detail V1: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=f5c65d8c-e3ac-4d83-a27b-05135b2e4024 · $0.001 / call
tikhub · Get product reviews V2: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=fac7f675-ba8d-4918-9794-b59ab9c48353 · $0.001 / call
tikhub · Get live room product list data: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5?offering=fb5d0339-32ba-43a6-90ba-0628e94fce23 · $0.001 / call
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/tiktok-shop-c20ee6f5
Method: POST
Endpoint: https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search
Price: $0.00095 / call
Provider: anyapi
Contract revision: 6
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"limit": 3,
"query": "phone case"
}'
```
## API contract
```json
{
"resource_type": "api",
"name": "TikTok Shop Search",
"endpoint": "https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search",
"method": "POST",
"content_type": "application/json",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost.",
"location": "query",
"name": "fields",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost.",
"location": "query",
"minimum": "0",
"name": "max_items",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost.",
"location": "query",
"name": "summary",
"nullable": false,
"required": false,
"type": "boolean"
},
{
"description": "Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost.",
"location": "query",
"name": "jq",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price.",
"location": "query",
"name": "max_cost_usd",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict.",
"location": "header",
"max_length": 255,
"min_length": 1,
"name": "Idempotency-Key",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price.",
"location": "body",
"name": "allowFallbacks",
"nullable": false,
"pointer": "/allowFallbacks",
"required": false,
"type": "boolean"
},
{
"description": "Country code of the TikTok Shop market to search (e.g. US).",
"enum_values": [
"US",
"VN",
"TH",
"PH",
"MY",
"ID",
"GB",
"SG",
"ES",
"MX",
"DE",
"IT",
"FR",
"BR",
"JP"
],
"location": "body",
"name": "country",
"nullable": false,
"pointer": "/country",
"required": false,
"type": "string"
},
{
"description": "Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way.",
"item_type": "string",
"location": "body",
"name": "ignoreSources",
"nullable": false,
"pointer": "/ignoreSources",
"required": false,
"type": "array"
},
{
"description": "Maximum products to return, honoured on US searches up to 30. Other countries and larger values return every product TikTok Shop gives for the query, typically about 30 and occasionally more than 50. The price per call is the same either way.",
"location": "body",
"minimum": "1",
"name": "limit",
"nullable": false,
"pointer": "/limit",
"required": false,
"type": "integer"
},
{
"description": "Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted.",
"location": "body",
"minimum": "1",
"name": "preferLatencyUnderMs",
"nullable": false,
"pointer": "/preferLatencyUnderMs",
"required": false,
"type": "integer"
},
{
"description": "Search keyword for TikTok Shop products (e.g. wireless earbuds).",
"location": "body",
"name": "query",
"nullable": false,
"pointer": "/query",
"required": true,
"type": "string"
},
{
"description": "Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `currency`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge.",
"item_type": "string",
"location": "body",
"name": "requireFields",
"nullable": false,
"pointer": "/requireFields",
"required": false,
"type": "array"
},
{
"description": "Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`.",
"item_type": "string",
"location": "body",
"name": "source",
"nullable": false,
"pointer": "/source",
"required": false,
"type": "array"
}
],
"billing": {
"currency": "USD",
"mode": "rules",
"parameters": [
{
"default": [
"anonymous-flamingo"
],
"id": "selected_source",
"location": "body",
"pointer": "/source",
"required": false,
"type": "array"
},
{
"default": false,
"id": "allow_fallbacks",
"location": "body",
"pointer": "/allowFallbacks",
"required": false,
"type": "boolean"
}
],
"policy_version": 2,
"sale": {
"addons": [],
"base_price_micro_usd": "951",
"max_cost_micro_usd": "950",
"quantities": [],
"rounding": "ceil",
"variants": [
{
"id": "selected_source_only",
"label": "指定来源且关闭回退时的原厂基础费",
"price_micro_usd": "950",
"when": [
{
"op": "eq",
"parameter": "selected_source",
"value": [
"anonymous-flamingo"
]
},
{
"op": "eq",
"parameter": "allow_fallbacks",
"value": false
}
]
}
]
}
},
"examples": [
{
"http_status": 200,
"name": "Official example (output fragment; HTTP assumed)",
"request": {
"body": {
"limit": 3,
"query": "phone case"
},
"headers": {},
"path": {},
"query": {}
},
"response_body": {
"output": {
"data": {
"items": [
{
"currency": "USD",
"discountPct": 35,
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/casecraft-clear-magsafe~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 19.99,
"price": 12.99,
"productId": "1729511239487602341",
"rating": 4.6,
"reviewCount": 6412,
"sellerId": "7398201134587690001",
"shopName": "CaseCraft Official Store",
"soldCount": 84200,
"title": "MagSafe Compatible Clear Phone Case with Card Holder, Shockproof",
"url": "https://www.tiktok.com/shop/pdp/magsafe-compatible-clear-phone-case-with-card-holder-shockproof/1729511239487602341"
},
{
"currency": "USD",
"discountPct": 37,
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/gripguard-silicone-ring~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 14.99,
"price": 9.49,
"productId": "1729511239487602358",
"rating": 4.4,
"reviewCount": 2107,
"sellerId": "7398201134587690088",
"shopName": "GripGuard Store",
"soldCount": 31500,
"title": "Silicone Phone Case with Ring Holder, Drop Protection",
"url": "https://www.tiktok.com/shop/pdp/silicone-phone-case-with-ring-holder-drop-protection/1729511239487602358"
},
{
"currency": "USD",
"image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/wander-leather-wallet~tplv-o3syd03w52-origin-webp.image",
"originalPrice": 16.99,
"price": 16.99,
"productId": "1729511239487602372",
"rating": 4.8,
"reviewCount": 843,
"sellerId": "7398201134587690123",
"shopName": "Wander Leather Co",
"soldCount": 9860,
"title": "Leather Wallet Phone Case, Detachable Strap",
"url": "https://www.tiktok.com/shop/pdp/leather-wallet-phone-case-detachable-strap/1729511239487602372"
}
]
},
"found": true
}
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example (output fragment; HTTP assumed)
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 14
Review these request fields before running. Keep the published provider and request method unchanged.
fields- Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost.
max_items- Optional. Cap the number of result rows returned; a `_truncated` note reports how many were withheld so you can page via the API's own `limit`. An API that returns one record is not trimmed. Does not change cost.
summary- Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost.
jq- Optional. A jq expression applied to the result envelope; its output replaces `output` (multiple outputs collect into an array). Reshape freely, e.g. `jq=.data | {title, description, md: .markdown[:3500]}`. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a `jqError`. Does not change cost.
max_cost_usd- Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price.
Idempotency-Key- Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict.
allowFallbacks- Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price.
country- Country code of the TikTok Shop market to search (e.g. US).
ignoreSources- Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way.
limit- Maximum products to return, honoured on US searches up to 30. Other countries and larger values return every product TikTok Shop gives for the query, typically about 30 and occasionally more than 50. The price per call is the same either way.
preferLatencyUnderMs- Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted.
query- Search keyword for TikTok Shop products (e.g. wireless earbuds).
requireFields- Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `currency`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a product that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge.
source- Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/anyapi/v1/run/tiktok_shop.search' \ -X POST \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json' \ --data-raw '{ "limit": 3, "query": "phone case" }'Check the response
Sample response · Configured HTTP 200; actual status is unverified.
Sample response{ "output": { "data": { "items": [ { "currency": "USD", "discountPct": 35, "image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/casecraft-clear-magsafe~tplv-o3syd03w52-origin-webp.image", "originalPrice": 19.99, "price": 12.99, "productId": "1729511239487602341", "rating": 4.6, "reviewCount": 6412, "sellerId": "7398201134587690001", "shopName": "CaseCraft Official Store", "soldCount": 84200, "title": "MagSafe Compatible Clear Phone Case with Card Holder, Shockproof", "url": "https://www.tiktok.com/shop/pdp/magsafe-compatible-clear-phone-case-with-card-holder-shockproof/1729511239487602341" }, { "currency": "USD", "discountPct": 37, "image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/gripguard-silicone-ring~tplv-o3syd03w52-origin-webp.image", "originalPrice": 14.99, "price": 9.49, "productId": "1729511239487602358", "rating": 4.4, "reviewCount": 2107, "sellerId": "7398201134587690088", "shopName": "GripGuard Store", "soldCount": 31500, "title": "Silicone Phone Case with Ring Holder, Drop Protection", "url": "https://www.tiktok.com/shop/pdp/silicone-phone-case-with-ring-holder-drop-protection/1729511239487602358" }, { "currency": "USD", "image": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/wander-leather-wallet~tplv-o3syd03w52-origin-webp.image", "originalPrice": 16.99, "price": 16.99, "productId": "1729511239487602372", "rating": 4.8, "reviewCount": 843, "sellerId": "7398201134587690123", "shopName": "Wander Leather Co", "soldCount": 9860, "title": "Leather Wallet Phone Case, Detachable Strap", "url": "https://www.tiktok.com/shop/pdp/leather-wallet-phone-case-detachable-strap/1729511239487602372" } ] }, "found": true } }
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use TikTok Shop with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.