Wallet

Balance Endpoint

Overview

The Balance Endpoint offers comprehensive balance and transaction data for specified wallet addresses. This endpoint is specifically tailored to provide detailed insights into the runes and bitcoin associated with a given address.

Functionality

• Address Parameter: Users must specify a wallet address to query its balance and transaction data.

• Real-Time Data on Runes: The endpoint focuses on providing detailed information about runes and bitcoin held in the queried wallet.

• UTXOs and UTXOsIds: Understanding the difference between utxos and utxosIds is crucial:

  • utxos: This array contains detailed information about each unspent transaction output (UTXO) that has been parsed and is available for the specified wallet address.

  • utxosIds: Represents all UTXOs associated with the wallet, including those not yet parsed. Initially, new wallet queries may show only utxosIds without corresponding utxos data, indicating that parsing is pending. Subsequent queries will reveal detailed UTXO data as parsing is completed.

Endpoint Details

Get wallet balance and UTXO data

get

https://api-dev.saturnbtc.iohttps://api.saturnbtc.io

/v0/wallet/balance

Authorizations

bearer

x-api-keystringRequired

Query parameters

addressstringRequired

Responses

200

Wallet - The wallet's balance runes, btc and UTXO data.

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v0/wallet/balance

HTTPcURLJavaScriptPython

GET /v0/wallet/balance?address=text HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "balance": "text",
  "utxosIds": [
    "text"
  ],
  "utxos": [
    {
      "collectionStatuses": [
        {
          "type": null,
          "id": "text",
          "name": "text",
          "displayName": "text",
          "symbol": null,
          "divisibility": 1,
          "supply": "text",
          "createdAt": "text",
          "updatedAt": "text",
          "isWatchedByUser": true,
          "amount": "text",
          "riskyAmount": "text"
        }
      ],
      "isUsed": true,
      "hasInscription": true,
      "inscriptionIds": [
        "text"
      ],
      "txid": "text",
      "vout": 1,
      "status": {
        "confirmed": true,
        "block_height": 1,
        "block_hash": "text",
        "block_time": 1
      },
      "value": "text"
    }
  ]
}

• Parameters:

  • address (string, required): The wallet address for which balance and UTXO data is requested.

Response Structure

The response from this endpoint provides a JSON object with the following key details:

• address: The queried wallet address.

• balance: The overall balance of the wallet.

• utxos: An array of UTXO objects, each containing:

  • Details about its balance and associated collections.

  • Information on any inscriptions, including their content and metadata.

• utxosIds: An array of UTXO IDs representing all UTXOs associated with the wallet.

• Each UTXO and collection item contains additional fields such as market price, batch size, verification status, and timestamps.