HEhel
Exports

Export Withdrawal Transactions

Changed on

Exports all matching withdrawal transactions for your account (no pagination cap). Requires an API key with the WITHDRAWS_READ permission. Use startDate and endDate to filter by date range.

get/v1/export/withdrawals

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/export/withdrawals
  • Auth
    HTTP bearer

Query parameters

apiKeystring required

Your API key, which can be generated from the Helio Dashboard settings page.

pagenumber

Page number (1-based).

limitnumber

Page size. Defaults to 20, maximum 100.

lastItemIdstring

Cursor for pagination. Returns items with _id less than this value.

searchstring

Search by withdrawal detail ID, destination wallet (prefix), source token, or destination token.

sortstring

Sort field. Defaults to createdAt.

order'asc' | 'desc'

Sort order. Defaults to desc.

startDatestring

ISO 8601 start of createdAt range (inclusive).

endDatestring

ISO 8601 end of createdAt range (inclusive).

stateWithdrawalState[]

Filter by one or more withdrawal states.

sourceChainstring

Filter by source chain symbol (e.g. SOL, ETH).

destinationChainstring

Filter by destination chain symbol.

withdrawalConfigIdstring

Filter by withdrawal config ID.

Response

Successful response with exported withdrawals.

idstring

Withdrawal detail ID.

state'QUOTED' | 'SUBMITTING' | 'SUBMITTED' | 'BRIDGING' | 'COMPLETED' | 'FAILED' | 'FAILED_EXPIRED' | 'EXPIRED' | 'REFUNDED_BY_PROVIDER'
timestring

ISO 8601 created timestamp.

sourceChainstring
sourceTokenstring
sourceAmountstring

Source amount in atomic units.

destinationChainstring
destinationTokenstring
destinationAmountstring

Destination amount in atomic units.

destinationWalletAddressstring
sourceTxHashstring nullable
sourceTxExplorerLinkstring nullable
destinationTxHashstring nullable
destinationTxExplorerLinkstring nullable
platformFeestring
affiliateFeestring
decentBridgeFeestring
networkGasSourcestring
networkGasDestinationstring nullable
transactionType'WITHDRAWAL'

Always WITHDRAWAL for this export.

Changes