🆎 Get BTC received amount for address

Code samples

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

Returns the total amount received by a given address using getreceivedbyaddress. Note that this requires the address to belong to the node's wallet.

🛠️ Parameters

Name	In	Type	Required	Description
address	path	string	true	Bitcoin address (Base58 or Bech32) managed by the node wallet.
minconf	query	integer(int32)	false	Minimum number of confirmations required for payments.

Example responses

200 Response

{
  "address": "bc1qexampleaddress0000000000000000000000000",
  "minconf": 1,
  "balance": 0.12345678
}

400 Response

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

🔁 Responses

Status	Meaning	Description	Schema
200	OK	BTC received amount for the address	Inline
400	Bad Request	Invalid `minconf` parameter (negative)	Inline
500	Internal Server Error	Could not connect to BTC node	None

🔄 Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» address	string	false	none	none
» minconf	integer(int32)	false	none	none
» balance	number(double)	false	none	Total amount received by the address in BTC.

Status Code 400

Name	Type	Required	Restrictions	Description
» error	string	false	none	none