Interface TradesApiInterface

TradesApi - interface

Export

TradesApi

interface TradesApiInterface {
    broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): AxiosPromise<Trade>;
    createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>;
    getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>;
    listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>;
}

Implemented by

Methods

broadcastTrade createTrade getTrade listTrades

Methods

broadcastTrade

  • broadcastTrade(walletId, addressId, tradeId, broadcastTradeRequest, options?): AxiosPromise<Trade>

  • 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 AxiosPromise<Trade>

    Summary

    Broadcast a trade

    Throws

    Memberof

    TradesApiInterface

createTrade

  • createTrade(walletId, addressId, createTradeRequest, options?): AxiosPromise<Trade>

  • 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 AxiosPromise<Trade>

    Summary

    Create a new trade for an address

    Throws

    Memberof

    TradesApiInterface

getTrade

  • getTrade(walletId, addressId, tradeId, options?): AxiosPromise<Trade>

  • 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 AxiosPromise<Trade>

    Summary

    Get a trade by ID

    Throws

    Memberof

    TradesApiInterface

listTrades

  • listTrades(walletId, addressId, limit?, page?, options?): AxiosPromise<TradeList>

  • 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 AxiosPromise<TradeList>

    Summary

    List trades for an address.

    Throws

    Memberof

    TradesApiInterface

Settings

Member Visibility

Theme

On This Page

broadcastTradecreateTradegetTradelistTrades