Interface RestRequestCancelOrdersByOrderIds

Allows cancelling all open orders by one or more orderId's or clientOrderId's.

See

request RestRequestCancelOrders

interface RestRequestCancelOrdersByOrderIds {
    nonce: string;
    wallet: string;
    orderIds: string[];
    delegatedKey?: string;
}

Hierarchy (view full)

Properties

nonce wallet orderIds delegatedKey?

Properties

nonce

nonce: string

User data and trade endpoints requests must include a nonce.

  • MUST be a version 1 UUID
  • Nonces may be supplied with or without hyphens.

Remarks

Version 1 UUIDs encode a timestamp in addition to other unique information, and thus serve both to prevent replay attacks as well as to enforce request timing. As a result, nonces MUST be generated at the time of a request.

wallet

wallet: string

The wallet address to use for the request.

Readonly orderIds

orderIds: string[]
  • When specified, cancels multiple orders by orderId or clientOrderId.
    • You may provide an orders orderId
    • You may provide an orders clientOrderId by prefixing it with client:

Throws

If orderIds array is empty

Optional delegatedKey

delegatedKey?: string

The delegated key to use for the request, if any.

Settings

Member Visibility

Theme

On This Page

noncewalletorderIdsdelegatedKey