Developer API Documentation

Cross-border War Room · REST API reference (auth, endpoints, quotas, errors)

v1.0.0 · OpenAPI 3.0.3 Download OpenAPI JSON Back to War Room

Authentication

Two ways, pick one: (1) Direct (recommended) — send `Authorization: Bearer ` (or the equivalent `X-Api-Token: `); only endpoints in the list below are reachable. (2) Gateway signature — POST /api/dev/gateway with token/secret/signature/endpoint/params, where signature = HMAC-SHA256(secret, method+path+empty query+sha256(body)+ts+nonce); use it when replay protection matters. A key's power equals the account's current plan (Model B) — upgrading the plan upgrades the same key instantly.

Examples

curl -s "https://kuajingyinqing.shop/api/market/live?kw=phone%20case&platforms=amazon&limit=5" \
  -H "Authorization: Bearer $TOKEN"
# Python
import requests
r = requests.get("https://kuajingyinqing.shop/api/market/live",
                 params={"kw": "phone case", "platforms": "amazon", "limit": 5},
                 headers={"Authorization": "Bearer " + TOKEN}, timeout=180)
print(r.json())

Create keys under War Room → System → API Access. Usage is metered per key.

Endpoints

MethodPath DescriptionMin plan
Shops
GET/api/shop/capsCapability matrix for 107 sales platforms (api / rpa / packet / crawl + channel routing)Standard
GET/api/shop/skusListable SKU inventory (content-factory output + sourcing ledger + own product table)Standard
POST/api/shop/packetBuild a platform-importable listing package (JSON + CSV, converted to the target marketplace currency, missing images auto-filled)Standard
POST/api/shop/publishOne-click publishing: route by capability official API -> RPA -> data package; never ends on a fake successStandard
POST/api/shop/crawlRead/write crawl config (channel / target / frequency / timeout / item limit / proxy / UA)Standard
GET/api/shop/packetsList generated listing packagesStandard
GET/api/shop/packet/dumpRead listing package contents (CSV / JSON, for download and preview)Standard
Risk
GET/api/risk/metaRisk dictionary: queryable countries/regions, platforms and official sourcesFree
GET/api/risk/sourcesOfficial sources and coverage (source count / region count / category counts); no login requiredFree
GET/api/risk/queryLook up bans / recalls / customs controls by product x region x platform (concurrent live fetch; anything unavailable is stated as-is)Standard
GET/api/risk/selftestSelf-test that really calls each of the 16 official sources (availability / latency / sample count / failure reason)Premium
Intel
GET/api/trade/categoriesTrade categories and flow list (export / import)Free
GET/api/intel/export/src/saleExport side, sourcing perspective, on-sale intel (directional)Standard
GET/api/intel/import/src/saleImport side, sourcing perspective, on-sale intel (directional)Standard
GET/api/sourcing/intel/metaSourcing intel metadata (premium)Premium
Sourcing
GET/api/platform/sourcingPlatform sourcing capability listFree
Platforms
GET/api/sourcing/platformsBound / bindable sourcing platformsFree
GEO Growth
POST/api/geo/audit8-dimension GEO audit (evidence per item + fix order)Free
POST/api/geo/snapshotVisibility snapshot (title / description / heading structure / indexability)Free
POST/api/geo/crawlerAI crawler reachability (one real request per each of 9 UAs)Free
POST/api/geo/schemaJSON-LD structured data extractionFree
POST/api/geo/llmsllms.txt validation (existence / structure / pointers)Free
POST/api/geo/fixGenerate fixes (schema / llms.txt / robots / FAQ)Standard
Ledger
GET/api/ledger/scoreboardForecast hit-rate board (by category; scored records only)Free
GET/api/ledger/predictionsList forecast recordsFree
Moat
POST/api/v1/cbamCBAM carbon cost estimate (with basis; not a compliance filing)Free
POST/api/v1/marginTrue net margin (after commission / shipping / returns)Free
POST/api/moat/matrixCountry x HS6 x channel compliance requirement matrix (versioned; admin only)Standard
POST/api/v1/missingMissing-document list (against the compliance matrix)Free
POST/api/v1/originReverse-derive the best origin pathFree
POST/api/v1/contentContent structure compliance check (7 signals)Free
POST/api/v1/gateLLM hallucination gate (numeric cross-check)Free
POST/api/v1/relevanceRelevance gate (off-topic detection)Free
POST/api/v1/localizeLocalization quality gate (terminology / language mixing)Free
POST/api/v1/forecastRolling backtest on a demand series (MAPE)Free
POST/api/v1/schedulerMulti-channel collection health and circuit breakingFree
POST/api/v1/matchCross-source entity resolution (merge into one product)Free
POST/api/v1/resolveMulti-source field conflict arbitrationFree
POST/api/v1/intentBuyer question intent classificationFree
GET/api/v1/statsAsset layer overview (status of 12 append-only tables)Standard
GET/api/v1/coverageFact-source coverage (honest accounting)Standard
GET/api/v1/agentsTraffic attribution (by UA class)Standard
GET/api/v1/verifyDeliverable fingerprint verificationStandard
POST/api/moat/fact_putWrite a fact (versioned; standard tier)Standard
POST/api/moat/emitEmit an outbound event (idempotent + backoff retry)Standard
GET/api/moat/moat_index32-item moat matrix (A/B/C grading + peer public facts + live probes)Free
POST/api/predictPrediction-model engine: variable selection (stepwise / regularised / PCA), then modelling (logistic / Cox), then evaluation (AUC and C-index, calibration, decision-curve analysis, NRI/IDI, external validation, competing risks) and missing-value handling. Sixteen methods share one definition set; all of it runs server-side and only the result plus its source chapter comes back.Standard
GET/api/skill/list能力中心技能清单:按板块分组返回技能名与一句话说明;只给目录与介绍,不返回正文、不返回脚本Free
GET/api/skill/get单个技能详情:对外说明 + 章节目录 + 开头预览;整本正文不返回,响应体有上限Free
POST/api/skill/ask技能内检索:回命中片段与来源章节,单段限量,用于答疑不用于搬运原文Free
POST/api/skill/run技能动作执行:预测 / 洞察 / 决策等内核服务端真算,只回结果与耗时;发布类动作默认演练不对外发Standard
Market
GET/api/market/catalog105 platforms that can be fetched live (88 sales + 17 overseas sourcing), grouped, each flagged with whether a live path existsFree
GET/api/market/liveFetch real live prices across platforms for a keyword (concurrent; platforms that fail are explicitly marked with a reason, never estimated). Metered: free 3/day, standard 40/day, flagship unlimited; cache hits are not chargedFree

Plans & quotas

Min planDaily quota
Free50
Standard500
Premium5000
Flagship5000

Error codes

Endpoints evolve per release; changes sync to this page and the OpenAPI JSON.