Interface IGetOpenOrdersParams

IGetOpenOrdersParams Interface representing the parameters for querying open orders.

Example

const getOpenOrdersParams: IGetOpenOrdersParams = {
  symbol: "PIXFI_IRT",
  side: "buy",
  state: "active",
  type: "limit",
  identifier: "order123",
  start: new Date("2024-01-01"),
  end: new Date("2024-12-31"),
  ids_in: ["id1", "id2"],
  identifiers_in: ["identifier1", "identifier2"],
  offset: 0,
  limit: 10
};
interface IGetOpenOrdersParams {
    end?: Date;
    identifier?: string;
    identifiers_in?: string[];
    ids_in?: string[];
    limit?: number;
    offset?: number;
    side?: OrderSide;
    start?: Date;
    state?: OrderState;
    symbol?: `${string}_IRT` | `${string}_USDT`;
    type?: OrderType;
}

Hierarchy (view full)

Properties

end? identifier? identifiers_in? ids_in? limit? offset? side? start? state? symbol? type?

Properties

Optionalend

end?: Date

Optional end date to filter the orders.

Optionalidentifier

identifier?: string

Optional identifier for the order to filter the orders.

Optionalidentifiers_in

identifiers_in?: string[]

Optional array of order identifiers to filter the orders.

Optionalids_in

ids_in?: string[]

Optional array of order IDs to filter the orders.

Optionallimit

limit?: number

The number of items to return.

Optionaloffset

offset?: number

The number of items to skip before starting to collect the result set.

Optionalside

side?: OrderSide

Optional side of the order (buy or sell) to filter the orders.

Optionalstart

start?: Date

Optional start date to filter the orders.

Optionalstate

state?: OrderState

Optional state of the order to filter the orders.

Optionalsymbol

symbol?: `${string}_IRT` | `${string}_USDT`

Optional symbol of the market to filter the orders.

Optionaltype

type?: OrderType

Optional type of the order (e.g., limit, market) to filter the orders.

Settings

Member Visibility

On This Page

Properties