private/get_transaction_log

Retrieves a detailed transaction log for the authenticated account. The log includes all account activities such as trades, deposits, withdrawals, transfers, fees, and other balance-affecting operations.

Results can be filtered by currency, time range, and transaction type. Use the continuation parameter for pagination when retrieving large transaction histories. To retrieve transactions for a specific subaccount, use the subaccount_id parameter.

Trade entries executed in Starbase include starbase_match_id, starbase_order_id, and starbase_timestamp.

When an option expires out of the money, the transaction log type is expiry. As there is nothing to settle into futures in this case, this remains the only entry in the transaction log for that expiration.

LSP and ADL position moves are logged as type LSP transfer / ADL transfer. Both the liquidated/deleveraged account and the receiving account get that same type. A separate optional role field (source or destination) is present on those transfer entries — and also on liquidation transfer and position move — and is omitted on all other types, including LSP commission / ADL commission and ordinary trades. Do not confuse role with user_role (maker / taker) on trades.

History Limit: This API method has no time limit - users can query transaction history back to account creation. Note that the CSV export feature available on the website is year-limited to 2023.

Note - This method has distinct API rate limiting requirements: Sustained rate: 1 request/second. For more information, see Rate Limits.

📖 Related Support Article: Transaction log

📖 Related Article: Liquidity Support Program (LSP) API Guide

