Utility Explain Error API
Scrape Utility Explain Error data with one API call. Paste a failed response (its status and body) and get back the fault in plain words, the steps that fix it, a corrected request when the error's own details allow one, whether retrying the same request can succeed, and the docs link. Covers bad or misnamed parameters (including a value sent as a parameter name), missing parameters, invalid values, wrong paths, auth, credits, key limits, rate limits, upstream failures and not-found. Pass the body as JSON or base64url JSON (up to 8,000 characters) and, optionally, the request you sent as request (API keys in it are dropped). The answer is computed from the error type and details the API returned; nothing is fetched. Free to call.
Last updated October 2026Maintained by the SocialCrawl team
Returns the fault in plain words, the steps that fix it, a corrected request when the error's details allow one, whether retrying can succeed, and the docs link.
Use it when a call failed and you have the status and body, instead of guessing at the fix. It fetches nothing. Free to call.
Searching 68 platforms in parallel
What can you do with the Explain Error API?
The Explain Error endpoint gives you structured Utility data with computed fields in a single request. No scraping infrastructure to build or maintain.
Example Request
curl -H "x-api-key: YOUR_API_KEY" \
"https://www.socialcrawl.dev/v1/utility/explain-error?status=400&body=%7B%22success%22%3Afalse%2C%22error%22%3A%7B%22type%22%3A%22INVALID_REQUEST%22%2C%22message%22%3A%22Unknown+query+parameter+%27handel%27.+Did+you+mean+%27handle%27%3F%22%2C%22status%22%3A400%2C%22details%22%3A%7B%22unknown_parameters%22%3A%5B%22handel%22%5D%2C%22suggestions%22%3A%7B%22handel%22%3A%22handle%22%7D%7D%7D%7D&request=%2Fv1%2Ftiktok%2Fprofile%3Fhandel%3Dnasa"import requests
response = requests.get(
"https://www.socialcrawl.dev/v1/utility/explain-error",
params={
'status': '400',
'body': '{"success":false,"error":{"type":"INVALID_REQUEST","message":"Unknown query parameter \'handel\'. Did you mean \'handle\'?","status":400,"details":{"unknown_parameters":["handel"],"suggestions":{"handel":"handle"}}}}',
'request': '/v1/tiktok/profile?handel=nasa',
},
headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()const response = await fetch(
"https://www.socialcrawl.dev/v1/utility/explain-error?status=400&body=%7B%22success%22%3Afalse%2C%22error%22%3A%7B%22type%22%3A%22INVALID_REQUEST%22%2C%22message%22%3A%22Unknown+query+parameter+%27handel%27.+Did+you+mean+%27handle%27%3F%22%2C%22status%22%3A400%2C%22details%22%3A%7B%22unknown_parameters%22%3A%5B%22handel%22%5D%2C%22suggestions%22%3A%7B%22handel%22%3A%22handle%22%7D%7D%7D%7D&request=%2Fv1%2Ftiktok%2Fprofile%3Fhandel%3Dnasa",
{
headers: { "x-api-key": "YOUR_API_KEY" },
},
);
const data = await response.json();Parameters
| Parameter | Required | Description |
|---|---|---|
| status | No | The HTTP status of the failed response. Optional when the body carries error.status |
| body | No | The pasted response body: the JSON error envelope (URL-encoded or base64url) or plain text. Up to 8,000 characters. Provide this or status |
| request | No | The request that failed, as a URL or /v1 path with its query string. Lets the answer return a corrected request. Credentials in it are dropped |
What does the Utility Explain Error API return?
This synthetic fixture shows the documented response shape and fields. Values are illustrative; this is not a live API response.
Example response
{
"success": true,
"platform": "utility",
"endpoint": "/v1/utility/explain-error",
"data": {
"kind": "error_explanation",
"version": 1,
"status": 400,
"fault": "unknown_param",
"error_type": "INVALID_REQUEST",
"explanation": "The request sent `handel` that this endpoint does not accept. An unknown parameter is rejected before billing, so nothing was charged.",
"fix_steps": [
"Rename `handel` to `handle`.",
"`GET /v1/utility/endpoint?id=tiktok/profile` lists the parameters this endpoint takes."
],
"corrected_request": {
"method": "GET",
"path": "/v1/tiktok/profile",
"query": {
"handle": "nasa"
},
"url": "https://www.socialcrawl.dev/v1/tiktok/profile?handle=nasa",
"changes": [
{
"op": "rename_param",
"from": "handel",
"to": "handle"
}
]
},
"retry": false,
"doc_url": "https://www.socialcrawl.dev/docs/errors#invalid-request"
},
"credits_used": 0,
"request_id": "req_example000000",
"cached": false
}Synthetic fixture for the documented response shape. Values are illustrative, not a production capture.
How does the Utility Explain Error API work?
Send a GET request with your API key and get back clean, structured JSON in our unified schema. Supported computed fields are populated when the source provides the required inputs.
Method
GET
Response
JSON
How do you scrape social media data in seconds?
The fastest social media scraping API for developers. Scrape profiles, posts, comments, and analytics from 68 platforms covering 10B+ monthly active users.
One schema, every platform
Query 68 platforms with identical response structures. Write your integration once.
Computed fields, not just scraped
When an endpoint supports these metrics and the source provides the required inputs, the normalized record includes engagement_rate, estimated_reach, content_category, and language. Ready to use.
See your data before you code
Visual Data Explorer. Paste any URL, get rich result cards, sortable tables, CSV export.
import requests
response = requests.get(
'https://www.socialcrawl.dev/v1/tiktok/profile',
params={'handle': 'charlidamelio'},
headers={'x-api-key': 'sc_YOUR_API_KEY'}
)
data = response.json(){
"success": true,
"platform": "tiktok",
"data": {
"author": {
"username": "charlidamelio",
"followers": 152400000
},
"engagement": {
"likes": 12400000000,
"engagement_rate": 0.087
},
"metadata": {
"language": "en",
"content_category": "lifestyle"
}
}
}Ready to scrape Utility Explain Error data?
Get your API key and start pulling Utility data in under 60 seconds.
