> For the complete documentation index, see [llms.txt](https://docs.geeknums.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geeknums.io/balance-query-api-check-account-balance.md).

# Balance Query API: Check Account Balance

Query your current account balance. Returns the total available credit balance associated with your API key.

**Code example:**

```bash
curl --location 'https://api.checknumber.ai/v1/balance' \--header 'X-API-Key: API-KEY'
```

**Response example for successful request**

```json
{    "balance": 9850.50}
```

**Response example for unauthorized request**

```json
{    "error": "unauthorized",    "message": "Access key is required (X-API-Key or X-Access-Key)"}
```

## HTTP request

`GET https://api.checknumber.ai/v1/balance`

## Request Headers

| Header      | Description                                                        |
| ----------- | ------------------------------------------------------------------ |
| `X-API-Key` | `string`, Your API key (required). Also accepted as `X-Access-Key` |

## Response Fields

| Field     | Description                                       | Example |
| --------- | ------------------------------------------------- | ------- |
| `balance` | Total available balance for the API key (credits) | 9850.50 |

## Status Codes

| Status | Description                                  |
| ------ | -------------------------------------------- |
| `200`  | Request successful, balance returned         |
| `401`  | Unauthorized, API key is missing or invalid  |
| `502`  | Balance query failed, upstream service error |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.geeknums.io/balance-query-api-check-account-balance.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.