Class TradesApi

TradesApi - object-oriented interface

Export

TradesApi

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

broadcastTrade createTrade getTrade listTrades

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastTrade

  • broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<AxiosResponse<Trade, any>>

  • Broadcast a trade

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the trade belongs to

    • tradeId: string

      The ID of the trade to broadcast

    • broadcastTradeRequest: BroadcastTradeRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApi

createTrade

  • createTrade(walletId, addressId, createTradeRequest, options?): Promise<AxiosResponse<Trade, any>>

  • Create a new trade

    Parameters

    • walletId: string

      The ID of the wallet the source address belongs to

    • addressId: string

      The ID of the address to conduct the trade from

    • createTradeRequest: CreateTradeRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Create a new trade for an address

    Throws

    Memberof

    TradesApi

getTrade

  • getTrade(walletId, addressId, tradeId, options?): Promise<AxiosResponse<Trade, any>>

  • Get a trade by ID

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address the trade belongs to

    • tradeId: string

      The ID of the trade to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Trade, any>>

    Summary

    Get a trade by ID

    Throws

    Memberof

    TradesApi

listTrades

  • listTrades(walletId, addressId, limit?, page?, options?): Promise<AxiosResponse<TradeList, any>>

  • List trades for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to

    • addressId: string

      The ID of the address to list trades for

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TradeList, any>>

    Summary

    List trades for an address.

    Throws

    Memberof

    TradesApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastTradecreateTradegetTradelistTrades