AccountCoinsRequest
AccountCoinsRequest is utilized to make a request on the /account/coins endpoint.
Properties
Name | Type | Description | Required |
---|---|---|---|
network_identifier | NetworkIdentifier | The network_identifier specifies which network a particular object is associated with. | True |
account_identifier | AccountIdentifier | The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). | True |
include_mempool | Boolean | Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. | True |
currencies | []Currency | In some cases, the caller may not want to retrieve coins for all currencies for an AccountIdentifier. If the currencies field is populated, only coins for the specified currencies will be returned. If not populated, all unspent coins will be returned. | False |
Example
{
"network_identifier": {
"blockchain": "bitcoin",
"network": "mainnet",
"sub_network_identifier": {
"network": "shard 1",
"metadata": {
"producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
}
}
},
"account_identifier": {
"address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
"sub_account": {
"address": "0x6b175474e89094c44da98b954eedeac495271d0f",
"metadata": {}
},
"metadata": {}
},
"include_mempool": true,
"currencies": [
{
"symbol": "BTC",
"decimals": 8,
"metadata": {
"Issuer": "Satoshi"
}
}
]
}