Package org.stellar.sdk.requests

Class TransactionsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.TransactionsRequestBuilder

public class TransactionsRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /transactions endpoint.

Retrieves transactions that have been included in validated ledgers, with optional filters by account, ledger, or liquidity pool.

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

Method Summary

Modifier and Type	Method	Description
TransactionsRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<TransactionResponse>	execute()	Build and execute request.
static Page<TransactionResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of TransactionResponse.
TransactionsRequestBuilder	forAccount(@NonNull String account)	Builds request to GET /accounts/{account}/transactions
TransactionsRequestBuilder	forClaimableBalance(@NonNull String claimableBalance)	Builds request to GET /claimable_balances/{claimable_balance_id}/transactions
TransactionsRequestBuilder	forLedger(long ledgerSeq)	Builds request to GET /ledgers/{ledgerSeq}/transactions
TransactionsRequestBuilder	forLiquidityPool(String liquidityPoolId)	Builds request to GET /liquidity_pools/{ledgerSeq}/transactions
TransactionsRequestBuilder	includeFailed(boolean value)	Adds a parameter defining whether to include failed transactions.
TransactionsRequestBuilder	limit(int number)	Sets limit parameter on the request.
TransactionsRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<TransactionResponse>	stream(EventListener<TransactionResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<TransactionResponse>	stream(EventListener<TransactionResponse> listener, long reconnectTimeout)	Allows to stream SSE events from horizon.
TransactionResponse	transaction(String transactionId)	Requests GET /transactions/{transactionId}
TransactionResponse	transaction(okhttp3.HttpUrl uri)	Requests specific uri and returns TransactionResponse.

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

TransactionsRequestBuilder

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

Method Details

transaction

public TransactionResponse transaction(okhttp3.HttpUrl uri)

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

Parameters:

uri - the Horizon URI to request

Returns:

TransactionResponse

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.

transaction

public TransactionResponse transaction(String transactionId)

Requests GET /transactions/{transactionId}

Parameters:

transactionId - Transaction to fetch

Returns:

TransactionResponse

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.

See Also:

• Transaction Details

forAccount

public TransactionsRequestBuilder forAccount(@NonNull
 @NonNull String account)

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

Parameters:

account - Account for which to get transactions

Returns:

this builder instance for chaining

See Also:

• Transactions for Account

forClaimableBalance

public TransactionsRequestBuilder forClaimableBalance(@NonNull
 @NonNull String claimableBalance)

Builds request to GET /claimable_balances/{claimable_balance_id}/transactions

Parameters:

claimableBalance - Claimable Balance for which to get transactions

Returns:

this builder instance for chaining

See Also:

• Transactions for ClaimableBalance

forLedger

public TransactionsRequestBuilder forLedger(long ledgerSeq)

Builds request to GET /ledgers/{ledgerSeq}/transactions

Parameters:

ledgerSeq - Ledger for which to get transactions

Returns:

this builder instance for chaining

See Also:

• Transactions for Ledger

forLiquidityPool

public TransactionsRequestBuilder forLiquidityPool(String liquidityPoolId)

Builds request to GET /liquidity_pools/{ledgerSeq}/transactions

Parameters:

liquidityPoolId - Liquidity pool for which to get transactions

Returns:

this builder instance for chaining

See Also:

• Transactions for Liquidity Pool

includeFailed

public TransactionsRequestBuilder includeFailed(boolean value)

Adds a parameter defining whether to include failed transactions. By default only successful transactions are returned.

Parameters:

value - Set to true to include failed transactions.

Returns:

this builder instance for chaining

execute

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

Requests specific uri and returns Page of TransactionResponse.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of TransactionResponse

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

Build and execute request.

Returns:

Page of TransactionResponse

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