Search documentation

Search tools, API guides and billing.

to navigateEnter to openEsc to close
API overview
API reference

API overview

A single interface for commerce data discovery, calls and billing.

Authentication

Use Authorization: Bearer <SELLERTOOL_API_KEY> for data calls. Create and revoke keys in the console. Keys can access this account’s queries and balance, and submit paid calls. They cannot manage credentials, accounts or payments. The web console also supports session authentication.

Endpoints

  • GET /api/tools: platform/capability tools such as TikTok and Instagram; callable tools are shown by default. Filter by search, provider, data category and status.
  • GET /api/tools/tiktok: inspect the TikTok tool and its paginated APIs.
  • GET /api/endpoints?tool=tiktok&status=available&page=1: find callable APIs, with 24 entries per page.
  • GET /api/tools/{endpointId}: inspect one API’s schema, price, limits and availability.
  • POST /api/jobs: submit a call with kind and input.
  • GET /api/jobs/{id}: poll status and retrieve structured results.
  • GET /api/jobs: list this account’s calls.
  • GET /api/credits: read balance and prices.

Use the query API for request format and retry behavior. MCP transport is not implemented yet; agents currently connect through HTTP.

The hierarchy is data category → tool → API. Tool IDs such as tiktok are for discovery; submit the internal API’s endpoint ID as kind. Existing endpoint IDs and curated query IDs remain compatible. Flat discovery remains available at /api/endpoints or /api/tools?view=endpoints. Native input uses body, query and path only when declared. Results use the endpoint-json artifact; exports are JSON.

The shared denomination is 1 USD = 10,000 credits. Configured TikHub APIs expose officialPrice (official USD base price, eligibility and snapshot time) alongside the charged policy.credits; settlement uses the credit price saved when the job was created. Native array or scalar JSON bodies are represented by a named field in the tool schema and restored to the native payload by the server.