# getBitcoinWalletBalance

**Identifier:** `xverse_getBitcoinWalletBalance`

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

Get the balance for a given Bitcoin address

## Run it with the CLI

```bash
kirha tools run xverse_getBitcoinWalletBalance \
  --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_getBitcoinWalletBalance",
  "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",
      "type": "string"
    }
  },
  "required": [
    "address"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "bitcoinAddress": {
      "type": "string"
    },
    "confirmedBalance": {
      "additionalProperties": false,
      "properties": {
        "btcValue": {
          "type": "number"
        },
        "fundedTxoCount": {
          "type": "number"
        },
        "fundedTxoSum": {
          "type": "number"
        },
        "satoshiValue": {
          "type": "number"
        },
        "spentTxoCount": {
          "type": "number"
        },
        "spentTxoSum": {
          "type": "number"
        },
        "transactionCount": {
          "type": "number"
        }
      },
      "required": [
        "fundedTxoCount",
        "fundedTxoSum",
        "spentTxoCount",
        "spentTxoSum",
        "transactionCount",
        "satoshiValue",
        "btcValue"
      ],
      "type": "object"
    },
    "context": {
      "type": "string"
    },
    "unconfirmedBalance": {
      "additionalProperties": false,
      "properties": {
        "btcValue": {
          "type": "number"
        },
        "fundedTxoCount": {
          "type": "number"
        },
        "fundedTxoSum": {
          "type": "number"
        },
        "satoshiValue": {
          "type": "number"
        },
        "spentTxoCount": {
          "type": "number"
        },
        "spentTxoSum": {
          "type": "number"
        },
        "transactionCount": {
          "type": "number"
        }
      },
      "required": [
        "fundedTxoCount",
        "fundedTxoSum",
        "spentTxoCount",
        "spentTxoSum",
        "transactionCount",
        "satoshiValue",
        "btcValue"
      ],
      "type": "object"
    }
  },
  "required": [
    "context",
    "bitcoinAddress",
    "confirmedBalance",
    "unconfirmedBalance"
  ],
  "type": "object"
}
```

-----

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