/searchTransactions

1 min

POST

/searchTransactions

DEPRECATED - use getTransactions instead of searchTransactions + getTransactionsPage

Search for transactions based on various filters. All parameters are optional. The search will return the count of transactions that match the specified criteria.

Return: JSON object containing the amount of extracted transactions in the system for given filters.

-------------------- Request --------------------

searchTransactions(
        include_output_transactions=TRUE,
        include_input_transactions=FALSE,
        currencies=["BTC", "ETH"],
        accounts=None,
        creators=None,
        user_description=None,
        start_date_time_in_milliseconds_since_epoch=None,
        end_date_time_in_milliseconds_since_epoch=None,
        status_keys=None,
        limit_rows=1000,
        wallet_ids=["mywalletid1", "mywalletid2"],
        include_high_risk_transactions=False,
        from_addresses=None,
        to_addresses=None,
        sort_order=SortOrder.DESC,
        unlimited_rows=False
    )

-------------------- Response --------------------

 {
    "FunctionData": {
        "ExtractedTransactionsCount": 25
        },
    "Meta": {
        "AccessToken": "6276...79fe",
        "Destination": "0453...9d56",
        "Source": "fc581...42f3",
        "Time": "2025-02-10 13:05:23.729"
    }
}

include_output_transactionsbooleanBool indicating if we want output transactions.

include_input_transactionsbooleanBool indicating if we want input transactions.

currenciesarrayList of requested currencies used in this operation (BTC, ETH, BCH, XRP, etc.).

accountsarrayOptional list of account IDs used in this operation.

creatorsarrayOptional list of IDs of the creators of the transaction.

user_descriptionstringOptional substring insensitive to search in user description.

start_date_time_in_milliseconds_since_epochintegerOptional filter transactions from that time including.

end_date_time_in_milliseconds_since_epochintegerOptional end date of the transactions (in Unix Epoch time).

status_keysarrayOptional list of indices from TransactionState enum.

limit_rowsintegerOptional max number of transactions to return.

wallet_idsarrayOptional list of unique wallet IDs provided from the client.

include_high_risk_transactionsbooleanBool indicating to include transactions deemed high risk by AML service. True - includes all transactions, both low risk and high risk. False - only include low risk transactions, high risk transactions are excluded.

from_addressstringthe address that the tokens will be transferred from. Has to be either Hot Evm address or one of its deposit addresses if its an endpoint account. If from_address is None then Hot Evm address is used

to_addressstringthe address that the tokens will be transferred to.

sort_orderobjectthe address that the tokens will be transferred to.

unlimited_rowsbooleanthe address that the tokens will be transferred to.

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/searchTransactions?include_output_transactions=False&include_input_transactions=False&currencies=ETH&accounts=1%2C2&creators=bob%40gk8.io%2CJohn%40gk8.io&user_description=abcd&status_keys=None&limit_rows=10&include_high_risk_transactions=False&from_address=0x53C39FFd56EE07e081a53bd176baf20DBE24e19B&to_address=0x53C39FFd56EE07e081a53bd176baf20DBE24e19B&sort_order=%22SortOrder.DESC%22&unlimited_rows=boolean' \
     --header 'accept: application/json'