Get the workspace's spendable credits, split into monthly plan credits and purchased credits.

GEThttps://api.rankparse.com/v1/creditsFreeAPI key

Returns the credit balance of the key's workspace. It is the cheapest way to check before an expensive call. Subscribers also see how much of the total is the monthly plan quota, which expires, and how much is purchased credits, which never expire. See Two credit buckets.

Response

creditsinteger

Total you can spend now: plan_credits + purchased_credits.

plan_creditsinteger

Credits left from the current Pro or Agency plan grant. Spent first. 0 without a subscription or once the grant has expired.

purchased_creditsinteger

Credits from credit packs and the lifetime deal. They never expire.

plan_credits_expire_atinteger | null

When the plan credits expire, Unix milliseconds. null when there are no live plan credits.

Errors

HTTP	Code	When
401	`invalid_api_key`	Missing, invalid or revoked API key.
403	`capability_missing`	Client roles may not view credits.

MCP tool: check_credits (no arguments).

Buy credits

Top up with a credit pack.

Credits

Costs, refunds, spend caps and auto recharge.

curl "https://api.rankparse.com/v1/credits" \
  -H "X-API-Key: rp_your_key"

Response

{
  "credits": 3842,
  "plan_credits": 2100,
  "purchased_credits": 1742,
  "plan_credits_expire_at": 1764547200000
}

Get credit balance

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

Buy credits

Credits

Response

Errors

Related