Class OrdersApi

Hierarchy

  • OrdersApi
    • OrdersApi

Constructors

constructor

Properties

basePath axios configuration

Methods

cancelOrderV3 createOrderV3 getOrderV3 getSignableCancelOrderV3 getSignableOrder listOrdersV3

Constructors

constructor

  • new OrdersApi(configuration?, basePath?, axios?): OrdersApi

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns OrdersApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

cancelOrderV3

  • cancelOrderV3(requestParameters, options?): Promise<AxiosResponse<CancelOrderResponse, any>>

  • Cancel an order (V3)

    Parameters

    • requestParameters: OrdersApiCancelOrderV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CancelOrderResponse, any>>

    Summary

    Cancel an order (V3)

    Throws

    Memberof

    OrdersApi

createOrderV3

  • createOrderV3(requestParameters, options?): Promise<AxiosResponse<CreateOrderResponse, any>>

  • Create an order using the v3 orderbook.

    Parameters

    • requestParameters: OrdersApiCreateOrderV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateOrderResponse, any>>

    Summary

    Create an order (V3)

    Throws

    Memberof

    OrdersApi

getOrderV3

  • getOrderV3(requestParameters, options?): Promise<AxiosResponse<OrderV3, any>>

  • Get an order (V3)

    Parameters

    • requestParameters: OrdersApiGetOrderV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<OrderV3, any>>

    Summary

    Get an order (V3)

    Throws

    Memberof

    OrdersApi

getSignableCancelOrderV3

  • getSignableCancelOrderV3(requestParameters, options?): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>

  • Generate a signable cancel order message (V3)

    Parameters

    • requestParameters: OrdersApiGetSignableCancelOrderV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>

    Summary

    Generate a signable cancel order message (V3)

    Throws

    Memberof

    OrdersApi

getSignableOrder

  • getSignableOrder(requestParameters, options?): Promise<AxiosResponse<GetSignableOrderResponse, any>>

  • Generate a signable order request (V3)

    Parameters

    • requestParameters: OrdersApiGetSignableOrderRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableOrderResponse, any>>

    Summary

    Generate a signable order request (V3)

    Throws

    Memberof

    OrdersApi

listOrdersV3

  • listOrdersV3(requestParameters?, options?): Promise<AxiosResponse<ListOrdersResponseV3, any>>

  • Get a list of orders (V3)

    Parameters

    • OptionalrequestParameters: OrdersApiListOrdersV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListOrdersResponseV3, any>>

    Summary

    Get a list of orders (V3)

    Throws

    Memberof

    OrdersApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods