TikTok API Capability

Shop product search

US Shop keyword results from the primary search component, with scoped pagination.

Capability ID tiktok.shop.search

Cost 1 credit per request

Maximum runtime 45 seconds

# Shop product search

US Shop keyword results from the primary search component, with scoped pagination.

- Platform: [TikTok](https://docs.upscrape.com/docs/platforms/tiktok)
- Capability ID: `tiktok.shop.search`
- Cost: 1 credit per request
- Maximum runtime: 45 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "query": "shoes"
  },
  "capability": "tiktok.shop.search"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | `string` | No | Opaque bounded pagination cursor from this same query/store; not a session credential. |
| `query` | `string` | Yes | Search query. |
| `region` | `string` | No | Region supplied for this request. Allowed values: `US`. |

### Example input

```json
{
  "query": "shoes"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

cursor string optional

Opaque bounded pagination cursor from this same query/store; not a session credential.

query string required

Search query.

Example shoes

region string optional

Region supplied for this request. Allowed values: `US`.

Available values US

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "query": "shoes" }, "capability": "tiktok.shop.search" }'

import json import requests payload = json.loads(r'''{ "input": { "query": "shoes" }, "capability": "tiktok.shop.search" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))