Directory
List and filter a catalog
/data-api/v2/directory/{platform}- Scope
- directory:read
- Freshness
- catalog read
- Group
- Directory
- Platforms
- 7 of 7
What this endpoint answers
The main catalog read: cursor-paginated, filterable and sortable. Pagination is always keyset (never OFFSET), so a full-corpus walk stays the same cost on page 1 and page 100,000 - follow meta.page.next_cursor until it is null.
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 directory:read scope (Directory): Read the account and channel catalog across all seven platforms.
Good to know
- Unknown query parameters are rejected with 422 rather than ignored, so a typo in a filter never silently returns the unfiltered catalog.
- meta.source tells you how the page was produced: `catalog` is a direct index-served read; `catalog:audience_window(20000)` and `catalog:fulltext_window(20000)` mean the result was drawn from a bounded candidate window (see below).
- Candidate windows: a sort on a column with no index, a substring search, a derived-metric filter (min_follower_ratio, min_posts_per_day) or a full-text query is resolved inside the top 20,000 rows by audience (or the first 20,000 full-text matches). Ranking inside that window is exact; a term matching more rows than the window is ranked from the window, not from the whole catalog. This cap is why these queries answer in ~100ms instead of timing out - an unbounded full-text sort measured 33.5s on this catalog.
- sort=growth is deliberately not offered: weekly growth is a per-row snapshot lookup, so ordering the catalog by it means computing it for every row. Use /directory/{platform}/{id}/growth for a single account's history.
- Ranked sorts exclude rows whose sort value is NULL, since a NULL cannot be positioned in a keyset.
- Telegram's addressable scope is public channels only (type = 'channel'); groups are in the corpus but not in the ranked listing, because the ordered index is built over channels.
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 | path | required | x | Which catalog to read. |
limit | query | optional | 100 | Rows per page, 1 to 500. |
cursor | query | optional | - | Opaque keyset position from meta.page.next_cursor. Signed; a hand-written cursor is rejected. |
sort | query | optional | citations | Sort key. `id` walks the primary key and is the cheapest full-corpus order; the platform's audience metric (followers / subscribers) is the default and is inde… |
order | query | optional | desc | Sort direction. |
q | query | optional | crypto trading | Full-text search over name and bio, served by the catalog's GIN index. Available on X, Instagram, TikTok, YouTube and Telegram; Bluesky has no such index and r… |
search | query | optional | musk | Substring match on handle and display name. Unindexed by construction, so it is applied inside the audience-ordered candidate window rather than to the whole c… |
fields | query | optional | username,name,followers_count,country | Comma-separated projection. Any field listed by GET /directory for that platform, plus weekly_growth. Omitting weekly_growth skips a per-row snapshot lookup. |
scope | query | optional | addressable | `addressable` (default) is the active, non-NSFW, handled catalog - the rows a public page can link to, and the only scope the ranked indexes cover. `all` is th… |
min_followers | query | optional | 10000 | Audience floor. Every platform has a min/max pair on its own metric: min_followers (X, Bluesky, TikTok), min_participants (Telegram), min_subscribers (YouTube). |
country | query | optional | TR | ISO 3166-1 alpha-2, as inferred by the engine's geo classifier. Not available on TikTok. |
language | query | optional | en | ISO 639-1, as inferred by the engine's language classifier. |
category | query | optional | technology | Topic category slug. |
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/directory/x" \
-H "Authorization: Bearer psk_live_..."
const res = await fetch("https://crmsolid.com/data-api/v2/directory/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/directory/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.
- Data
- 1 items
- Meta request id
- req_9f2c1a7b4e5d8c30
- Meta generated at
- 8/23/2026, 9:14:22 AM
- Meta took ms
- 121
- Meta page limit
- 50
- Meta page next cursor
- eyJzIjoiZm9sbG93ZXJzIiwibyI6ImRlc2MifQ.Yk9Qb1RrN0hs
- Meta page count
- 50
- Meta source
- catalog
{
"data": {
"data": [
{
"user_id": "44196397",
"username": "elonmusk",
"name": "Elon Musk",
"description": "",
"followers_count": 221384902,
"following_count": 1102,
"statuses_count": 79431,
"media_count": 4612,
"favourites_count": 152889,
"url": null,
"is_verified": false,
"is_blue_verified": true,
"verified_type": null,
"is_automated": false,
"location": "",
"photo_url": "https://pbs.twimg.com/profile_images/1936002956/elon_400x400.jpg",
"banner_url": "https://pbs.twimg.com/profile_banners/44196397/1739948056/1500x500",
"account_created_at": "2009-06-02T20:12:29+00:00",
"language": "en",
"country": "US",
"category": "technology",
"citation_score": 41882,
"tier": "S",
"status": "active",
"is_nsfw": false,
"last_seen": "2026-08-22T22:14:07+00:00",
"weekly_growth": 412004
}
],
"meta": {
"request_id": "req_9f2c1a7b4e5d8c30",
"generated_at": "2026-08-23T09:14:22.318Z",
"took_ms": 121,
"page": {
"limit": 50,
"next_cursor": "eyJzIjoiZm9sbG93ZXJzIiwibyI6ImRlc2MifQ.Yk9Qb1RrN0hs",
"count": 50
},
"source": "catalog"
}
},
"meta": {
"request_id": "req_9f2c41a8b3d5",
"generated_at": "2026-08-23T09:14:02.317Z",
"took_ms": 42,
"page": {
"limit": 50,
"next_cursor": "eyJrIjoiMTczNDU2IiwiZCI6ImEifQ",
"count": 50
}
}
}
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.
meta.page
limitintegerrequiredRows requested. Default 50, maximum 500.
next_cursorstringrequiredPass as ?cursor= to fetch the next page. null means the result set is exhausted, and it is the only reliable stop condition.
countintegerrequiredRows in this page.
totalintegeroptionalTotal matching rows. Present only when counting is cheap; never assume it is there.
List endpoints take ?limit= (max 500) and ?cursor=. Follow meta.page.next_cursor until it is null; cursors are opaque and signed.
When it fails
GET /directory/{platform} documents 8 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.
- 404NotFound
not_foundThe addressed resource does not exist.
- 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, Instagram, TikTok, YouTube, Telegram, Bluesky, LinkedIn. 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/directory-list