ftx-api-typed/lib/types/rest/response/orders.d.ts

Node.js/typescript connector for FTX's REST APIs and WebSockets

export declare type OrderStatus = "new" | "open" | "closed";
export interface Order {
    createdAt: string;
    filledSize: number;
    future: string;
    id: number;
    market: string;
    price: number;
    avgFillPrice: number;
    remainingSize: number;
    status: OrderStatus;
    side: string;
    size: number;
    type: string;
    reduceOnly: boolean;
    ioc: boolean;
    postOnly: boolean;
    clientId?: string | null;
}
export declare type OpenOrders = Array<Order>;
export declare type OrderHistory = Array<Order>;
export declare type OrderSide = 'buy' | 'sell';
export declare type OrderType = 'market' | 'limit';
export declare type ConditionalOrderType = 'stop' | 'trailing_stop' | 'take_profit';
export declare type ConditionalOrderTypeNoUnderscore = 'stop' | 'trailingStop' | 'takeProfit';
export declare type TriggerOrderStatus = "open" | "cancelled" | "triggered";
export interface TriggerOrder {
    createdAt: string;
    /** @deprecated */
    error: string | null;
    future: string;
    id: number;
    market: string;
    /** @deprecated */
    orderId: number;
    orderPrice: number | null;
    reduceOnly: boolean;
    side: OrderSide;
    size: number;
    /** @description always "open" */
    trailStart: number | null;
    trailValue: number | null;
    triggerPrice: number;
    triggeredAt: string | null;
    type: ConditionalOrderType;
    orderType: OrderType;
    filledSize: number;
    avgFillPrice: number | null;
    retryUntilFilled: boolean;
    status: TriggerOrderStatus;
}
export interface OpenTriggerOrder extends TriggerOrder {
    /** @description always "open" */
    status: "open";
}
export declare type OpenTriggerOrders = Array<OpenTriggerOrder>;
export interface ConditionalOrderTrigger {
    time: string;
    orderSize: number | null;
    filledSize: number | null;
    orderId: number | null;
    error: string | null;
}
export declare type ConditionalOrderTriggers = Array<ConditionalOrderTrigger>;
export interface TriggerOrderHistoryItem extends Order {
    /** @deprecated */
    error?: any;
    /** @deprecated */
    orderId: number;
    orderPrice: number | null;
    trailStart: number | null;
    trailValue: number | null;
    triggerPrice: number;
    triggeredAt: string;
    orderType: OrderType;
    /** @deprecated */
    orderStatus: OrderStatus;
    retryUntilFilled: boolean;
}
export declare type TriggerOrderHistory = Array<TriggerOrderHistoryItem>;