Struct TransactionLogEntry 

pub struct TransactionLogEntry {

    pub id: u64,
    pub currency: String,
    pub amount: Option<f64>,
    pub balance: f64,
    pub timestamp: u64,
    pub transaction_type: String,
    pub info: Option<Value>,
    pub change: f64,
    pub cashflow: f64,
    pub user_id: u64,
    pub trade_id: Option<String>,
    pub order_id: Option<String>,
    pub position: Option<f64>,
    pub side: Option<TransactionSide>,
    pub contracts: Option<f64>,
    pub interest_pl: Option<f64>,
    pub user_role: Option<UserRole>,
    pub fee_role: Option<String>,
    pub index_price: Option<f64>,
    pub price: Option<f64>,
    pub user_seq: u64,
    pub settlement_price: Option<f64>,
    pub price_currency: Option<String>,
    pub equity: f64,
    pub total_interest_pl: Option<f64>,
    pub session_upl: Option<f64>,
    pub profit_as_cashflow: Option<bool>,
    pub commission: Option<f64>,
    pub session_rpl: Option<f64>,
    pub mark_price: Option<f64>,
    pub block_rfq_id: Option<u64>,
    pub ip: Option<String>,
    pub username: String,
    pub instrument_name: Option<String>,
}

Generic transaction log entry

Fields

id: u64

Unique identifier

currency: String

Currency, i.e “BTC”, “ETH”, “USDC”

amount: Option<f64>

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.

balance: f64

Cash balance after the transaction

timestamp: u64

The timestamp (milliseconds since the Unix epoch)

transaction_type: String

Transaction category/type. Common types: trade, deposit, withdrawal, settlement, delivery, transfer, swap, correction

info: Option<Value>

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

change: f64

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

cashflow: f64

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

user_id: u64

Unique user identifier

trade_id: Option<String>

Unique (per currency) trade identifier

order_id: Option<String>

Unique order identifier

position: Option<f64>

Updated position size after the transaction

side: Option<TransactionSide>

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

contracts: Option<f64>

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

interest_pl: Option<f64>

Actual funding rate of trades and settlements on perpetual instruments

user_role: Option<UserRole>

Trade role of the user: maker or taker

fee_role: Option<String>

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

index_price: Option<f64>

The index price for the instrument during the delivery

price: Option<f64>

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

user_seq: u64

Sequential identifier of user transaction

settlement_price: Option<f64>

The settlement price for the instrument during the delivery

price_currency: Option<String>

Currency symbol associated with the price field value

equity: f64

Updated equity value after the transaction

total_interest_pl: Option<f64>

Total session funding rate

session_upl: Option<f64>

Session unrealized profit and loss

profit_as_cashflow: Option<bool>

Indicator informing whether the cashflow is waiting for settlement or not

commission: Option<f64>

Commission paid so far (in base currency)

session_rpl: Option<f64>

Session realized profit and loss

mark_price: Option<f64>

Market price during the trade

block_rfq_id: Option<u64>

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

ip: Option<String>

The IP address from which the trade was initiated

username: String

System name or user defined subaccount alias

instrument_name: Option<String>

Unique instrument identifier

Trait Implementations

impl Clone for TransactionLogEntry

fn clone(&self) -> TransactionLogEntry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransactionLogEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionLogEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionLogEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for TransactionLogEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.