Available Credits (Pre-paid)

Accounts on the pre-paid model work with a credit balance loaded upfront. GET /credits/balance returns how much of that balance is still available, so you can check it before firing new queries.

🤖 Endpoint: GET https://users.production.judit.io/credits/balance. The response is synchronous (HTTP 200) and carries the remaining credit balance of the account authenticated by the api-key.

This route serves the pre-paid model. If your account runs on a cycle cap (post-paid), the number you are looking for is remaining in Cycle Consumption.

When to use it

Check before consuming

Confirm there is balance before queueing a batch of queries, avoiding failures mid-processing.

Top-up alert

Notify your team when the balance drops below your integration’s operational floor.

Check the Balance (GET)

GET https://users.production.judit.io/credits/balance

Authentication

Required api-key header, with the key of the account whose balance will be checked. The route takes no parameters — the balance returned is always the one of the authenticated account.

Request Examples

curl --request GET \
  --url 'https://users.production.judit.io/credits/balance' \
  --header 'api-key: '"$JUDIT_API_KEY"

const response = await fetch('https://users.production.judit.io/credits/balance', {
  method: 'GET',
  headers: { 'api-key': process.env.JUDIT_API_KEY }
});

const data = await response.json();
console.log(data);

import os
import requests

response = requests.get(
    "https://users.production.judit.io/credits/balance",
    headers={"api-key": os.environ["JUDIT_API_KEY"]},
)

print(response.json())

Getting Started

Core Concepts

Data Models (Schemas)

Asynchronous Requests

Synchronous Requests

Tracking

Registration Data

Criminal Records

File Transfer

Credentials Vault

Webhook

Resources

When to use it

Check before consuming

Top-up alert

Check the Balance (GET)

Authentication

Request Examples

Next Steps

Cycle Consumption

Consumption History

​When to use it

Check before consuming

Top-up alert

​Check the Balance (GET)

​Authentication

​Request Examples

​Next Steps

Cycle Consumption

Consumption History

When to use it

Check the Balance (GET)

Authentication

Request Examples

Next Steps