meta

Check your credit balance

Returns the current credit balance and the number of deduction transactions in the trailing 24 hours. Metadata call - costs 0 credits and never hits upstream platforms.

get/credits/balance

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/credits/balance
  • Auth: API key in header x-api-key

Response

Successful response

successboolean required
platformstring required
endpointstring required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required

Example response

{
  "success": true,
  "platform": "meta",
  "endpoint": "/v1/credits/balance",
  "data": {
    "balance": 4999,
    "recent_deductions": 12
  },
  "credits_remaining": 4999
}

Changes

No recorded changes to this operation across all 1 revision of this API.