Browse API docsGet credit balance
External API docs

Get credit balance

Read the remaining credit balance and the current billing period for your team.

Overview

Use this endpoint to monitor how many credits your team has left and when the current billing period ends. Credits are shared across all enrichment endpoints (search, find-people, lookup-people, lookup-business-email).

The response uses the same three fields for every plan. The dates show the period used for your team's current credit balance.

Before you start

Make sure you have:

  • an Openmart account
  • an API key
  • a tool to send API requests, such as Postman or curl

Authentication. We recommend sending your API key as Authorization: Bearer <your_api_key>. If your current integration already uses X-API-Key: <your_api_key>, it will continue to work.

Missing or unknown keys return HTTP 401 with {"detail":"Invalid API Key"}.

1

Example: Read your credit balance

Endpoint
GET https://api.openmart.ai/api/v2/credit-balance

cURL request

cURL
curl --request GET \
  --url https://api.openmart.ai/api/v2/credit-balance \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_api_key>'

Response example

JSON
{
  "period_start": "2025-08-05T20:22:47Z",
  "period_end": "2026-08-05T20:22:47Z",
  "balance": 998931751
}

Key elements of the API response

Response element
period_start
Type
string (RFC3339 UTC)
Description
Start of the current credit or subscription period, in UTC.
Response element
period_end
Type
string (RFC3339 UTC)
Description
End of the current credit or subscription period, in UTC.
Response element
balance
Type
integer
Description
Remaining credits available to the authenticated team.

Request parameters

This endpoint takes no request body and no query parameters. The API key in your header determines which team's balance is returned.

If this request fails

Match the error number or message in the response, then use the action below.

Error 400 / 422“... is required” or another field error
Read the error or detail field, then fix the named input.
Error 401“Invalid API Key”
Check the complete key and authentication header.
Error 402“Credit limit reached”
Check the team balance before trying again.
Error 403“Forbidden” or “not allowed”
Check whether this key and account can use the action.
Error 404“Not Found”
Check the API address, version, and GET, POST, or DELETE method.
Error 429“Too many requests”
Wait, then retry with fewer requests running at once.
Error 500–504Server error or timeout
Wait briefly and retry. Avoid duplicating an async job.

See Troubleshooting & FAQ for step-by-step help and the information to include when asking for support.