Package org.stellar.sdk.requests

Class OffersRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.OffersRequestBuilder

public class OffersRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /offers endpoint.

Retrieves offers currently on the Stellar DEX order books, with optional filters by seller, sponsor, or asset pair.

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

Method Summary

Modifier and Type	Method	Description
OffersRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<OfferResponse>	execute()	Build and execute request.
static Page<OfferResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of OfferResponse.
OffersRequestBuilder	forBuyingAsset(Asset asset)	Returns all offers buying an asset.
OffersRequestBuilder	forSeller(String seller)	Returns all offers where the given account is the seller.
OffersRequestBuilder	forSellingAsset(Asset asset)	Returns all offers selling an asset.
OffersRequestBuilder	forSponsor(String sponsor)	Returns all offers sponsored by a given account.
OffersRequestBuilder	limit(int number)	Sets limit parameter on the request.
OfferResponse	offer(long offerId)	The offer details endpoint provides information on a single offer.
OfferResponse	offer(okhttp3.HttpUrl uri)	Requests specific uri and returns OfferResponse.
OffersRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<OfferResponse>	stream(EventListener<OfferResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<OfferResponse>	stream(EventListener<OfferResponse> 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

OffersRequestBuilder

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

Method Details

offer

public OfferResponse offer(okhttp3.HttpUrl uri)

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

Parameters:

uri - the Horizon URI to request

Returns:

OfferResponse

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.

offer

public OfferResponse offer(long offerId)

The offer details endpoint provides information on a single offer.

Parameters:

offerId - specifies which offer to load.

Returns:

OfferResponse

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.

forSponsor

public OffersRequestBuilder forSponsor(String sponsor)

Returns all offers sponsored by a given account.

Parameters:

sponsor - Account ID of the sponsor.

Returns:

current OffersRequestBuilder instance

See Also:

• Offers

forSeller

public OffersRequestBuilder forSeller(String seller)

Returns all offers where the given account is the seller.

Parameters:

seller - Account ID of the offer creator.

Returns:

current OffersRequestBuilder instance

See Also:

• Offers

forBuyingAsset

public OffersRequestBuilder forBuyingAsset(Asset asset)

Returns all offers buying an asset.

Parameters:

asset - The Asset being bought.

Returns:

current OffersRequestBuilder instance

See Also:

• Offers

forSellingAsset

public OffersRequestBuilder forSellingAsset(Asset asset)

Returns all offers selling an asset.

Parameters:

asset - The Asset being sold.

Returns:

current OffersRequestBuilder instance

See Also:

• Offers

execute

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

Requests specific uri and returns Page of OfferResponse. 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 OfferResponse

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<OfferResponse> stream(EventListener<OfferResponse> 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 OfferResponse 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<OfferResponse> stream(EventListener<OfferResponse> 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<OfferResponse> execute()

Build and execute request.

Returns:

Page of OfferResponse

Throws:

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

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

cursor

public OffersRequestBuilder 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 OffersRequestBuilder 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 OffersRequestBuilder 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