org.stellar.sdk.requests

Class TradesRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.TradesRequestBuilder

public class TradesRequestBuilder
extends RequestBuilder

Builds requests connected to trades.

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor and Description
TradesRequestBuilder(OkHttpClient httpClient, HttpUrl serverURI)

Method Summary

Modifier and Type	Method and Description
TradesRequestBuilder	baseAsset(Asset asset)
TradesRequestBuilder	counterAsset(Asset asset)
TradesRequestBuilder	cursor(java.lang.String token) Sets cursor parameter on the request.
Page<TradeResponse>	execute()
static Page<TradeResponse>	execute(OkHttpClient httpClient, HttpUrl uri)
TradesRequestBuilder	forAccount(java.lang.String account) Builds request to GET /accounts/{account}/trades
TradesRequestBuilder	forLiquidityPool(LiquidityPoolID liquidityPoolID) Builds request to GET /liquidity_pools/{poolID}/trades
TradesRequestBuilder	forLiquidityPool(java.lang.String liquidityPoolID) Builds request to GET /liquidity_pools/{poolID}/trades
TradesRequestBuilder	forTradeType(java.lang.String tradeType) Returns all trades that of a specific type.
TradesRequestBuilder	limit(int number) Sets limit parameter on the request.
TradesRequestBuilder	offerId(java.lang.Long offerId)
SSEStream<TradeResponse>	stream(EventListener<TradeResponse> listener) Allows to stream SSE events from horizon.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

order, setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TradesRequestBuilder

public TradesRequestBuilder(OkHttpClient httpClient,
                            HttpUrl serverURI)

Method Detail

baseAsset

public TradesRequestBuilder baseAsset(Asset asset)

counterAsset

public TradesRequestBuilder counterAsset(Asset asset)

forAccount

public TradesRequestBuilder forAccount(java.lang.String account)

Builds request to GET /accounts/{account}/trades

Parameters:

account - Account for which to get trades

See Also:

Trades for Account

forLiquidityPool

public TradesRequestBuilder forLiquidityPool(LiquidityPoolID liquidityPoolID)

Builds request to GET /liquidity_pools/{poolID}/trades

Parameters:

liquidityPoolID - Liquidity pool for which to get trades

See Also:

Trades for Liquidity Pool

forLiquidityPool

public TradesRequestBuilder forLiquidityPool(java.lang.String liquidityPoolID)

Builds request to GET /liquidity_pools/{poolID}/trades

Parameters:

liquidityPoolID - Liquidity pool for which to get trades

See Also:

Trades for Liquidity Pool

forTradeType

public TradesRequestBuilder forTradeType(java.lang.String tradeType)

Returns all trades that of a specific type.

Parameters:

tradeType - type

Returns:

current TradesRequestBuilder instance

See Also:

List All Trades

execute

public static Page<TradeResponse> execute(OkHttpClient httpClient,
                                          HttpUrl uri)
                                   throws java.io.IOException,
                                          TooManyRequestsException

Throws:

java.io.IOException

TooManyRequestsException

execute

public Page<TradeResponse> execute()
                            throws java.io.IOException,
                                   TooManyRequestsException

Throws:

java.io.IOException

TooManyRequestsException

offerId

public TradesRequestBuilder offerId(java.lang.Long offerId)

cursor

public TradesRequestBuilder cursor(java.lang.String token)

Description copied from class: RequestBuilder

Sets cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Overrides:

cursor in class RequestBuilder

See Also:

Page documentation

limit

public TradesRequestBuilder limit(int number)

Description copied from class: RequestBuilder

Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Overrides:

limit in class RequestBuilder

Parameters:

number - maxium number of records to return

stream

public SSEStream<TradeResponse> stream(EventListener<TradeResponse> listener)

Allows to stream SSE events from horizon. Certain endpoints in Horizon can be called in streaming mode using Server-Sent Events. This mode will keep the connection to horizon open and horizon will continue to return responses as ledgers close.

Parameters:

listener - EventListener implementation with TradeResponse type

Returns:

EventSource object, so you can close() connection when not needed anymore

See Also:

Server-Sent Events, Response Format documentation