ListCleanerDeveloper platform
GET/get_credits

Check the API credit balance

Return the available validation-credit balance for the authenticated ListCleaner account.

Account endpointJSON responseNo request body
Temporary tab credentials

Authenticate once for every guide

Your email and API key remain in this tab's session storage, work across all request pages, and disappear when the tab closes.

Credentials have not been entered.

Overview

What this request does

The credit-balance endpoint lets an integration check whether the authenticated account has capacity for validation work. It is useful in account dashboards, administrative tools and controlled preflight checks before a large upload or single-address workflow.

A balance response is a point-in-time value. Concurrent verification jobs can consume credits after the request completes, so do not treat the value as a reservation. Your integration should still handle the API's insufficient-credit response when submitting work.

Implementation workflow

How to use /get_credits

Authenticate the account

Send the same email and API key headers used by validation requests.

Call the balance endpoint

Send GET /get_credits without a body or query parameter.

Use the point-in-time value

Display or monitor the balance while still handling insufficient-credit responses on later jobs.

Request contract

Headers, parameters and fields

NameLocationRequiredDescription
X-User-EmailHeaderYesEmail address belonging to the ListCleaner API account.
X-Api-KeyHeaderYesSecret API key for the authenticated ListCleaner account.

Response behavior

  • HTTP 200 returns a JSON object containing credits.
  • HTTP 401 means the supplied account credentials were not accepted.
  • The value reflects the balance at response time and does not reserve credits.
Interactive API console

Execute this request

Edit the request values, then send a live authenticated request to ListCleaner. The HTTP status and duration appear in the response bar, with the actual API response body directly below. File endpoints provide a download link instead of printing binary data.

Your saved tab credentials are added to the request headers and never printed in the response panel.
This performs a real API operation and may use credits or change account data.
Ready-to-run examples

Code examples in 10 languages

After credentials are entered above, every example includes the actual account email and API key so the copied request can run immediately. Clear the credentials to return to placeholders.

GET /get_creditsContent type:
PHP
Integration guidance

Use cases and best practices

Common use cases

  • Show available credits in an account dashboard.
  • Warn an operator before starting a large list upload.
  • Monitor balance thresholds from an internal administration tool.

Recommended implementation practices

  • Do not poll the balance unnecessarily.
  • Do not use a balance check as a substitute for handling HTTP 402 on verification.
  • Keep credentials in a trusted backend for production.
  • Format the returned value according to the integer-credit model used by the product.
Focused FAQ

Check the API credit balance questions

Answers to common implementation, security and response-handling questions for this specific request.

Does checking the balance consume a credit?

The balance request reports account state and is not a validation operation.

Does the returned balance reserve credits?

No. It is a point-in-time value and can change as other requests complete.

What should I do when the balance is too low?

Direct the account owner to purchase or add credits, and handle the verification endpoint's insufficient-credit response.

Can I expose this endpoint in frontend code?

Use your own authenticated backend in production so the ListCleaner API key is not exposed to site visitors.