API reference / TikTok Shop / LIVE shopping bag

LIVE shopping bag

Products pinned in a LIVE room, with prices and promos.

GETapi.tikultra.com/v1/shop/live-bagPremium · 25 credits
Upstream
/aweme/v2/oec/live/bag/assemble/aweme/v2/oec/live/bag/tabs_and_products
Access
Every planExclusive
Runs on
LeanPool · android · tiktok · 47.6.3
Client
os, app_flavour, app_version overrides
Billing
Failed calls are free
Older path
/v1/scrape/ecom/live-bag

Authorization

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Query parameters

room_idstringrequired

The numeric LIVE room ID. For example 7705861000123456789.

regionstring

Two-letter country code for egress and storefront. For example US.

Client and egress overrides

Optional. Leave them out to run as android · tiktok · 47.6.3 from the default pool. See Clients and versions.

osstring

android or ios. For example android.

app_flavourstring

Run as tiktok, lite, lite_coin, pro, studio, shop, tv, douyin. For example tiktok.

app_versionstring

A release of that app. Defaults to the current default for (os, app_flavour). For example 47.6.3.

regionstring

Two-letter country code for egress. For example US.

citystring

A supported city in that region. For example miami.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.