Class TradesApi

Hierarchy

  • TradesApi
    • TradesApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createTradeV3 getSignableTrade getTradeV3 listTradesV3

Constructors

constructor

  • Parameters

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

    Returns x.TradesApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

createTradeV3

  • Create a Trade.

    Parameters

    • requestParameters: TradesApiCreateTradeV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateTradeResponse, any>>

    Summary

    Create a Trade (V3)

    Throws

    Memberof

    TradesApi

getSignableTrade

  • Generate a signable trade message (V3)

    Parameters

    • requestParameters: TradesApiGetSignableTradeRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTradeResponse, any>>

    Summary

    Generate a signable trade message (V3)

    Throws

    Memberof

    TradesApi

getTradeV3

  • Get details of a trade with the given ID

    Parameters

    • requestParameters: TradesApiGetTradeV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Get details of a trade with the given ID

    Throws

    Memberof

    TradesApi

listTradesV3

  • Get a list of trades (V3)

    Parameters

    • Optional requestParameters: TradesApiListTradesV3Request

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListTradesResponse, any>>

    Summary

    Get a list of trades (V3)

    Throws

    Memberof

    TradesApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc