SignalShelf · Developer documentation

TikTok Shop · profile region

Read the registered region from the TikTok Shop creator profile connected to this SignalShelf user. GET /api/v1/tiktok-shop/profile-region accepts your x-api-key header. TikTok Shop Affiliate Creator API access requires provider activation, creator authorization, and applicable app review. Paid-use and retention clearance and live validation are outstanding. This owner-authorized route reads only an account connected by the caller; it does not perform arbitrary public lookup.

Request parameters

Read the registered region returned for the TikTok Shop creator account connected to this SignalShelf user. This owner-authorized partial does not look up arbitrary TikTok handles.

ParameterTypeRequiredDescription
handlestringYesTikTok username; must match the connected creator account.
freshnessstringNo24h (default), 1h, 7d, or live. Accepted cache hits are free; live forces refresh except simultaneous requests may share newly fetched data.

Code examples

Set SIGNALSHELF_BASE_URL and SIGNALSHELF_API_KEY on your server.

REQUEST EXAMPLE
curl "$SIGNALSHELF_BASE_URL/api/v1/tiktok-shop/profile-region?handle=handle" \
  -H "x-api-key: $SIGNALSHELF_API_KEY"

Response and pagination

The compatibility response includes handle, profile_url, and region. region maps only to TikTok Shop register_region; the canonical profile_url is generated from the verified connected username.

This is owner-authorized partial coverage. handle must match the TikTok Shop creator connected by the caller. register_region is different from selection_region; arbitrary public handles are not supported.

The response contains data and meta. data includes platform, resource, sample:false, provider, and the public source payload. Lists return data.items; individual resources return data.data.

Shop lists use the provider next_page_token as an opaque cursor; no cursor is returned for Profile Region.

meta includes event_id, mode, cache, credits_charged, fetched_at, age_seconds, and duration_ms. A fresh successful result costs one credit; accepted cached results and failures cost zero.

Availability and failures

Implementation is not a continuous availability guarantee. Source rate limits, retention, deleted content, restrictions, and regional availability apply. This is an independent SignalShelf contract, not a drop-in competitor response format.

400: invalid parameters. 401: missing/revoked key. 402: insufficient credits. 404: missing public resource. 429: SignalShelf throttle. 502/503: upstream failure or rate limit, with credit restored.

Explore the API in your workspace. Sample results and accepted cache hits cost zero credits. Open the playground →