Package org.stellar.sdk.requests

Class LiquidityPoolsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.LiquidityPoolsRequestBuilder

public class LiquidityPoolsRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /liquidity_pools endpoint.

Retrieves liquidity pools on the Stellar network, with optional filters by reserves or participating account.

See Also:

• Horizon API reference

Nested Class Summary

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

RequestBuilder.Order

Constructor Summary

Constructors

Constructor	Description
LiquidityPoolsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
LiquidityPoolsRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<LiquidityPoolResponse>	execute()	Build and execute request.
static Page<LiquidityPoolResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of LiquidityPoolResponse.
LiquidityPoolsRequestBuilder	forAccount(String account)	Returns all liquidity pools the specified account is participating in.
LiquidityPoolsRequestBuilder	forReserves(String... reserves)	Returns all liquidity pools that contain reserves in all specified assets.
LiquidityPoolsRequestBuilder	limit(int number)	Sets limit parameter on the request.
LiquidityPoolResponse	liquidityPool(String liquidityPoolId)	Requests GET /liquidity_pools/{liquidity_pool_id}
LiquidityPoolResponse	liquidityPool(okhttp3.HttpUrl uri)	Requests specific uri and returns LiquidityPoolResponse.
LiquidityPoolsRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<LiquidityPoolResponse>	stream(EventListener<LiquidityPoolResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<LiquidityPoolResponse>	stream(EventListener<LiquidityPoolResponse> listener, long reconnectTimeout)	Allows to stream SSE events from horizon.

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

setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Details

LiquidityPoolsRequestBuilder

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

Method Details

liquidityPool

public LiquidityPoolResponse liquidityPool(okhttp3.HttpUrl uri)

Requests specific uri and returns LiquidityPoolResponse. This method is helpful for getting the links.

Parameters:

uri - the Horizon URI to request

Returns:

LiquidityPoolResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

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.

liquidityPool

public LiquidityPoolResponse liquidityPool(String liquidityPoolId)

Requests GET /liquidity_pools/{liquidity_pool_id}

Parameters:

liquidityPoolId - Liquidity Pool to fetch

Returns:

LiquidityPoolResponse

Throws:

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)

ConnectionErrorException - if the request fails due to an IOException, including but not limited to a timeout, connection failure etc.

TooManyRequestsException - when too many requests were sent to the Horizon server.

See Also:

• Liquidity Pool Details

forReserves

public LiquidityPoolsRequestBuilder forReserves(String... reserves)

Returns all liquidity pools that contain reserves in all specified assets.

Parameters:

reserves - Reserve assets to filter liquidity pools

Returns:

current LiquidityPoolsRequestBuilder instance

See Also:

• LiquidityPools

forAccount

public LiquidityPoolsRequestBuilder forAccount(String account)

Returns all liquidity pools the specified account is participating in.

Parameters:

account - Account ID to filter liquidity pools

Returns:

current LiquidityPoolsRequestBuilder instance

See Also:

• LiquidityPools

execute

public static Page<LiquidityPoolResponse> execute(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl uri)

Requests specific uri and returns Page of LiquidityPoolResponse. This method is helpful for getting the next set of results.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of LiquidityPoolResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

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.

stream

public SSEStream<LiquidityPoolResponse> stream(EventListener<LiquidityPoolResponse> 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 LiquidityPoolResponse 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<LiquidityPoolResponse> stream(EventListener<LiquidityPoolResponse> listener)

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

Parameters:

listener - the event listener to receive events

Returns:

an SSEStream for real-time event streaming

execute

public Page<LiquidityPoolResponse> execute()

Build and execute request. Warning! LiquidityPoolResponses in Page will contain only keypair field.

Returns:

Page of LiquidityPoolResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

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.

cursor

public LiquidityPoolsRequestBuilder 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.

Returns:

this builder instance for chaining

See Also:

• Page documentation

limit

public LiquidityPoolsRequestBuilder 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 - maximum number of records to return

Returns:

this builder instance for chaining

order

public LiquidityPoolsRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order

Returns:

this builder instance for chaining