Class GridContext

Grid trading context.

Index

Constructors

Methods

new submit replace list listByIds detail triggerHistory cancel suspend restart symbolInfo

Constructors

constructor

new GridContext(): GridContext

Returns GridContext

Methods

`Static`new

new(config: Config): GridContext
Create a new GridContext.
Parameters
- config: Config
Returns GridContext

submit

submit(opts: SubmitGridOrderOptions): Promise<SubmitGridOrderResponse>
Submit a grid trading order
Parameters
- opts: SubmitGridOrderOptions
Returns Promise<SubmitGridOrderResponse>

replace

replace(opts: ReplaceGridOrderOptions): Promise<undefined>
Replace (modify) a grid trading order
Parameters
- opts: ReplaceGridOrderOptions
Returns Promise<undefined>

list

list(opts?: GetGridOrdersOptions | null): Promise<GridOrdersResponse>
Get grid trading orders (paged list)
Parameters
- Optionalopts: GetGridOrdersOptions | null
Returns Promise<GridOrdersResponse>

listByIds

listByIds(opts: GetGridOrdersByIdsOptions): Promise<GridOrder[]>
Query grid trading orders by IDs
Parameters
- opts: GetGridOrdersByIdsOptions
Returns Promise<GridOrder[]>

detail

detail(opts: GetGridOrderDetailOptions): Promise<GridOrderDetail>
Get grid trading order detail (and paged history)
Parameters
- opts: GetGridOrderDetailOptions
Returns Promise<GridOrderDetail>

triggerHistory

triggerHistory(
opts: GetGridTriggerHistoryOptions,
): Promise<GridTriggerHistoryResponse>
Get grid trading trigger history
Parameters
- opts: GetGridTriggerHistoryOptions
Returns Promise<GridTriggerHistoryResponse>

cancel

cancel(orderId: string): Promise<void>
Cancel a grid trading order
Parameters
- orderId: string
Returns Promise<void>

suspend

suspend(orderId: string): Promise<void>
Suspend a grid trading order
Parameters
- orderId: string
Returns Promise<void>

restart

restart(orderId: string): Promise<void>
Restart a grid trading order
Parameters
- orderId: string
Returns Promise<void>

symbolInfo

symbolInfo(symbol: string): Promise<GridSymbolInfo>
Get the security (symbol) info used to build a grid order (lot size, authorization flag, settlement currency, etc.).
Parameters
- symbol: string
Returns Promise<GridSymbolInfo>