---
title: "Get X credit balance"
method: GET
path: "/x-credits"
tags: ["Limits"]
---

# Get X credit balance

`GET /x-credits`

## Request

- Base URL: `https://api.multi-upload-tool.com/api/v1`
- URL: `https://api.multi-upload-tool.com/api/v1/x-credits`
- Auth: API key in header `x-api-key`

X bills every post, so X posting is metered in credits: 1 per post, 15 when the text contains a link (detected with X's own twitter-text rules). Returns the balance (plan allowance left this month + purchased credits, which never expire), the cost per post and the packs on sale. An X post fails when the balance is short.

## Response `200`

Balance, prices and packs.

- object
  - `success` boolean
  - `data` object
    - `balance` object
      - `monthlyAllowance` integer: Credits included in the plan each UTC month.
      - `includedRemaining` integer
      - `purchased` integer: Bought in packs; never expire.
      - `total` integer: includedRemaining + purchased.
    - `costs` object
      - `post` integer
      - `linkPost` integer
    - `packs` object[]
      - `name` string
      - `credits` integer
      - `price` number

## Other responses

- `401`: The API key is missing, invalid, revoked or expired.
- `429`: Too many requests for this endpoint group.

---

[API](https://skmtc.dev/multi-upload-tool/apis/multi-upload-tool-api.md) · [All operations](https://skmtc.dev/multi-upload-tool/apis/multi-upload-tool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/multi-upload-tool/apis/multi-upload-tool-api/revisions/bb7e72abbb76?raw)