Scope: account:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_transaction_log \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "private/get_transaction_log",
  "params": {
    "currency": "BTC",
    "start_timestamp": "1613657734000",
    "end_timestamp": "1613660407000",
    "count": 5
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 4,
  "result": {
    "logs": [
      {
        "username": "TestUser",
        "user_seq": 6010,
        "user_id": 7,
        "type": "LSP transfer",
        "role": "source",
        "side": "sell",
        "trade_id": null,
        "timestamp": 1613659900000,
        "price_currency": "USD",
        "price": 63481.75,
        "position": 0,
        "order_id": null,
        "session_rpl": -12.4,
        "total_interest_pl": 0.00000512,
        "interest_pl": 0.00000512,
        "instrument_name": "BTC-PERPETUAL",
        "id": 61313,
        "equity": 2998.5275869,
        "currency": "BTC",
        "commission": 0,
        "change": -2.4,
        "cashflow": -2.4,
        "balance": 2998.82270418,
        "amount": 5000
      },
      {
        "username": "TestUser",
        "user_seq": 6009,
        "user_id": 7,
        "type": "transfer",
        "trade_id": null,
        "timestamp": 1613659830333,
        "side": "-",
        "price": null,
        "position": null,
        "order_id": null,
        "interest_pl": null,
        "instrument_name": null,
        "info": {
          "transfer_type": "subaccount",
          "other_user_id": 27,
          "other_user": "Subaccount"
        },
        "id": 61312,
        "equity": 3000.9275869,
        "currency": "BTC",
        "commission": 0,
        "change": -2.5,
        "cashflow": -2.5,
        "balance": 3001.22270418
      },
      {
        "username": "TestUser",
        "user_seq": 6008,
        "user_id": 7,
        "type": "settlement",
        "trade_id": null,
        "total_interest_pl": 0.00001243,
        "timestamp": 1613659544153,
        "side": "long",
        "session_upl": 0.00220172,
        "session_rpl": -0.00004467,
        "price_currency": "USD",
        "price": 51807.07,
        "position": 1520,
        "order_id": null,
        "interest_pl": 0.00000993,
        "instrument_name": "BTC-PERPETUAL",
        "info": {
          "settlement_price": 51807,
          "floating_pl": 0.00220172
        },
        "id": 61311,
        "equity": 3003.42821428,
        "currency": "BTC",
        "commission": null,
        "change": 0.00215706,
        "cashflow": 0.00215706,
        "balance": 3003.72270418,
        "amount": 1520
      },
      {
        "username": "TestUser",
        "user_seq": 6007,
        "user_id": 7,
        "type": "deposit",
        "trade_id": null,
        "timestamp": 1613657828414,
        "side": "-",
        "price": null,
        "position": null,
        "order_id": null,
        "interest_pl": null,
        "instrument_name": null,
        "info": {
          "transaction": "de6eba075855f32c9510f338d3ca0900376cedcb9f7b142caccfbdc292d3237e",
          "deposit_type": "wallet",
          "addr": "2N8prMvpZHr8aYqodX3S4yhz5wMxjY8La3p"
        },
        "id": 61291,
        "equity": 3003.4876111,
        "currency": "BTC",
        "commission": 0,
        "change": 0.65,
        "cashflow": 0.65,
        "balance": 3003.72054712
      },
      {
        "username": "TestUser",
        "user_seq": 6006,
        "user_role": "maker",
        "user_id": 7,
        "type": "trade",
        "ip": "11.222.33.44",
        "trade_id": "28349",
        "timestamp": 1613657734620,
        "side": "open buy",
        "profit_as_cashflow": false,
        "price_currency": "BTC",
        "price": 0.1537,
        "position": 0.7,
        "order_id": "67546",
        "mark_price": 0.04884653215049635,
        "interest_pl": 0,
        "instrument_name": "BTC-19FEB21-49200-C",
        "info": "Source: api",
        "id": 61289,
        "equity": 3002.83270455,
        "currency": "BTC",
        "commission": 0,
        "change": -0.10759,
        "cashflow": -0.10759,
        "balance": 3003.07054712,
        "amount": 0.7
      },
      {
        "username": "TestUser",
        "user_seq": 6005,
        "user_role": "maker",
        "user_id": 7,
        "type": "trade",
        "trade_id": "28349",
        "timestamp": 1613657734620,
        "side": "close buy",
        "profit_as_cashflow": false,
        "price_currency": "BTC",
        "price": 0.1537,
        "position": 0,
        "order_id": "67546",
        "mark_price": 0.04884653215049635,
        "interest_pl": 0,
        "instrument_name": "BTC-19FEB21-49200-C",
        "info": "Source: api",
        "id": 61288,
        "equity": 3002.83270455,
        "currency": "BTC",
        "commission": 0,
        "change": -0.04611,
        "cashflow": -0.04611,
        "balance": 3003.17813712,
        "amount": 0.3
      },
      {
        "username": "TestUser",
        "user_seq": 6004,
        "user_id": 7,
        "type": "expiry",
        "trade_id": null,
        "timestamp": 1613657734620,
        "side": "close buy",
        "price_currency": "BTC",
        "price": 0,
        "position": 0,
        "order_id": null,
        "interest_pl": null,
        "instrument_name": "BTC-19FEB21-52000-C",
        "info": null,
        "id": 61287,
        "equity": 3002.83270455,
        "currency": "BTC",
        "commission": 0,
        "change": 0,
        "cashflow": 0,
        "balance": 3003.17813712,
        "amount": 0.3
      }
    ],
    "continuation": 61282
  }
}

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

The following keywords can be used to filter the results: trade, maker, taker, open, close, liquidation, buy, sell, withdrawal, delivery, settlement, deposit, transfer, option, future, correction, block_trade, swap, expiry. Plus withdrawal or transfer addresses

Example:

"settlement"

count · integer

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

Required range: 1 <= x <= 250

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

Hide child attributes

result. continuation · integer · required

Continuation token for pagination. NULL when no continuation.

Example:

429946

result. logs · object[] · required

Hide child attributes

result.logs. id · integer · required

Unique identifier

Example:

5967413

result.logs. currency · enum<string> · required

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

Available options: BTC, ETH, USDC, USDT, EURR

result.logs. timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.logs. user_id · integer · required

Unique user identifier

Example:

57874

result.logs. commission · number · required

Commission paid so far (in base currency)

result.logs. cashflow · number · required

For futures and perpetual contracts: Realized session PNL (since last settlement). For options: the amount paid or received for the options traded.

result.logs. balance · number · required

Cash balance after the transaction

result.logs. change · number · required

Change in cash balance. For trades: fees and options premium paid/received. For settlement: Futures session PNL and perpetual session funding.

result.logs. user_seq · integer · required

Sequential identifier of user transaction

result.logs. type · string · required

Transaction category. The most common values are: trade, deposit, withdrawal, settlement, delivery, transfer, swap, correction, expiry, LSP transfer, LSP commission, ADL transfer, ADL commission. New types can be added at any time.

type is present on every log entry. It is not a substitute for role: both sides of an LSP or ADL position move use the same type (LSP transfer or ADL transfer). Which side this entry is on is role, when that field is present.

result.logs. username · string

System name or user defined subaccount alias

Example:

"MrTrader"

result.logs. role · enum<string>

Which side of a position move this log entry represents: source (the account the position is taken from) or destination (the account receiving the position).

Present only on LSP transfer, ADL transfer, liquidation transfer, and position move entries. Omitted on every other type, including LSP commission, ADL commission, trade, settlement, and transfer. Not the same as user_role (maker / taker) on trade entries.

Websocket liquidation notifications do not use this field; they distinguish sides with state (lsp_transfer / adl_transfer vs adl_transfer_received).

Available options: source, destination

result.logs. info · object

Additional information regarding transaction. Strongly dependent on the log entry type

result.logs. equity · number

Updated equity value after the transaction

result.logs. mark_price · number

Market price during the trade

result.logs. settlement_price · number

The settlement price for the instrument during the delivery

result.logs. index_price · number

The index price for the instrument during the delivery

result.logs. instrument_name · string

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.logs. position · number

Updated position size after the transaction

result.logs. side · string

One of: short or long in case of settlements, close sell or close buy in case of deliveries, open sell, open buy, close sell, close buy in case of trades

result.logs. amount · number

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

result.logs. price · number

Settlement/delivery price or the price level of the traded contracts

result.logs. price_currency · string

Currency symbol associated with the price field value

result.logs. trade_id · string

Unique (per currency) trade identifier

result.logs. order_id · string

Unique order identifier

Example:

"ETH-100234"

result.logs. user_role · enum<string>

Trade role of the user: maker or taker

Available options: maker, taker

result.logs. fee_role · enum<string>

Fee role of the user: maker or taker. Can be different from trade role of the user when iceberg order was involved in matching.

Available options: maker, taker

result.logs. profit_as_cashflow · boolean

Indicator informing whether the cashflow is waiting for settlement or not

result.logs. interest_pl · number

Funding PnL amount for the interval between this log entry and the previous trade or position change on perpetual instruments

result.logs. block_rfq_id · integer

ID of the Block RFQ - when trade was part of the Block RFQ

result.logs. ip · string

The IP address from which the trade was initiated

result.logs. starbase_match_id · integer

Starbase match id for trade entries executed in Starbase

result.logs. starbase_order_id · integer

Raw Starbase order id for trade entries associated with orders placed in Starbase

Example:

103148386170

result.logs. starbase_timestamp · integer

Starbase causal timestamp for trade entries executed in Starbase

Example:

1536569522277000000

result.logs. session_rpl · number

Realized profit and loss accrued in the current trading session (since the last daily settlement). Resets at each daily settlement.

Example:

0.1

result.logs. session_upl · number

Unrealized profit and loss on open positions in the current trading session (since the last daily settlement).

Example:

0.846863

result.logs. total_interest_pl · number

Total funding PnL accrued in the current trading session since the last daily settlement at 08:00 UTC, in the settlement currency. Resets at each daily settlement.

result.logs. contracts · number

It represents the order size in contract units. (Optional, may be absent in historical data).

id · integer

The id that was sent in the request