# Tiktokshop on Onekey

> 5 endpoints for Tiktokshop (0 stable, 5 beta), 2 credits each. Category: Social networks. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 5 of 5 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/tiktokshop
Reference (Markdown): https://onekey.dev/docs/api/tiktokshop.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 5 mapped Tiktokshop endpoints return each:

- `entity.createdAt` (ISO 8601 date): 4
- `entity.description` (string): 4
- `entity.id` (string): 4
- `entity.location` (string): 4
- `entity.name` (string): 4
- `entity.url` (URL): 4
- `listing.currency` (string): 4
- `listing.price` (number): 4
- `listing.seller` (string): 4
- `media.thumbnailUrl` (URL): 4
- `author.username` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.id` (string): 1
- `content.text` (string): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### tiktokshop.product

Get TikTok Shop product details.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/tiktokshop/product?url=https%3A%2F%2Fshop.tiktok.com%2Fview%2Fproduct%2F1729384756102938475` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, optional): Url (URL)
  - `product_id` (string, optional): TikTok Shop product id (alternative to url)
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `listing.currency`, `media.thumbnailUrl`, `listing.seller`, `entity.location`, `entity.createdAt`, `ext.rating`, `ext.reviewCount`, `ext.soldCount`
- Reference: https://onekey.dev/docs/api/tiktokshop/product.md

### tiktokshop.product_reviews

List TikTok Shop product reviews.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tiktokshop/product_reviews?url=https%3A%2F%2Fshop.tiktok.com%2Fview%2Fproduct%2F1729384756102938475` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, optional): Url (URL)
  - `product_id` (string, optional): TikTok Shop product id (alternative to url)
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `author.username`, `ext.rating`
- Reference: https://onekey.dev/docs/api/tiktokshop/product_reviews.md

### tiktokshop.products

List TikTok Shop products.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tiktokshop/products?url=https%3A%2F%2Fshop.tiktok.com%2Fview%2Fproduct%2F1729384756102938475` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Url (URL)
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `listing.currency`, `media.thumbnailUrl`, `listing.seller`, `entity.location`, `entity.createdAt`, `ext.rating`, `ext.reviewCount`, `ext.soldCount`
- Reference: https://onekey.dev/docs/api/tiktokshop/products.md

### tiktokshop.search

Search TikTok Shop products.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tiktokshop/search?query=coffee` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `listing.currency`, `media.thumbnailUrl`, `listing.seller`, `entity.location`, `entity.createdAt`, `ext.rating`, `ext.reviewCount`, `ext.soldCount`
- Reference: https://onekey.dev/docs/api/tiktokshop/search.md

### tiktokshop.user_showcase

List TikTok user showcase products.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/tiktokshop/user_showcase?handle=natgeo` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, required): Handle
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `listing.price`, `listing.currency`, `media.thumbnailUrl`, `listing.seller`, `entity.location`, `entity.createdAt`, `ext.rating`, `ext.reviewCount`, `ext.soldCount`
- Reference: https://onekey.dev/docs/api/tiktokshop/user_showcase.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/tiktokshop/product?url=https%3A%2F%2Fshop.tiktok.com%2Fview%2Fproduct%2F1729384756102938475" \
  -H "x-api-key: YOUR_API_KEY"
```