# getBrc20AddressBalances

**Identifier:** `xverse_getBrc20AddressBalances`

**Provider:** [Xverse](https://kirha.com/providers/xverse.md)

Get all BRC-20 token balances for a Bitcoin address

## Run it with the CLI

```bash
kirha tools run xverse_getBrc20AddressBalances \
  --input '{
    "address": "<address>"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "xverse_getBrc20AddressBalances",
  "input": {
    "address": "<address>"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "address": {
      "description": "Bitcoin address",
      "minLength": 10,
      "type": "string"
    },
    "limit": {
      "default": 10,
      "description": "Number of tokens to return",
      "maximum": 60,
      "minimum": 1,
      "type": "number"
    },
    "offset": {
      "default": 0,
      "description": "Pagination offset",
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "address"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "tickers": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "tokens": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "availableBalance": {
            "type": "string"
          },
          "overallBalance": {
            "type": "string"
          },
          "ticker": {
            "type": "string"
          },
          "transferableBalance": {
            "type": "string"
          }
        },
        "required": [
          "ticker"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "total": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "total",
    "tokens",
    "tickers"
  ],
  "type": "object"
}
```

-----

[All Xverse tools](https://kirha.com/providers/xverse.md) · [< Back to tools list](https://kirha.com/tools.md)