AccountsRequestBuilder

class AccountsRequestBuilder(httpClient: HttpClient, serverUri: Url) : RequestBuilder

Builds requests connected to accounts.

See also

Constructors

Link copied to clipboard
constructor(httpClient: HttpClient, serverUri: Url)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
suspend fun account(accountId: String): AccountResponse

Requests a specific account by account ID.

Link copied to clipboard
suspend fun accountData(accountId: String, key: String): AccountDataResponse

Requests a specific data entry for an account.

Link copied to clipboard
open override fun cursor(cursor: String): AccountsRequestBuilder

Sets the 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.

Link copied to clipboard
suspend fun execute(): Page<AccountResponse>

Build and execute request.

Link copied to clipboard
fun forAsset(assetCode: String, assetIssuer: String): AccountsRequestBuilder

Returns all accounts who are trustees to a specific asset.

Link copied to clipboard

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

Link copied to clipboard

Returns all accounts that contain a specific signer.

Link copied to clipboard

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

Link copied to clipboard
open override fun limit(number: Int): AccountsRequestBuilder

Sets the limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Link copied to clipboard
open override fun order(direction: RequestBuilder.Order): AccountsRequestBuilder

Sets the order parameter on the request.

Link copied to clipboard
fun <T : Response> stream(serializer: KSerializer<T>, listener: EventListener<T>, reconnectTimeout: Duration = SSEStream.DEFAULT_RECONNECT_TIMEOUT): SSEStream<T>

Creates a Server-Sent Events (SSE) stream for this request. The stream will automatically reconnect on connection loss and resume from the last received event.