@tatumio/tatum-v1/dist/src/model/response/ledger/OrderBook.d.ts

Tatum API client allows browsers and Node.js clients to interact with Tatum API.

import { TradeType } from '../../request/TradeType';
/**
 * Order Book Response
 */
export interface OrderBookResponse {
    /**
     * ID of the trade.
     * @type {string}
     * @memberof OrderBook
     */
    id: string;
    /**
     * Type of the trade, BUY or SELL.
     * @type {string}
     * @memberof OrderBook
     */
    type: TradeType;
    /**
     * Price to buy / sell.
     * @type {string}
     * @memberof OrderBook
     */
    price: string;
    /**
     * Amount of the trade to be bought / sold.
     * @type {string}
     * @memberof OrderBook
     */
    amount: string;
    /**
     * Trading pair.
     * @type {string}
     * @memberof OrderBook
     */
    pair: string;
    /**
     * How much of the trade was already filled.
     * @type {string}
     * @memberof OrderBook
     */
    fill: string;
    /**
     * ID of the account of the currency 1 trade currency.
     * @type {string}
     * @memberof OrderBook
     */
    currency1AccountId: string;
    /**
     * ID of the account of the currency 2 trade currency.
     * @type {string}
     * @memberof OrderBook
     */
    currency2AccountId: string;
    /**
     * Creation date, UTC millis.
     * @type {string}
     * @memberof OrderBook
     */
    created: number;
    /**
     * fee to be paid, as percentage.
     * @type {number}
     * @memberof OrderBook
     */
    fee?: number;
    /**
     * ID of the fee account of the currency 1 trade currency.
     * @type {string}
     * @memberof OrderBook
     */
    feeAccountId?: string;
}