Sign in

v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
Transactions

Export Transactions

Start the export process for filtered transactions using cursor pagination.

get/api/v1/transactions/export

Query parameters

limitinteger

The amount of transactions to export, unlimited if not set.

The amount of transactions to export, unlimited if not set.

created_beforestring date-time
created_afterstring date-time
modified_afterstring date-time
vault_idsstring[]

The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault.

The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault.

chainsstring[]
initiator_idsstring[]
typesTransactionType[]
sub_typesTransactionSubType[]
signer_typesSignerType[]
user_typesUserType[]
transaction_idsstring[]
end_user_idsstring[]
asset_idsstring[]
direction'outgoing' | 'incoming'
transaction_hashesstring[]

Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.

Transaction hashes to filter by. Will return transactions with any of the specified hashes. The format of the hash depends on the blockchain type.

searchstring

String to search transactions by ID or hash.

String to search transactions by ID or hash.

frozenboolean

Filter for frozen transactions or transactions that were unfrozen.

Filter for frozen transactions or transactions that were unfrozen.

claimedboolean

Filter for transactions waiting for the receiver to claim or accept. true selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). false selects ones not yet settled — still pending receiver action, or (Canton) already expired.

Filter for transactions waiting for the receiver to claim or accept. true selects settled transfers (Stellar claimable balances that were claimed, Canton transfers that were accepted). false selects ones not yet settled — still pending receiver action, or (Canton) already expired.

Response

Successful Response

idstring uuid required

ID of the export.

creation_timestring date-time required

The date and time when the object was created.

type'csv' | 'zip' required
state'created' | 'in_progress' | 'aborted' | 'ready' | 'error' required
organization_idstring uuid required

The id of the organization.

user_idstring required

The id of the user.

resource_type'transaction' | 'backup_snapshot' | 'vault' required
successful_items_countinteger required

The number of items that were successfully exported.

failed_items_countinteger required

The number of items that failed to be exported.

total_items_countinteger required

The total number of items to be exported.

request_idstring required

The request id of the export.

download_urlstring required

The download url of the export.

expiration_timestring date-time required

The date and time when the object will expire.