Package org.stellar.sdk.requests

Class OrderBookRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.OrderBookRequestBuilder

public class OrderBookRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /order_book endpoint.

Retrieves bids and asks for a given asset pair from the Stellar DEX order book. Both buying and selling assets must be specified.

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

Method Summary

Modifier and Type	Method	Description
OrderBookRequestBuilder	buyingAsset(Asset asset)	Sets the asset being bought (i.e.
RequestBuilder	cursor(String cursor)	Sets cursor parameter on the request.
OrderBookResponse	execute()	Build and execute request.
static OrderBookResponse	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns OrderBookResponse.
RequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
OrderBookRequestBuilder	sellingAsset(Asset asset)	Sets the asset being sold (i.e.
SSEStream<OrderBookResponse>	stream(EventListener<OrderBookResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<OrderBookResponse>	stream(EventListener<OrderBookResponse> listener, long reconnectTimeout)	Allows to stream SSE events from horizon.

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

limit, setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Details

OrderBookRequestBuilder

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

Method Details

buyingAsset

public OrderBookRequestBuilder buyingAsset(Asset asset)

Sets the asset being bought (i.e. the counter asset in the order book).

Parameters:

asset - the buying asset

Returns:

this builder instance for chaining

sellingAsset

public OrderBookRequestBuilder sellingAsset(Asset asset)

Sets the asset being sold (i.e. the base asset in the order book).

Parameters:

asset - the selling asset

Returns:

this builder instance for chaining

execute

public static OrderBookResponse execute(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl uri)

Requests specific uri and returns OrderBookResponse.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

OrderBookResponse

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<OrderBookResponse> stream(EventListener<OrderBookResponse> 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 - OrderBookResponse implementation with OrderBookResponse 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<OrderBookResponse> stream(EventListener<OrderBookResponse> 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 OrderBookResponse execute()

Build and execute request.

Returns:

OrderBookResponse

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 RequestBuilder cursor(String cursor)

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:

cursor - 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

order

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