Class OrdersApi

Hierarchy

  • OrdersApi
    • OrdersApi

Constructors

constructor

Properties

basePath axios configuration

Methods

cancelOrderV3 createOrderV3 getOrderV3 getSignableCancelOrderV3 getSignableOrder listOrdersV3

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns OrdersApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

cancelOrderV3

  • Cancel an order (V3)

    Parameters

    • requestParameters: OrdersApiCancelOrderV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CancelOrderResponse, any>>

    Summary

    Cancel an order (V3)

    Throws

    Memberof

    OrdersApi

createOrderV3

  • Create an order using the v3 orderbook.

    Parameters

    • requestParameters: OrdersApiCreateOrderV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateOrderResponse, any>>

    Summary

    Create an order (V3)

    Throws

    Memberof

    OrdersApi

getOrderV3

  • Get an order (V3)

    Parameters

    • requestParameters: OrdersApiGetOrderV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<OrderV3, any>>

    Summary

    Get an order (V3)

    Throws

    Memberof

    OrdersApi

getSignableCancelOrderV3

  • Generate a signable cancel order message (V3)

    Parameters

    • requestParameters: OrdersApiGetSignableCancelOrderV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>

    Summary

    Generate a signable cancel order message (V3)

    Throws

    Memberof

    OrdersApi

getSignableOrder

  • Generate a signable order request (V3)

    Parameters

    • requestParameters: OrdersApiGetSignableOrderRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableOrderResponse, any>>

    Summary

    Generate a signable order request (V3)

    Throws

    Memberof

    OrdersApi

listOrdersV3

  • Get a list of orders (V3)

    Parameters

    • Optional requestParameters: OrdersApiListOrdersV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListOrdersResponseV3, any>>

    Summary

    Get a list of orders (V3)

    Throws

    Memberof

    OrdersApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc