CaptapiCaptapi
Account · Guide

How to get Account credit balance

TL;DR
To get Account credit balance, sign up for a free Captapi key, then send one GET request to /v1/account/balance with your input. You get clean JSON back in seconds for 0 credits per call — no OAuth, scraping or platform SDKs. Check how many Captapi credits remain on your API key.
Get your free API keyAPI reference

How to get Account credit balance (step by step)

  1. 1

    Get a free API key

    Create a free Captapi account (100 credits, no card) and generate an API key from the dashboard.

  2. 2

    Call the Credit Balance API

    Send an authenticated GET request to /v1/account/balance with your input. No OAuth, no scraping setup.

  3. 3

    Read the JSON response

    Parse the clean JSON response. Pass cache=true for a free 24h cache hit; default is always fresh.

Code example

curl "https://api.captapi.com/v1/account/balance" \
  -H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."

What the response looks like

{
  "success": true,
  "data": {
    "plan": "free",
    "monthly_quota": 100,
    "subscription_credits": 0,
    "topup_credits": 9599,
    "total_credits": 9599,
    "subscription_renews_at": null
  }
}

Billing metadata (credits charged, cache hit/miss) is returned in the X-Captapi-Credits and X-Captapi-Cache response headers.

Frequently asked questions

What does the Credit Balance API do?

The Credit Balance API returns credit balance for your Captapi API key via one GET request to /v1/account/balance. It returns clean JSON and does not charge credits.

How many credits does the Credit Balance API cost?

Account endpoints are free — they do not consume credits.

Do I need a Account API key or OAuth?

You only need your Captapi API key (Authorization: Bearer). No third-party OAuth is required.

Is the Credit Balance API suitable for production use?

Yes. It is a stable REST endpoint with predictable JSON and automatic retries. Pass cache=true to serve from the 24h shared cache (0 credits on hit); default is always fresh. Use it for analytics, monitoring, and content automation.

Ready to get Account credit balance?

Start free with 100 credits — no credit card required.

Get your free API key