Sign in
hydra

Read this node's own in-head balance. (admin access required)

Changed on

Reports the local participant's own funds currently inside the head (ADA + native tokens), aggregated per asset. Excludes the counterparty. Requires an open/connected head.

get/hydra/head/balance

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/head/balance
  • Auth: API key in header token

Query parameters

headIdstring required

ID of the HydraHead

Response

Own in-head balance

status'success' required

Example response

{
  "status": "success",
  "data": {
    "hydraHeadId": "cuid_v2_auto_generated",
    "address": "addr_test1...",
    "connected": true,
    "utxoCount": 1,
    "unbackedLovelace": "0",
    "hasUnbackedUtxos": false,
    "balance": [
      {
        "unit": "",
        "quantity": "10000000"
      }
    ]
  }
}

Changes