• TradesApi - axios parameter creator

    Parameters

    Returns {
        broadcastTrade: ((walletId, addressId, tradeId, broadcastTradeRequest, options?) => Promise<RequestArgs>);
        createTrade: ((walletId, addressId, createTradeRequest, options?) => Promise<RequestArgs>);
        getTrade: ((walletId, addressId, tradeId, options?) => Promise<RequestArgs>);
        listTrades: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>);
    }

    • broadcastTrade: ((walletId, addressId, tradeId, broadcastTradeRequest, options?) => Promise<RequestArgs>)

      Broadcast a trade

      Summary

      Broadcast a trade

      Throws

        • (walletId, addressId, tradeId, broadcastTradeRequest, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • createTrade: ((walletId, addressId, createTradeRequest, options?) => Promise<RequestArgs>)

      Create a new trade

      Summary

      Create a new trade for an address

      Throws

        • (walletId, addressId, createTradeRequest, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • getTrade: ((walletId, addressId, tradeId, options?) => Promise<RequestArgs>)

      Get a trade by ID

      Summary

      Get a trade by ID

      Throws

        • (walletId, addressId, tradeId, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • listTrades: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>)

      List trades for an address.

      Summary

      List trades for an address.

      Throws

        • (walletId, addressId, limit?, page?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    Export