private/get-transactions

POST 
/private/get-transactions

Fetches recent transactions.

Request

Body

required

id int64required

Request id (echoed in response)

method stringrequired

Must be "private/get-transactions"

api_key stringrequired

Your API key (only required for private REST)

sig stringrequired

HMAC-SHA256 signature in hex (only required for private REST)

nonce int64required

Current timestamp in milliseconds, e.g. "1771761038000".

params objectrequired

instrument_name string

E.g. BTCUSD-PERP. Omit for 'all'.

journal_type JournalType (string)

Possible values: [TRADING, TRADE_FEE, ONCHAIN_WITHDRAWAL, ONCHAIN_DEPOSIT, FUNDING, REALIZED_PNL, INSURANCE_FUND, SOCIALIZED_LOSS, LIQUIDATION_FEE, SESSION_RESET, ADJUSTMENT, SESSION_SETTLE, UNCOVERED_LOSS, ADMIN_ADJUSTMENT, DELIST, SETTLEMENT_FEE, AUTO_CONVERSION, MANUAL_CONVERSION, SUBACCOUNT_TX, FIAT_WITHDRAWAL_CANCEL, MARGIN_TRADE_INTEREST]

Journal / transaction type

start_time int64

Start time in Unix time format (inclusive), ms or ns. Default: end_time - 1 day. Nanosecond recommended for accurate pagination.

end_time int64

End time in Unix time format (exclusive), ms or ns. Default: current system timestamp. Nanosecond recommended for accurate pagination.

limit int32

Maximum number of transactions to retrieve before end_time. Default: 100. Max: 100.

isolation_id string

Optional filter for transactions of a particular isolated position. Omit for 'all'.

Success.

Schema

id int64

Echoed request id

method string

Method invoked

code int32

0 = success; non-zero indicates error (reason code).

result object
Present when code === 0. result.data[] per docs (journal_type, journal_id, transaction_qty, realized_pnl, etc.).
data object[]
List of transactions.
Array [
account_id string
Account ID.
event_date string
Event date.
journal_type JournalType (string)
Possible values: [TRADING, TRADE_FEE, ONCHAIN_WITHDRAWAL, ONCHAIN_DEPOSIT, FUNDING, REALIZED_PNL, INSURANCE_FUND, SOCIALIZED_LOSS, LIQUIDATION_FEE, SESSION_RESET, ADJUSTMENT, SESSION_SETTLE, UNCOVERED_LOSS, ADMIN_ADJUSTMENT, DELIST, SETTLEMENT_FEE, AUTO_CONVERSION, MANUAL_CONVERSION, SUBACCOUNT_TX, FIAT_WITHDRAWAL_CANCEL, MARGIN_TRADE_INTEREST]
Journal / transaction type
journal_id int64
Journal ID.
transaction_qty decimal
Transaction quantity.
transaction_cost decimal
Transaction cost.
realized_pnl decimal
Realized PNL.
order_id int64
Order ID.
trade_id int64
Trade ID.
trade_match_id int64
Trade match ID; applicable to trades only; non-trade transactions may have zero or null.
event_timestamp_ms int64
Event timestamp in milliseconds.
event_timestamp_ns int64
Event timestamp in nanoseconds.
client_oid string
Client Order ID (can be empty).
taker_side TakerSide (string)
Possible values: [MAKER, TAKER]
Maker or taker side of the trade
side OrderSide (string)
Possible values: [BUY, SELL]
BUY or SELL
instrument_name string
E.g. BTCUSD-PERP.
isolation_id string
Isolation ID of the order if under isolated position.
isolation_type IsolationType (string)
Possible values: [ISOLATED_MARGIN]
Isolation type
]
message string

Present when code !== 0.

original string

Present when code !== 0.