Package org.stellar.sdk.requests

Class AccountsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.AccountsRequestBuilder

public class AccountsRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /accounts endpoint.

Retrieves accounts on the Stellar network, with optional filters by signer, asset, liquidity pool, or sponsor.

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

Method Summary

Modifier and Type	Method	Description
AccountResponse	account(String account)	Requests GET /accounts/{account}
AccountResponse	account(okhttp3.HttpUrl uri)	Requests specific uri and returns AccountResponse.
AccountsRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<AccountResponse>	execute()	Build and execute request.
static Page<AccountResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of AccountResponse.
AccountsRequestBuilder	forAsset(AssetTypeCreditAlphaNum asset)	Returns all accounts who are trustees to a specific asset.
AccountsRequestBuilder	forLiquidityPool(String liquidityPoolId)	Returns all accounts who have trustlines to the specified liquidity pool.
AccountsRequestBuilder	forSigner(String signer)	Returns all accounts that contain a specific signer.
AccountsRequestBuilder	forSponsor(String sponsor)	Returns all accounts who are sponsored by a given account or have subentries which are sponsored by a given account.
AccountsRequestBuilder	limit(int number)	Sets limit parameter on the request.
AccountsRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<AccountResponse>	stream(EventListener<AccountResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<AccountResponse>	stream(EventListener<AccountResponse> 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

AccountsRequestBuilder

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

Method Details

account

public AccountResponse account(okhttp3.HttpUrl uri)

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

Parameters:

uri - the Horizon URI to request

Returns:

the AccountResponse

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.

account

public AccountResponse account(String account)

Requests GET /accounts/{account}

Parameters:

account - Account to fetch

Returns:

the AccountResponse

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:

• Account Details

forSigner

public AccountsRequestBuilder forSigner(String signer)

Returns all accounts that contain a specific signer.

Parameters:

signer - Account ID

Returns:

current AccountsRequestBuilder instance

See Also:

• Accounts

forAsset

public AccountsRequestBuilder forAsset(AssetTypeCreditAlphaNum asset)

Returns all accounts who are trustees to a specific asset.

Parameters:

asset - An issued asset

Returns:

current AccountsRequestBuilder instance

See Also:

• Accounts

forLiquidityPool

public AccountsRequestBuilder forLiquidityPool(String liquidityPoolId)

Returns all accounts who have trustlines to the specified liquidity pool.

Parameters:

liquidityPoolId - Liquidity Pool ID

Returns:

current AccountsRequestBuilder instance

See Also:

• Accounts

forSponsor

public AccountsRequestBuilder forSponsor(String sponsor)

Returns all accounts who are sponsored by a given account or have subentries which are sponsored by a given account.

Parameters:

sponsor - Account ID

Returns:

current AccountsRequestBuilder instance

See Also:

• Accounts

execute

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

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

Parameters:

httpClient - the OkHttpClient to use

uri - the Horizon URI to request

Returns:

Page of AccountResponse

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

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

Returns:

Page of AccountResponse

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