Interface Order

An order on the O2 Exchange.

Example

const orders = await client.getOrders("fFUEL/fUSDC", tradeAccountId, true);
for (const order of orders) {
  console.log(`${order.side} ${order.quantity} @ ${order.price}`);
}
interface Order {
    account?: Identity;
    base_decimals?: number;
    cancel?: boolean;
    close: boolean;
    desired_quantity?: DesiredQuantity;
    fill?: unknown;
    fills?: unknown[];
    history?: unknown[];
    market_id?: MarketId;
    order_id: OrderId;
    order_tx_history?: unknown[];
    order_type: OrderType;
    owner?: Identity;
    partially_filled?: boolean;
    price: bigint;
    price_fill?: bigint;
    quantity: bigint;
    quantity_fill?: bigint;
    side: Side;
    timestamp: string | number;
}

Properties

account? base_decimals? cancel? close desired_quantity? fill? fills? history? market_id? order_id order_tx_history? order_type owner? partially_filled? price price_fill? quantity quantity_fill? side timestamp

Properties

Optionalaccount

account?: Identity

The account identity that placed the order.

Optionalbase_decimals

base_decimals?: number

Base asset decimals (for formatting).

Optionalcancel

cancel?: boolean

Whether the order has been cancelled.

close

close: boolean

Whether the order is closed (fully filled or cancelled).

Optionaldesired_quantity

desired_quantity?: DesiredQuantity

Originally desired quantity (underlying asset tracking).

Optionalfill

fill?: unknown

Fill information.

Optionalfills

fills?: unknown[]

Individual fill records.

Optionalhistory

history?: unknown[]

Order event history.

Optionalmarket_id

market_id?: MarketId

The market this order belongs to.

order_id

order_id: OrderId

Unique order identifier.

Optionalorder_tx_history

order_tx_history?: unknown[]

Transaction history for this order.

order_type

order_type: OrderType

Order type.

Optionalowner

owner?: Identity

The owner identity.

Optionalpartially_filled

partially_filled?: boolean

Whether the order has been partially filled.

price

price: bigint

Order price (chain integer).

Optionalprice_fill

price_fill?: bigint

Volume-weighted fill price.

quantity

quantity: bigint

Total quantity (chain integer).

Optionalquantity_fill

quantity_fill?: bigint

Filled quantity (chain integer).

side

side: Side

Order side.

timestamp

timestamp: string | number

Order creation timestamp.

Settings

Member Visibility

On This Page

Properties