Fetch the SocialCrawl endpoint catalog, per-route usage guides, quickstart rules, and agent reference text as structured JSON with one API key. Every utility route costs 0 credits.
4 active endpoints. Free catalog and agent context.
Four free meta routes for the SocialCrawl API itself. List the catalog, load one endpoint guide, pull first-call rules, or fetch LLM-oriented reference text. Developer experience only. No social scrape payloads.
/v1/utility/endpointsMachine-readable list of every active endpoint: path, method, platform, credit cost, required and optional parameters, and a link to its usage guide. Filter by platform, search substring, or method.
platform, search, method
/v1/utility/endpointFull usage guide for one endpoint: parameter types and examples, credit cost, caching, pagination notes, and a sample call. Identify the route by id or path.
id or url, method
/v1/utility/quickstartEverything needed for a first call in one response: authentication, base URL, response shape, credit billing, error codes, rate limits, and a sample.
platform
/v1/utility/llmsSocialCrawl reference text for AI agents, for the whole API or a single platform, as markdown or as a structured object. Built for agent context, not browser docs.
platform, format
Returns a catalogue of every endpoint you can call: path, method, platform, credit cost, required and optional parameters, and a link to its usage guide.
Use it to discover what is available or filter by platform. For one endpoint's full instructions, call the endpoint guide. Free to call.
0 credits
$ curl https://www.socialcrawl.dev/v1/utility/endpoints?platform=tiktok \
-H "x-api-key: sc_YOUR_API_KEY"// Running this live needs your own API key. Hit "Try it" to see an example responseUtility is the free developer meta surface of SocialCrawl. You call GET /v1/utility/… with an API key and get a single JSON envelope back. No credits are spent on these routes.
Send your key in the x-api-key header. The same key works for catalog discovery and for paid social or analytics routes afterward.
All utility routes are GET. Filter the catalog with platform, search, or method. Point endpoint at an id or path. Scope llms to a platform when needed.
Every utility route costs 0 credits. Paid platform reads still use their own tiers. Cache and rate limits still apply to the key.
Every response is the same shape: success, data, credits_used, credits_remaining, request_id, cached. On utility calls credits_used is 0.
Most agents and SDKs start with free context, resolve the route they need, then spend credits only on the live platform call.
GET /v1/utility/quickstart?platform=redditAuth rules, base URL, envelope shape, billing, errors, rate limits
Bootstrap a client or agent without reading the whole docs site.
GET /v1/utility/endpoints?platform=redditFiltered endpoint list with costs and required params
Discover what is live before you hardcode paths.
GET /v1/utility/endpoint?id=reddit/subredditOne endpoint's parameters, examples, paging, and sample call
Call correctly the first time without guessing field names.
GET /v1/utility/llms?platform=reddit&format=markdownThe real platform response on /v1/{platform}/…
Spend credits only after the free meta path selected the right endpoint.
GET /v1/utility/endpoints
?platform=reddit
&search=comment
Host: www.socialcrawl.dev
x-api-key: sc_your_api_key_here
# agent context
GET /v1/utility/llms?platform=reddit&format=markdown{
"success": true,
"data": {
"endpoints": [
{
"id": "reddit/subreddit",
"method": "GET",
"path": "/v1/reddit/subreddit",
"credit_tier": "standard"
}
]
},
"credits_used": 0,
"credits_remaining": 9999,
"request_id": "req_…",
"cached": false
}Utility payloads are catalog and guide objects under the shared SocialCrawl envelope. They describe the API rather than social Post leaves.
success, data, credits_used (0), credits_remaining, request_id, cached
stats, filters, total, endpoints[] with path, method, platform, credits, required_params, optional_params, how_to_use
parameter types and examples, credit cost, caching, pagination, sample call for one endpoint
quickstart rules or llms reference as markdown or structured object, whole API or one platform
Same request lifecycle as every other /v1 platform endpoint. Utility is not a separate product surface.
Next.js catch-all routes into the Hono social API. We mint a request_id, authenticate the key, then enforce rate limit and concurrency per key.
Registry lookup finds utility routes. Params are validated. Invalid input returns 400. Valid calls do not debit credits because cost is 0.
Catalog and guides are generated from the live endpoint registry so they do not drift from what is callable. Quickstart and llms return static or assembled reference text.
Payloads are wrapped in the success envelope with credits_used = 0 and logged like any other route for request audit.
Billing rules that matter in production
Utility reads SocialCrawl's own registry and reference text. It does not scrape third-party social platforms.
Developer experience and agent context for SocialCrawl itself: catalog discovery, endpoint guides, first-call rules, and LLM reference. Free to call.
Catalog and per-endpoint guides are built from the live registry at request time. Quickstart and llms return assembled reference content for humans and agents.
A unified JSON envelope: success, data, credits_used, request_id, cached. On these routes credits_used is always 0.
No social Post, Comment, or Author payloads. No write endpoints. No substitute for platform docs when you need marketing pages; this is the machine-readable API surface.
The jobs this API is most often used for.
Free catalog discovery and agent context
Callers concentrate on endpoints for discovery, endpoint for one-route detail, quickstart for client bootstrap, and llms when agents need API context in one shot. Four free meta routes that stay aligned with the live registry. Agents and SDKs can discover and call SocialCrawl without scraping the docs site.
Utility routes are internal registry and reference responses. They are typically faster than upstream social or analytics live misses.
Common ways teams put this data to work, and the stack each one tends to run.
Pull endpoints to generate clients and keep required params in sync with the registry without hand-editing path lists.
Load quickstart or llms for context, then endpoint for the chosen route before spending credits on a paid platform call.
Filter the catalog by platform at deploy time, cache guides, and fail fast when a resource is missing. Same key as paid reads.
Every utility route costs 0 credits. Start with quickstart or endpoints, then load endpoint for the path you will call next.
curl "https://www.socialcrawl.dev/v1/utility/endpoints?platform=reddit" \
-H "x-api-key: sc_your_api_key_here"curl "https://www.socialcrawl.dev/v1/utility/llms?platform=reddit&format=markdown" \
-H "x-api-key: sc_your_api_key_here"Same key as the rest of the catalog
Every endpoint returns structured JSON in a unified envelope. Computed fields such as engagement rate and content category are included only where the endpoint supports them and the required source inputs are present.
Same Utility data, two very different paths. Auth, rate limits, schema, and cost, side by side.
| Feature | SocialCrawl | Scraping docs + inventing paths |
|---|---|---|
| Discovery | One free GET lists every callable path, cost, and parameter | Crawl HTML docs or guess /v1/{platform}/{resource} paths |
| First call | /v1/utility/quickstart returns auth, envelope, billing, and a copy-paste curl | Read auth, errors, and pricing pages separately |
| Agent onboarding | /v1/utility/llms serves the llms.txt corpus as API JSON or markdown | Scrape documentation pages and risk drift |
| Accuracy | Generated from the live registry that routes and bills requests | Stale docs when endpoints ship or retire |
| Cost to browse | 0 credits for catalog, guide, quickstart, and agent context | Time and token cost of reading the wrong page |
Discovery
First call
Agent onboarding
Accuracy
Cost to browse
Find answers to frequently asked questions about SocialCrawl's API, pricing, and capabilities.
Contact usAsk AI about SocialCrawl