> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnixapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Account

> Check your credit balance, usage and payment history — free, with just your API key.

Two read‑only endpoints let you monitor your OmniX account programmatically. Both are
**free** (no credits deducted) and authenticate with **only your API key** — no X
account token required.

<Note>
  These are the only endpoints that don't need an `auth_token`. They're about *your
  OmniX account*, not an X account.
</Note>

## Account info

`GET /account/me` returns your account details, current credit balance, and a usage
summary.

<CodeGroup>
  ```bash curl theme={null}
  curl "https://api.omnixapi.com/api/v1/twitter/account/me" \
    -H "Authorization: Bearer omnix_live_xxx"
  ```

  ```javascript JavaScript theme={null}
  const res = await fetch(
    "https://api.omnixapi.com/api/v1/twitter/account/me",
    { headers: { Authorization: "Bearer omnix_live_xxx" } }
  );
  const { data } = await res.json();
  console.log(data.credits_remaining);
  ```

  ```python Python theme={null}
  import requests

  res = requests.get(
      "https://api.omnixapi.com/api/v1/twitter/account/me",
      headers={"Authorization": "Bearer omnix_live_xxx"},
  )
  print(res.json()["data"]["credits_remaining"])
  ```
</CodeGroup>

```json Response theme={null}
{
  "status": true,
  "data": {
    "email": "user@example.com",
    "name": "John Doe",
    "credits_remaining": 8.96,
    "credits_used": 13.832,
    "total_requests": 12251,
    "created_at": "2026-02-06T10:46:59.399Z"
  },
  "error": null
}
```

| Field               | Type   | Description                          |
| ------------------- | ------ | ------------------------------------ |
| `email`             | string | Account email                        |
| `name`              | string | Account name                         |
| `credits_remaining` | number | Current credit balance (\$)          |
| `credits_used`      | number | Total credits spent (\$)             |
| `total_requests`    | number | Total API calls made                 |
| `created_at`        | string | Account registration date (ISO 8601) |

## Payment history

`GET /account/payments` returns your top‑up history, newest first.

<CodeGroup>
  ```bash curl theme={null}
  curl "https://api.omnixapi.com/api/v1/twitter/account/payments" \
    -H "Authorization: Bearer omnix_live_xxx"
  ```

  ```javascript JavaScript theme={null}
  const res = await fetch(
    "https://api.omnixapi.com/api/v1/twitter/account/payments",
    { headers: { Authorization: "Bearer omnix_live_xxx" } }
  );
  const { data } = await res.json();
  console.log(data.payments);
  ```

  ```python Python theme={null}
  import requests

  res = requests.get(
      "https://api.omnixapi.com/api/v1/twitter/account/payments",
      headers={"Authorization": "Bearer omnix_live_xxx"},
  )
  print(res.json()["data"]["payments"])
  ```
</CodeGroup>

```json Response theme={null}
{
  "status": true,
  "data": {
    "payments": [
      {
        "amount": 10,
        "credits_added": 10,
        "status": "succeeded",
        "created_at": "2026-03-18T00:17:02.346Z"
      }
    ]
  },
  "error": null
}
```

| Field           | Type   | Description                                       |
| --------------- | ------ | ------------------------------------------------- |
| `amount`        | number | Payment amount (\$)                               |
| `credits_added` | number | Credits added to the account                      |
| `status`        | string | Payment status (`pending`, `succeeded`, `failed`) |
| `created_at`    | string | Payment date (ISO 8601)                           |

## Tracking spend on every call

Billed endpoints also return live balance headers, so you don't have to poll
`/account/me` after each call:

* `x-credits-charged` — what the call cost.
* `x-credits-remaining` — your balance afterwards.

See [Pricing](/pricing) for per‑endpoint rates.