Tools
SensitiveSearch the Telegram, TikTok and X catalog
/data-api/v2/tools/audience-finder- Scope
- tools:use
- Freshness
- catalog read
- Group
- Tools
- Platforms
- 3 of 7
What this endpoint answers
Discovery search over our own directory: filter by audience size, language, category and free text, plus X-only quality filters for account age, follower ratio and posting activity. Reads the catalog we already crawl, so it costs nothing upstream.
This is a catalog read: it is served from the CRM Solid database in milliseconds, costs one budget unit, and reports how old the reading is in meta.cache_age_s. It needs the tools:use scope (Tools): Run the analysis tools: valuation, follower audit, scoring, and more.
Good to know
- Free: served from our own catalog and cached for 30 minutes. Metered as a normal call, not a live one.
- Bios are contact-stripped before they leave the catalog: email addresses and phone numbers are replaced with placeholders. This is a discovery surface, not a contact database.
- No total count is returned. An exact count over the X catalog does not finish inside the query timeout, and an estimate that disagrees with the visible rows reads as a bug. Page with has_more.
- Depth is capped at 20 pages (1000 rows) per filter combination. Narrow the filters to reach further.
- YouTube and Bluesky are deliberately absent: YouTube data cannot be redistributed under the API terms, and the Bluesky catalog is too stale to be useful here.
- A failed catalog query returns 502 upstream_error rather than an empty page, so a database problem is never mistaken for no matches.
Parameters
Every value the call accepts, with the example the spec ships so the request runs as written.
| Name | In | Required | Example | What it does |
|---|---|---|---|---|
platform | query | required | x | Which catalog to search. |
q | query | optional | solidity | Full-text search over name and bio. Capped at 80 characters. |
min_audience | query | optional | 10000 | Minimum followers (X, TikTok) or members (Telegram). |
max_audience | query | optional | 500000 | Maximum followers or members. |
language | query | optional | en | ISO language code as classified by our engine, e.g. en, tr, es. |
category | query | optional | crypto | Category slug as classified by our engine, e.g. ai, crypto, news. |
sort | query | optional | followers | Ordering. X supports followers only. Telegram supports subscribers, reach, posts. TikTok supports followers, likes, videos. |
page | query | optional | 2 | 1-based page. 50 rows per page, 20 pages maximum. |
age | query | optional | pre2016 | X only. Account creation window. |
ratio | query | optional | r10 | X only. Minimum follower-to-following ratio. |
activity | query | optional | normal | X only. Posts per day band. |
Call it
Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.
curl "https://crmsolid.com/data-api/v2/tools/audience-finder?platform=x" \
-H "Authorization: Bearer psk_live_..."
const res = await fetch("https://crmsolid.com/data-api/v2/tools/audience-finder?platform=x", {
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
},
});
if (!res.ok) {
const { error } = await res.json();
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const { data, meta } = await res.json();
import os
import requests
res = requests.get(
"https://crmsolid.com/data-api/v2/tools/audience-finder?platform=x",
headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
timeout=30,
)
res.raise_for_status()
payload = res.json()
data, meta = payload["data"], payload["meta"]
Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.
What comes back
Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.
- Platform
- x
- Rows
- 1 items
- Page
- 1
- Has more
- yes
{
"data": {
"platform": "x",
"rows": [
{
"id": "44196397",
"handle": "cz_binance",
"name": "CZ",
"bio": "Ex-Binance. Building. [email hidden]",
"audience": 9124800,
"language": "en",
"category": "crypto",
"verified": true,
"avatar_url": "https://pbs.twimg.com/profile_images/1739231242/cz.jpg",
"profile_url": "https://x.com/cz_binance",
"weekly_growth": 18402,
"tier": "S",
"last_seen": "2026-08-22T04:10:33.000Z",
"avg_views": null,
"posts_per_day": null,
"total_likes": null,
"video_count": null,
"bio_link": null,
"post_count": 41208,
"account_created_at": "2009-06-02T20:12:29.000Z",
"location": "Dubai"
}
],
"page": 1,
"has_more": true
},
"meta": {
"request_id": "req_9f2c41a8b3d5",
"generated_at": "2026-08-23T09:14:02.317Z",
"took_ms": 42
}
}
The meta block
request_idstringrequiredUnique id for this request. Quote it in a support ticket.
generated_atstringrequiredServer time the response was produced.
took_msintegerrequiredMilliseconds spent server-side.
pagePageoptionalsourcestringoptionalWhich backend served the payload, for endpoints with more than one.
cache_age_sintegeroptionalAge of the underlying data in seconds. 0 for live reads.
When it fails
GET /tools/audience-finder documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.
- 401Unauthorized
unauthorized | invalid_keyNo key was presented, or the key is unknown, revoked or expired.
- 402PaymentRequired
payment_required | subscription_inactiveThe key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.
Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.
- 403Forbidden
forbidden_scope | forbidden_ipThe key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.
- 422InvalidRequest
invalid_requestA parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
- 429RateLimited
rate_limited | quota_exceededEither the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.
Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.
- 500InternalError
internal_errorSomething failed on our side. Internals are never leaked; quote the request id.
- 503Unavailable
upstream_timeout | upstream_error | not_configuredThe request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.
Every response carries X-Request-Id and meta.request_id. Quote it in support requests.
Coverage and limits
This endpoint covers X, TikTok, Telegram. Rate limits come from the tier on your key.
| Tier | Requests a minute | Requests a day | Live reads a minute |
|---|---|---|---|
| free | 30 | 1,000 | 5 |
| standard | 120 | 25,000 | 20 |
| pro | 600 | 250,000 | 60 |
| unlimited | 6,000 | 10,000,000 | 600 |
This call only draws on the ordinary per-minute and per-day columns. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.
Start calling it
A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.
Reference path: /data-api/reference/tools-audience-finder