Skip to navigation
TRANSFERS AND STAKINGTransactions

List transactions

This endpoint returns a list of transactions based on the provided query parameters.

You must specify either a currency (by ID or symbol) or a combination of blockchain and network.

  • If currency is provided, blockchain and network cannot be used.
  • If currency is not provided, you may use blockchain, network, or both together.

Only one of these approaches is allowed per request.

The currencyID is unique across blockchains and networks, and can be identified by querying the /currencies endpoint. We recommend using currencyID whenever possible to avoid ambiguity.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencystringOptional
Filter on ID or symbol of the currency
directionstringOptional

The direction of the transaction (e.g. incoming, outgoing)

querystringOptional
Filter by query string in any of the fields address, customerid, transactionid, hash, type.
limitlongOptional
The amount of transactions returned per request. Max 100.
offsetlongOptional
The offset from which to begin selection of transactions.
fromdatetimeOptional
Only return transactions from after this timestamp.
todatetimeOptional
Only return transactions from before this timestamp.
transactionIdslist of stringsOptional
Filter on Protect internal transactionID. This is purely internal and should rarely be used by clients
typestringOptional

The type of transactions to fetch (e.g. burn).

sourcestringOptional
Returns only transaction that have this address as a source
destinationstringOptional
Returns only transaction that have this address as a destination
idslist of stringsOptional
Filter on Protect transaction ID, as visible in the transaction objects.
blockchainstringOptional

The blockchain associated with the transactions (e.g. ETH, BTC)

networkstringOptional

The network the transaction took place in (e.g. mainnet, testnet).

fromBlockNumberstringOptionalformat: "uint64"
Only return transactions from after this block.
toBlockNumberstringOptionalformat: "uint64"
Only return transactions from before this block.
hasheslist of stringsOptional
Filter on transaction hash, as visible in the transaction objects.
addressstringOptional
Returns only transaction that have this address as either a source or a destination
amountAbovestringOptional
Returns only transactions with an amount strictly above the given amount
excludeUnknownSourceDestinationbooleanOptional
Returns only transactions with a known source and destination, default false
customerIdstringOptional
Returns only transactions with a specific customer id

Response

A successful response.
resultlist of objectsOptional
totalItemsstringOptionalformat: "uint64"
The total number of transactions.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error