Account

GET /v1/account/balance

Credit Balance API

Check how many Captapi credits remain on your API key.

0 credits per request

Try in Playground Get your API key — free Read the docs

TL;DR

Check how many Captapi credits remain on your API key. The Credit Balance API (Account) is a single authenticated GET request to /v1/account/balance that responds with clean JSON and costs 0 credits. Pass cache=true for a free 24h cache hit; default is always fresh. Start with 100 free credits — no credit card.

What is the Credit Balance API?

Call the Credit Balance API with your Captapi key and get the remaining credit balance as JSON. Free — does not consume credits.

What you get

Live data for your Captapi API key
No credit charge for account endpoints
Clean JSON ready for dashboards and alerts
Useful for monitoring usage and spend

Try it

Open in Playground

Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).

Parameters

API keyoptionalPaste your key to get a ready-to-run snippet. It stays in your browser.Sign in to run live

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

Edit the parameters and the code updates instantly. Switch languages and hit copy.

Example response

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

Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.

Response structure

A successful call returns success, cached, creditsUsed, and a data object with the following fields:

Top-level fields

planPlan. Example: "free".
monthly_quotaMonthly quota. Example: 100.
subscription_creditsSubscription credits. Example: 0.
topup_creditsTopup credits. Example: 9599.
total_creditsTotal credits. Example: 9599.
subscription_renews_atSubscription renews at.

Parameters

Name	Type	Required	Description

Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 0 credits. Pass cache=true for a free 24h cache hit; default is always fresh.

Using an AI agent? This endpoint is the MCP tool account_balance via @captapi/mcp. Set it up →

How it works

1. Sign up — get 100 free credits, no card required.
2. Create a key from your dashboard.
3. Send one request to /v1/account/balance and parse the JSON response.

Use cases

Analytics

Track views, likes, and engagement over time.

Competitor Monitoring

Benchmark the performance of other creators.

Dashboards

Power reporting and BI with real metadata.

Content Curation

Filter and rank videos by performance.

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.

More Account APIs

Request History API Daily Usage API Most Used Routes API

Ready to use the Credit Balance API?

Get started free