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

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)
Request
query Parameters
account
Array of integers or null
Default: null

Returns transactions created in the provided account.

created_after
string or null <date-time>
Default: null

Returns objects created after the entered date.

Example: created_after=2020-09-12T14:15:22Z
created_before
string or null <date-time>
Default: null

Returns objects created before the entered date.

Example: created_before=2020-12-13T16:17:28Z
currency
Array of strings or null
Default: null

Returns transactions created in the provided currency.

Example: currency=bitcoin or ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7
destination_tag
integer or null
Default: null

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

id
integer or null
Default: null

Returns the object corresponding to the entered ID

interaction_type
string or null
Default: null

Filters the list of results by interaction type.

Enum: null "APPROVAL" "STAKE" "SWAP" "UNKNOWN" "UNWRAP" "WRAP"
label
string or null
Deprecated
Default: null

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

max_amount
string or null^[0-9]*(\.[0-9]+)?$
Default: null

Returns objects that have the provided max amount.

memo
string or null
Default: null

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

min_amount
string or null^[0-9]*(\.[0-9]+)?$
Default: null

Returns objects that have the provided min amount.

order
string or null
Default: null

Orders the list of results

Enum: null "asc" "desc"
Example: order=desc
order_by
string or null
Default: null

criteria to order by

Example: order_by=name
page
integer or null >= 1
Default: 1

Defines the page number to be fetched.

Example: page=3
page_size
integer or null >= -1
Default: 20

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

Example: page_size=40
recipient
string or null
Default: null

Filters the results on the provided recipient address.

status
Array of strings or null
Default: null

Returns objects that match the selected status.

Enum: "APPROVED" "CONFIRMED" "DROPPED" "FAILED" "FAILED_TO_BROADCAST" "FAILED_TO_CRAFT" "FAILED_TO_SIGN" "PENDING_APPROVAL" "PENDING_CREATE_IN_HSM" "REJECTED" "REPLACED" "SIGNED" "SUBMITTED"
title
string or null
Default: null

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

tx_hash
string or null
Default: null

Returns transactions that match the provided transaction hash.

tx_label
Array of strings or null
Default: null

Filters the list of results by transaction label id

type
string or null
Default: null

Filters the list of results by transaction type.

Enum: 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"
Responses
200

Transaction search results

400

Invalid search parameters

get/transactions
Response samples
application/json
{
  • "edges": [
    ],
  • "page_info": {
    }
}
Copyright © Ledger Enterprise Platform 2023. All right reserved.