TAtatum
Deposit

List all deposits for product

/v3/ledger/deposits

1 credit per API call.

Lists all deposits for API key.

get/v3/ledger/deposits

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/ledger/deposits
  • Auth
    API key in header x-api-key

Query parameters

pageSizenumber
Example:20

Max number of items per page is 50.

pagenumber

Page number

sort'asc' | 'desc'
Example:asc

Direction of sorting. Can be asc or desc

status'Done' | 'InProgress'
Example:Done

Status of the deposit

currencystring
Example:BTC

Filter by currency

txIdstring

Filter by txId

tostring

Filter by to address

accountIdstring
Example:628bae6095e9ad06b52eb229

Filter by account id

Response

OK

txIdstring required
addressstring required

Blockchain address.

timestampnumber required

End interval in UTC millis.

xpubstring required

Extended public key to derive address from.

derivationKeyinteger required

Derivation key index for given address.

amountstring required

Amount of the trade

status'InProgress' | 'Done' | 'Failed' required

Status of deposit

accountIdstring required

Account ID.

currencystring required

Currency

referencestring required
voutnumber required
spentboolean required
blockHeightnumber required

Block of deposit

blockHashstring

Hash of the block where this transaction was in.

fromstring

Blockchain address.

Example response

[
  {
    "txId": "6498A3BE7313FEF32C9C0130F321D7808439F7F59D41932122383CC9E109F534",
    "address": "7c21ed165e294db78b95f0f181086d6f",
    "timestamp": 1613654998398,
    "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka",
    "amount": "15000",
    "status": "Done",
    "accountId": "5e68c66581f2ee32bc354087",
    "currency": "BTC",
    "reference": "some reference",
    "blockHeight": 228232166,
    "blockHash": "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137",
    "from": "7c21ed165e294db78b95f0f181086d6f"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.