Credit balance

GET/v1/account/credit-balance0 credits

Returns how many credits your API key's account has left.

01Query parameters

This endpoint takes no parameters.

02Request

curl "https://api.scrapesocial.ai/v1/account/credit-balance" \
  -H "x-api-key: $SCRAPESOCIAL_KEY"

03Responses

Real answers from the API. Lists are shortened to 2 items.

GET /v1/account/credit-balance

{
  "success": true,
  "creditCount": 6828,
  "message": "You have 6828 credits remaining."
}

Common to every endpoint

Any route can answer these: a missing or wrong key, no credits left, the platform not answering, or a failure on our side. None of them costs credits.

GET /v1/cosmos/profile?handle=design

{
  "success": false,
  "message": "Invalid API key"
}

04Notes

Free. The answer is `{"success":true,"creditCount":N,"message":"You have N credits remaining."}`.

05Errors & credits

Every error has success: false, a real HTTP status and costs no credits.

400missing_parameter
A required parameter is missing or invalid.
403private_account
The account is private or age-restricted.
404not_found
No such account.
503upstream_error
The platform did not answer; retry shortly.