Get an Account's Unspent Coins

POST

https://ada.nownodes.io/account/coins

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

application/json

Request value.

network_identifierNetworkIdentifierrequired

Rosetta network identifier object.

Show child attributes

blockchainstringrequired

Blockchain value.

networkstringrequired

If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet, preprod, or preview.

sub_network_identifierSubNetworkIdentifier

Sub Network Identifier value.

Show child attributes

networkstringrequired

Network value.

metadataobject

Additional metadata object.

account_identifierAccountIdentifierrequired

Rosetta account identifier object.

Show child attributes

addressstringrequired

The address may be a cryptographic public key (or some encoding of it) or a provided username.

sub_accountSubAccountIdentifier

Sub Account value.

Show child attributes

addressstringrequired

The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.

metadataobject

If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.

metadataobject

Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.

Show child attributes

chain_codestring

Hex string encoded extension of bip32 private and public keys with an extra 256 bits of entropy that consists of 32 bytes

include_mempoolboolean

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

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

Show child attributes

symbolstringrequired

Canonical symbol associated with a currency.

decimalsinteger<int32>>= 0required

Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10.

metadataany

Additional metadata object.

Response

200OK

HTTP 200 response for accountCoins.

400Bad Request

Bad Request. The request is malformed or contains invalid parameters.

401Unauthorized

Unauthorized: API key is present but rejected by the NOWNodes gateway.

422Unprocessable Entity

Missing API key. The NOWNodes gateway returns plain text for this error.

500Internal Server Error

Internal Server Error. The gateway or backend failed while processing the request.

Get an Account's Unspent Coins

curl -X POST 'https://ada.nownodes.io/account/coins' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "account_identifier": {
      "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
      "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
      },
      "metadata": {
        "chain_code": "chain_code_example"
      }
    },
    "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
    "currencies": [
      {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {}
      }
    ]
  }'

const response = await fetch('https://ada.nownodes.io/account/coins', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "account_identifier": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
        "sub_account": {
          "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
          "metadata": {}
        },
        "metadata": {
          "chain_code": "chain_code_example"
        }
      },
      "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
      "currencies": [
        {
          "symbol": "BTC",
          "decimals": 8,
          "metadata": {}
        }
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://ada.nownodes.io/account/coins')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "account_identifier": {
      "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
      "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
      },
      "metadata": {
        "chain_code": "chain_code_example"
      }
    },
    "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
    "currencies": [
      {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {}
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "account_identifier": {
    "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
    "sub_account": {
      "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
      "metadata": {}
    },
    "metadata": {
      "chain_code": "chain_code_example"
    }
  },
  "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
  "currencies": [
    {
      "symbol": "BTC",
      "decimals": 8,
      "metadata": {}
    }
  ]
}

response = requests.post('https://ada.nownodes.io/account/coins', json=payload)
data = response.json()

const response = await fetch('https://ada.nownodes.io/account/coins', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "account_identifier": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
        "sub_account": {
          "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
          "metadata": {}
        },
        "metadata": {
          "chain_code": "chain_code_example"
        }
      },
      "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
      "currencies": [
        {
          "symbol": "BTC",
          "decimals": 8,
          "metadata": {}
        }
      ]
    }),
});

const data = await response.json();

const endpoint = "https://ada.nownodes.io/account/coins";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "account_identifier": {
      "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
      "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
      },
      "metadata": {
        "chain_code": "chain_code_example"
      }
    },
    "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
    "currencies": [
      {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {}
      }
    ]
  });
console.log(result);

const response = await fetch('https://ada.nownodes.io/account/coins', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "account_identifier": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
        "sub_account": {
          "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
          "metadata": {}
        },
        "metadata": {
          "chain_code": "chain_code_example"
        }
      },
      "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
      "currencies": [
        {
          "symbol": "BTC",
          "decimals": 8,
          "metadata": {}
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "account_identifier": {
    "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
    "sub_account": {
      "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
      "metadata": {}
    },
    "metadata": {
      "chain_code": "chain_code_example"
    }
  },
  "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
  "currencies": [
    {
      "symbol": "BTC",
      "decimals": 8,
      "metadata": {}
    }
  ]
}

response = requests.post('https://ada.nownodes.io/account/coins', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://ada.nownodes.io/account/coins')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "account_identifier": {
      "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
      "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
      },
      "metadata": {
        "chain_code": "chain_code_example"
      }
    },
    "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
    "currencies": [
      {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {}
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "account_identifier": {
    "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
    "sub_account": {
      "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
      "metadata": {}
    },
    "metadata": {
      "chain_code": "chain_code_example"
    }
  },
  "include_mempool": "pool108zdflss3ayqlm5c7vr6mtqj2uwl99vk28ur8dv4zswdzt6yauc",
  "currencies": [
    {
      "symbol": "BTC",
      "decimals": 8,
      "metadata": {}
    }
  ]
}

{
  "block_identifier": {
    "index": 13646894,
    "hash": "9945cd69ca8e6bcf2e5f9a14742be0c051bf9dd916f0bb0b00ab39977b140d53"
  },
  "coins": [
    {
      "coin_identifier": {
        "identifier": "04cba8a56386ee2a23563e8f05b6e80c7074b56b099945abaecae8040c3b1650:0"
      },
      "amount": {
        "value": "94923541",
        "currency": {
          "symbol": "ADA",
          "decimals": 6
        }
      }
    }
  ]
}

{
  "code": 4000,
  "message": "Invalid request",
  "retriable": false
}

{
  "status_code": 400,
  "message": "Bad Request",
  "error": "bad_request"
}

Unknown API_key

Missing API_key

{
  "status_code": 500,
  "message": "Internal Server Error",
  "error": "internal_server_error"
}