List transactions

get

https://your-protect-instance.example.com/api/rest/v1/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.

Query Params

currency

string

Filter on ID or symbol of the currency

direction

string

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

query

string

Filter by query string in any of the fields address, customerid, transactionid, hash, type.

limit

string

The amount of transactions returned per request. Max 100.

offset

string

The offset from which to begin selection of transactions.

from

date-time

Only return transactions from after this timestamp.

date-time

Only return transactions from before this timestamp.

transactionIds

array of strings

Filter on Protect internal transactionID. This is purely internal and should rarely be used by clients

transactionIds

type

string

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

source

string

Returns only transaction that have this address as a source

destination

string

Returns only transaction that have this address as a destination

ids

array of strings

Filter on Protect transaction ID, as visible in the transaction objects.

ids

blockchain

string

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

network

string

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

fromBlockNumber

string

Only return transactions from after this block.

toBlockNumber

string

Only return transactions from before this block.

hashes

array of strings

Filter on transaction hash, as visible in the transaction objects.

hashes

address

string

Returns only transaction that have this address as either a source or a destination

amountAbove

string

Returns only transactions with an amount strictly above the given amount

excludeUnknownSourceDestination

boolean

Returns only transactions with a known source and destination, default false

customerId

string

Returns only transactions with a specific customer id

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.