🆎 Get BTC received amount for address

Code samples

GET /api/v1/btc/account/{address}/balance

curl 'https://settla.net/api/v1/btc/account/bc1qay6jxstdwyma44ak8qfu52njqy9ujnfm37hllg/balance' \
  -H 'X-API-Key: $SETTLA_API_KEY' \
  -H 'Accept: application/json'

Returns the total received by an address via getreceivedbyaddress. The address must belong to the node's wallet, and the production node has no wallet — so on the live API every address, including valid ones, comes back 500 with Could not connect to BTC node. (the node's real complaint, "address not found in wallet", is collapsed into that generic message). This endpoint is documented for self-hosted deployments that load a wallet. Two further limits worth knowing even there: getreceivedbyaddress counts what an address has received, never what it still holds — spent outputs are not subtracted — and it says nothing about addresses the wallet does not track. For balances of addresses you control, use Watch-only addresses.

🛠️ Parameters

Example responses

200 Response

{
  "address": "bc1qay6jxstdwyma44ak8qfu52njqy9ujnfm37hllg",
  "minconf": 1,
  "balance": 0.012
}

400 Response

{
  "error": "Parameter \"minconf\" must be a non-negative integer"
}

500 Response

{
  "error": "Could not connect to BTC node."
}

🔁 Responses

🔄 Response Schema

Status Code 200

Status Code 400

Status Code 500