data_* tools use; the guide is Data. The social data routes are its social domain under their own names.
The data tool object
What it returns. On describe, the long form.
What it is about:
social, search, people, companies, compliance, funding, seo, finance, crypto, news, legal, weather, jobs, real_estate, reviews, trade, shopping, travel. See Domains.For a
social tool, the networks it reads (empty for every other domain): x, instagram, tiktok, facebook, reddit, youtube, snapchat, linkedin, threads, telegram, douyin, kuaishou, xiaohongshu, weibo, bilibili, zhihu, wechat, lemon8, pipixia, toutiao, xigua.What a run costs you:
basis (per_call, per_result or varies), micro_usd (integer; for varies, the highest case) and text ("10 credits per call").Search tools
GET /v1/data/tools → 200 OK — scope agents:read. Free.
What you need, as a short noun phrase (1–200 characters):
company funding rounds, homes for sale.{ data: data_tool[] }, best match first. There is no cursor: the ranking is the page.
Describe a tool
GET /v1/data/tools/{id} → 200 OK — scope agents:read. Free.
Answers the tool plus:
A JSON Schema per input location —
path, query, body — each present only when the tool takes it. A run sends parameters in the same three places.id that is not a data tool is 404 not_found.
Run a tool
POST /v1/data/runs → 200 OK — scope sessions:write. Priced. Idempotency-Key optional: a retry under the same key replays the first answer and is billed once.
The request returns when the run ends — usually seconds, at most about two minutes.
Why it failed, in words that say what to change — often the parameter the source refused.
What this run debited, on the
search tier. Normally 0 for a failed run, and then no ledger entry is written; a stopped per-result run debits what it gathered.Response
Errors
Pricing
Search and describe are free. Each run is capped at 25 results: any result-count field above 25, at any depth of the input (limit, maxItems, maxResults, resultsPerPage, pageSize, num…, max…, …Count), is lowered to 25, and the balance must cover the listed price for one call (or for 30 results on a per-result tool, since some sources bill results in blocks of 10). It is then booked at the tool’s price, once on the search component; a failed or stopped run is normally free, but one the source billed (a timeout or stop that had already gathered results) costs what it gathered. See Pricing.