Package 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	Description
TradesRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
TradesRequestBuilder	baseAsset(Asset asset)
TradesRequestBuilder	counterAsset(Asset asset)
TradesRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<TradeResponse>	execute()	Build and execute request.
static Page<TradeResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of TradeResponse.
TradesRequestBuilder	forAccount(@NonNull String account)	Builds request to GET /accounts/{account}/trades
TradesRequestBuilder	forLiquidityPool(String liquidityPoolId)	Builds request to GET /liquidity_pools/{poolID}/trades
TradesRequestBuilder	forTradeType(@NonNull String tradeType)	Returns all trades that of a specific type.
TradesRequestBuilder	limit(int number)	Sets limit parameter on the request.
TradesRequestBuilder	offerId(Long offerId)
SSEStream<TradeResponse>	stream(EventListener<TradeResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<TradeResponse>	stream(EventListener<TradeResponse> listener, long reconnectTimeout)	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 Details

TradesRequestBuilder

public TradesRequestBuilder(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl serverURI)

Method Details

baseAsset

public TradesRequestBuilder baseAsset(Asset asset)

counterAsset

public TradesRequestBuilder counterAsset(Asset asset)

forAccount

public TradesRequestBuilder forAccount(@NonNull
 @NonNull 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(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(@NonNull
 @NonNull 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(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl uri)

Requests specific uri and returns Page of TradeResponse.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of TradeResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

execute

public Page<TradeResponse> execute()

Build and execute request.

Returns:

Page of TradeResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

offerId

public TradesRequestBuilder offerId(Long offerId)

cursor

public TradesRequestBuilder cursor(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

Parameters:

token - A cursor is a value that points to a specific location in a collection of resources.

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,
 long reconnectTimeout)

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

reconnectTimeout - Custom stream connection timeout in ms

Returns:

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

See Also:

• Server-Sent Events
• Response Format documentation

stream

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

An overloaded version of stream(EventListener, long) with default reconnect timeout.