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

# Get a balance

<mark style="color:green;">`POST`</mark> `https://api.passimpay.io/v2/balance`

This endpoint provides a list of cryptocurrency balances associated with your platform. Each entry in the list includes relevant details about the cryptocurrencies held.

**Rate Limit**: 10 requests per second

#### **Headers**

| Name           | Type   | Description                 |
| -------------- | ------ | --------------------------- |
| `x-signature`  | string | SHA-256 encrypted signature |
| `Content-Type` | string | application/json            |

#### **Request Body**

| Name         | Type    | Description |
| ------------ | ------- | ----------- |
| `platformId` | integer | Platform Id |

#### **Successful response (200)**

{% code overflow="wrap" %}

```json
{
    "result":1,
    "balance":{
        "10":{
            "amount":"1.00000000"
        },
        ...
    }
}
```

{% endcode %}

| Name    | Type    | Description                                         |
| ------- | ------- | --------------------------------------------------- |
| result  | integer | <p>Request result: <br><code>1</code>: success </p> |
| balance | object  | Cryptocurrency Balance List                         |

#### Cryptocurrency Balance List

| key object  | amount                 |
| ----------- | ---------------------- |
| Currency ID | Cryptocurrency Balance |

#### **Error Response (400)**

| Name    | Type    | Description                                      |
| ------- | ------- | ------------------------------------------------ |
| result  | integer | <p>Request result: <br><code>0</code>: error</p> |
| message | string  | Error description                                |