Class TradesApi

Hierarchy

  • TradesApi
    • TradesApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createTradeV3 getSignableTrade getTradeV3 listTradesV3

Constructors

constructor

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

  • Parameters

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

    Returns TradesApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

createTradeV3

  • createTradeV3(requestParameters, options?): Promise<AxiosResponse<CreateTradeResponse, any>>

  • Create a Trade.

    Parameters

    • requestParameters: TradesApiCreateTradeV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreateTradeResponse, any>>

    Summary

    Create a Trade (V3)

    Throws

    Memberof

    TradesApi

getSignableTrade

  • getSignableTrade(requestParameters, options?): Promise<AxiosResponse<GetSignableTradeResponse, any>>

  • Generate a signable trade message (V3)

    Parameters

    • requestParameters: TradesApiGetSignableTradeRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableTradeResponse, any>>

    Summary

    Generate a signable trade message (V3)

    Throws

    Memberof

    TradesApi

getTradeV3

  • getTradeV3(requestParameters, options?): Promise<AxiosResponse<Trade, any>>

  • Get details of a trade with the given ID

    Parameters

    • requestParameters: TradesApiGetTradeV3Request

      Request parameters.

    • Optionaloptions: 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

  • listTradesV3(requestParameters?, options?): Promise<AxiosResponse<ListTradesResponse, any>>

  • Get a list of trades (V3)

    Parameters

    • OptionalrequestParameters: TradesApiListTradesV3Request

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListTradesResponse, any>>

    Summary

    Get a list of trades (V3)

    Throws

    Memberof

    TradesApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods