Skip to main content
cURL

Query Parameters

currency
enum<string>
required

The currency symbol.

๐Ÿ“– Related Article: Using the currency Parameter

Currency, i.e "BTC", "ETH", "USDC"

Available options:
BTC,
ETH,
STETH,
ETHW,
USDC,
USDT,
EURR,
SOL,
XRP,
USYC,
PAXG,
BNB,
USDE
start_timestamp
integer
required

The earliest timestamp to return result from (milliseconds since the UNIX epoch) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

end_timestamp
integer
required

The most recent timestamp to return result from (milliseconds since the UNIX epoch) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

query
string

Space-separated keywords used to filter results. An entry must match every keyword. Keywords are case-sensitive.

Transaction types:

  • trade - trades
  • deposit - deposits
  • withdrawal - withdrawals
  • transfer - transfers between accounts
  • reward - reward transfers
  • mm_lsp_payment - market-maker LSP payout transfers
  • settlement - funding / session settlement (display type settlement)
  • delivery - instrument delivery (display type delivery)
  • expiry - options that expired out of the money
  • assignment - assigned options
  • exercise - exercised options
  • swap - currency swaps
  • correction - balance corrections
  • block_trade - block trades
  • combo_trade - combo trades
  • liquidation - liquidation trades and liquidation transfers (display type liquidation transfer)
  • lsp - LSP position moves and commissions (display types LSP transfer / LSP commission)
  • adl - ADL position moves and commissions (display types ADL transfer / ADL commission)
  • commission - LSP/ADL commissions; typically combined with lsp or adl
  • position - position moves (display type position move); also matches position move transfer
  • insurance - insurance-related transfers
  • insurance_transfer - insurance transfers
  • affiliate - affiliate payouts
  • partner - partner / application fee payouts
  • fee_deposit - fee balance deposits
  • fee_balance_transfer - fee balance transfers
  • stake_reward - staking rewards
  • lock_deposit_balance - locked deposit balance
  • unlock_deposit_balance - unlocked deposit balance
  • summary - settlement summaries
  • options_settlement_summary - options settlement summaries
  • negative_balance_fee - negative balance fees
  • creation - future creation from expired options (display type future creation)
  • margin_loan - margin loan interest, issuance, and repayment
  • corporate_action_adjustment - stock split, rights offering, and spin-off adjustments
  • stock_split - stock splits
  • rights_offering - rights offerings
  • spin_off - spin-offs
  • m_and_a - mergers and acquisitions (display type m&a)
  • rename - instrument renames
  • custody_settlement_fee - custody settlement fees
  • sweep_isolated_position - isolated position sweeps
  • structured_product_spread - structured product spread
  • usdc_reward - USDC rewards
  • usdc_reward_received - USDC rewards received
  • usdc_platform_reward - USDC platform rewards
  • usdc_reward_payment - USDC reward payments
  • ethena_reward - Ethena rewards
  • buidl_reward - BUIDL rewards
  • socialize_loses - socialized losses/refunds (display types socialized fund / socialized refund)

Additional filters:

  • maker / taker - trade role
  • open / close - trade kind (close also matches deliveries and liquidations)
  • buy / sell - direction
  • option / future / spot - instrument kind
  • voice_broker - voice-broker trades

Additional indexed values, depending on type:

  • deposits โ€” destination address (custody deposits also index custody name and request id)
  • withdrawals โ€” withdrawal code or custody request id (not the destination address)
  • transfers โ€” counterparty username
Example:

"settlement"

count
integer

Count of transaction log entries returned, default - 100, maximum - 1000

Required range: 1 <= x <= 1000
subaccount_id
integer

Id of a subaccount

Example:

9

continuation
integer

Continuation token for pagination

Example:

429946

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object
required
id
integer

The id that was sent in the request