π° List BTC addresses managed by node wallet
Code samples
GET /api/v1/btc/account
Returns a list of wallet addresses and their received amounts using the listreceivedbyaddress Bitcoin JSON-RPC method.
π οΈ Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| minconf | query | integer(int32) | false | Minimum number of confirmations required for payments. |
| includeEmpty | query | boolean | false | Whether to include addresses with no transactions. |
| includeWatchOnly | query | boolean | false | Whether to include watch-only addresses. |
Example responses
200 Response
[
{
"address": "string",
"amount": 0.1,
"confirmations": 0,
"label": "string",
"txids": [
"string"
]
}
]
π Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of addresses known to the node wallet | 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 |
|---|---|---|---|---|
| anonymous | [BtcReceivedByAddress] | false | none | [Entry returned by listreceivedbyaddress.] |
| Β» address | string | false | none | Bitcoin address. |
| Β» amount | number(double) | false | none | Total amount received by this address in BTC. |
| Β» confirmations | integer(int64) | false | none | none |
| » label | string¦null | false | none | none |
| Β» txids | [string] | false | none | none |
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Β» error | string | false | none | none |