latestOpenAPI 3.0.22026-08-1041321430.0 KB

c88faa17bc25

Transactions

Search Transaction

Use the following parameters to search transactions.

Beware that default order is "desc", which can cause surprising result with pagination if transactions are being inserted. see Pagination for more details

get/transactions

Query parameters

accountinteger[] nullable

Returns transactions created in the provided account.

created_afterstring date-time nullable

Returns objects created after the entered date.

created_beforestring date-time nullable

Returns objects created before the entered date.

currencystring[] nullable

Returns transactions created in the provided currency.

destination_taginteger nullable

Returns transactions that match the provided destination tag (XRP only).

idinteger nullable

Returns the object corresponding to the entered ID

interaction_type'null' | 'APPROVAL' | 'STAKE' | 'SWAP' | 'UNKNOWN' | 'UNWRAP' | 'WRAP' nullable

Filters the list of results by interaction type.

labelstring nullable

Returns transactions whose note's title or content contain the provided label.This field is deprecated, please use the field title instead

max_amountstring nullable

Returns objects that have the provided max amount.

memostring nullable

representation of the memo - an ascii, hex string or base 10 integer

min_amountstring nullable

Returns objects that have the provided min amount.

order'null' | 'asc' | 'desc' nullable

Orders the list of results

order_bystring nullable

criteria to order by

pageinteger nullable

Defines the page number to be fetched.

page_sizeinteger nullable

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

recipientstring nullable

Filters the results on the provided recipient address.

statusstring[] nullable

Returns objects that match the selected status.

titlestring nullable

Returns transactions whose note's title or content contain the provided label.

tx_hashstring nullable

Returns transactions that match the provided transaction hash.

tx_labelstring[] nullable

Filters the list of results by transaction label id

type'null' | 'ADDPROXY' | 'ANONYMOUSPROXY' | 'BOND' | 'BONDEXTRA' | 'CHILL' | 'CREATE_SPL_TOKEN_ACCOUNT' | 'DELEGATE' | 'DELEGATE_VOTE_TO_DREP' | 'DEPLOY_CONTRACT' | 'EXECUTE_CONTRACT' | 'KILLANONYMOUS' | 'PROXY' | 'REBOND' | 'RECEIVE' | 'RECEIVE_SPL_TOKEN_CHECKED' | 'RECEIVE_SPL_TOKEN_CHECKED_FUNDED' | 'REMOVEPROXY' | 'REVEAL' | 'REWARD' | 'SEND' | 'SEND_SPL_TOKEN_CHECKED' | 'SEND_SPL_TOKEN_CHECKED_FUNDED' | 'SETCONTROLLER' | 'SETPAYEE' | 'STAKE' | 'STAKE_CREATE_DELEGATE' | 'STAKE_DEACTIVATE' | 'STAKE_DELEGATE' | 'STAKE_MERGE' | 'STAKE_SPLIT' | 'STAKE_SPLIT_DEACTIVATE' | 'STAKE_WITHDRAW' | 'STAKING_DELEGATE' | 'STAKING_DEREGISTER' | 'STAKING_REGISTER' | 'STAKING_WITHDRAW' | 'UNBOND' | 'UNDELEGATE' | 'UNKNOWN' | 'WITHDRAWUNBONDED' nullable

Filters the list of results by transaction type.

Response

Transaction search results