Order

The Order type represents the details and status of a trading order.

interface Order {
  base_ticker: string;
  base_ticker_display: string;
  id: string;
  order_amount: string | null;
  order_filled: string;
  order_total: string | null;
  order_type: OrderType;
  price: string | null;
  quote_ticker: string;
  quote_ticker_display: string;
  request_amount: string;
  status: OrderStatus;
  symbol: string;
  time: number;
  traded_base_amount: string;
  traded_quote_amount: string;
  tx_list: {
    status: TransactionStatus;
    time: number;
    txhash: string;
  }[];
}

Properties

• base_ticker: string

  • A ticker of the base token.

  • It is a combination of a base symbol, an underscore, and a chain symbol.

  • E.g., ETH_ETHSEPOLIA

• base_ticker_display: string

  • A symbol of the base token.

• id: string

  • An order ID.

• order_amount: string | null

  • The amount of base token to trade.

  • null if the order is a market total order.

• order_filled: string

  • A percentage of how much the order is filled.

• order_total: string | null

  • The amount of quote token to fulfill the order.

  • null if the order is a market amount order.

• order_type: OrderType

  • An order type.

• price: string | null

  • The price at which the order is placed.

  • null if the order is a market order.

• quote_ticker: string

  • A ticker of the quote token.

  • It is a combination of a quote symbol, an underscore, and a chain symbol.

  • E.g., USDT_ETHSEPOLIA

• quote_ticker_display: string

  • A symbol of the quote token.

• request_amount: string

  • Matches order_total for market total orders.

  • Matches order_amount for all other order types.

• status: OrderStatus

  • An order status.

• symbol: string

  • A market symbol.

  • It is a combination of a base ticker, a colon, and a quote ticker.

  • E.g., ETH_ETHSEPOLIA:USDT_ETHSEPOLIA

• time: number

  • The timestamp of the order creation, expressed in seconds.

• traded_base_amount: string

  • The amount of the base token that has been traded.

• traded_quote_amount: string

  • The amount of the quote token that has been traded.

• tx_list

  • status: TransactionStatus

    • A transaction status.

  • time: number

    • The timestamp of the transaction creation, expressed in seconds.

  • txhash: string

    • A transaction hash.