getAccountCoins

post https://{network-cardano}.gateway.tatum.io/account/coins

Get an array of all unspent coins for an AccountIdentifier and the
BlockIdentifier at which the lookup was performed. If your implementation
does not support coins (i.e. it is for an account-based blockchain),
you do not need to implement this endpoint. If you implementation does
support coins (i.e. it is fro a UTXO-based blockchain), you MUST
also complete the /account/balance endpoint.

It is important to note that making a coins request for an account
without populating the SubAccountIdentifier should not result in the
coins of all possible SubAccountIdentifiers being returned. Rather,
it should result in the coins pertaining to no SubAccountIdentifiers
being returned. To get all coins associated with an account, it may be
necessary to perform multiple coin requests with unique AccountIdentifiers.

Optionally, an implementation may choose to support updating an AccountIdentifier's
unspent coins based on the contents of the mempool. Note, using this functionality
breaks any guarantee of idempotency.

Body Params

network_identifier

object

required

The network_identifier specifies which network a particular object is associated with.

account_identifier

object

required

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).

include_mempool

boolean

required

Include state from the mempool when looking up an account's
unspent coins. Note, using this functionality
breaks any guarantee of idempotency.

currencies

array of objects

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.

currencies

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://cardano-mainnet.gateway.tatum.io/account/coins \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'x-api-key: t-66a730ccccfd17001c479705-2f597d14ad7543f289a03418' \
6
     --data '
7
{
8
  "include_mempool": true
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Expected response to a valid request

500unexpected error