One generic endpoint — pass a service_code to select the function you want. Pricing is identical to the website, whether you call it directly or through a chat interface.
Create an API key from the console, then pass it in the Authorization header. Only Max and above subscription tiers can create keys.
A trimmed spec covering only this API, with a payload schema per service_code. Import it straight into Postman / Insomnia / a client generator: /developer/openapi.json · /developer/openapi.yaml
The same functions are exposed as MCP tools over Streamable HTTP. Add a server in Claude Desktop / n8n / Clay or any MCP-capable platform with the URL below and the same API key as Bearer auth. Each function is one tool; call list_services first for prices and balance.
Pass an idempotency_key (a uuid4 is recommended) — repeating the same key returns the original result and never charges twice. If omitted, the server generates one without retry protection.
No Max/Business subscription required — grab a sk-test- key from the console after logging in, and call all 13 functions for free. Responses are real, structurally accurate example data (not live queries — the data will be stale), 20 free calls per function per month, no spTok charged. To go to production, upgrade your subscription and swap in a real key; no code changes needed.
Responses carry sandbox:true and a sandbox_note with usage; once the quota is used up you get 402 sandbox_quota_exceeded.
report.new_product_intelligence (20-40s) and report.target_list_export (1-3 min) — the two slowest calls — support async:true. Charging still happens synchronously (identical rules to the non-async path); only the engine run is deferred. The request returns 202 with a job_id immediately instead of holding the connection open for minutes.
callback_url is entirely optional — poll this endpoint until status becomes succeeded/failed. status is one of queued/running/succeeded/failed.
callback_url must be https:// and cannot point at a private/loopback address. On completion we POST to it with the body shown below; on failure (non-2xx or timeout) we retry with backoff — 10s/1min/5min/15min/1h/3h/6h/12h, 8 attempts — then mark it exhausted. That only affects the push: the result itself is always available from the status endpoint above, it is never lost.
Verify with: X-SiLink-Signature is sha256=hmac_sha256(callback_secret, raw request body bytes). callback_secret is shown once, in the 202 response — save it immediately.
Counted per API key over a 60-second sliding window. Exceeding the limit returns 429 with retry_after (seconds) and limit_per_min in the body, plus a standard Retry-After header your SDK can back off on.
| Subscription tier | Requests per minute |
|---|---|
| max | 60 |
| business | 600 |
Partner platforms needing higher limits: contact us.
Every success response is ok:true + result. The shape of result depends on the service_code; billing fields differ by whether the service is pooled.
Charged per call against the saved payment method. On success you get usd_charged + payment_intent_id. If the automatic charge fails you get HTTP 200 with ok:false and a checkout_url — nothing is run or charged in that case.
Once the user has paid at checkout_url, POST to deliver_url with the same key: the service runs and returns its result. Until payment completes you get 402 checkout_pending. deliver is idempotent — repeat calls replay the result and never charge twice.
report.* services return download_urls inside result; fetch PDF/DOCX/MD/TXT from there — the file is never inlined in the response.
| Status | error | Meaning |
|---|---|---|
| 400 | unknown_service_code | Unknown service_code; the available field lists valid ones |
| 400 | engine_rejected_input | Engine rejected the payload. Any charge is refunded automatically |
| 401 | — | Invalid or inactive API key |
| 402 | insufficient_sptok | Insufficient spTok balance; body includes need/have |
| 402 | volume_over_limit | Over 100k calls this month; custom quote required |
| 403 | tier_insufficient | Subscription tier lacks API access (Max or above required) |
| 402 | checkout_pending | deliver endpoint: payment not completed yet |
| 400 | async_not_supported | This service_code does not support async:true; body lists which ones do |
| 400 | invalid_callback_url | callback_url must be https:// and not point at a private/loopback address |
| 429 | rate_limited | Rate limit exceeded, see Rate limits above |
| 500 | engine_error | Engine failed. Any charge is refunded automatically |
Every non-2xx response has the shape {"detail":{"error":"…","msg":"…"}}. A failed automatic charge on a non-pooled service is not an error status: it is HTTP 200 + ok:false, see Response format.
Single call takes about 9-12 seconds (two LLM calls + database scan); returns the complete result synchronously with no streaming progress.
product — Product/requirement description (required) · province — Limit to a specific province (optional)
Single call takes about 5-8 seconds; returns the complete result synchronously with no streaming progress.
product — Product/requirement description (required) · province — Limit to a specific province (optional)
Returns the full density ranking across all 31 provinces; if province is provided, also returns the buyer company list for that province.
industry — Industry name (required) · province — If specified, also returns the buyer company list for that province (optional)
Returns the complete list of same-industry competitors, capped at 500 results per call (truncated by score when exceeded; the capped field flags whether truncation occurred).
company — Target company's full legal name (required) · same_province_only — Whether to limit results to the same province (optional, default false)
brand — Brand name (required) · markets — List of target market IDs, see brand_check.MARKETS
identifier — Company's full legal name or 18-digit Unified Social Credit Code (required)
$79 per call, charged from the standard spTok subscription pool (below the $299 threshold). Returns download_urls for PDF/DOCX/MD/TXT reports. Takes about 10-20 seconds.
industry — Industry name (required) · province — Limit to a specific province (optional)
Given an industry, returns the full density ranking across all 31 provinces (not truncated). The semantics are 'recommend a province to land in for this industry' -- not a lookup of details for a single specific province.
industry — Industry name (required), e.g. 'electronics manufacturing'
Uses the same full_compare() engine as the paid flow on /check/compare on the website, which has been verified in production to complete real payment and delivery end to end.
names — Array of company full legal names, 2-5 companies (required)
Returns the purchaser count ranking across all covered countries (not truncated).
product — Product/requirement description (required)
company — Chinese company's full legal name (required)
$899 per call, not drawn from the monthly subscription pool (v3.1 rule: anything above $299 is billed standalone). Attempts to charge the account's saved payment method first; if that fails, returns a checkout_url for manual payment confirmation. Takes about 20-40 seconds.
product — Product/requirement description (required) · mode — 'design' or 'deconstruct', defaults to 'design'
$1200 per call, up to 30 companies with full contact details and a PDF/DOCX/MD/TXT report. Not drawn from the monthly subscription pool -- uses the same off-session charge flow as the New Product Report. Can take 1-3 minutes (includes AI-generated selection rationale and live contact lookup). Returns download_urls; the response body does not include the binary file directly.
industry — Industry name (required) · province — Limit to a specific province (optional) · tiers — Restrict to specific tiers, e.g. ['listed','srdi'] (optional) · min_insured — Minimum insured-employee threshold, default 2 (optional)