stellar-sdk/com.soneso.stellar.sdk.horizon/HorizonServer

HorizonServer

class HorizonServer(serverUri: String, httpClient: HttpClient? = null, submitHttpClient: HttpClient? = null)

Main class used to connect to Horizon server.

This class provides factory methods for creating request builders to interact with various Horizon API endpoints.

Constructors

HorizonServer

constructor(serverUri: String, httpClient: HttpClient? = null, submitHttpClient: HttpClient? = null)

Types

Companion

object Companion

Properties

httpClient

val httpClient: HttpClient

The HTTP client used for general requests (30s timeout)

serverUri

val serverUri: Url

The URI of the Horizon server

submitHttpClient

val submitHttpClient: HttpClient

The HTTP client used for submitting transactions (65s timeout)

Functions

accounts

fun accounts(): AccountsRequestBuilder

Returns an AccountsRequestBuilder instance for querying accounts.

assets

fun assets(): AssetsRequestBuilder

Returns an AssetsRequestBuilder instance for querying assets.

claimableBalances

fun claimableBalances(): ClaimableBalancesRequestBuilder

Returns a ClaimableBalancesRequestBuilder instance for querying claimable balances.

fun close()

Closes the HTTP clients and releases resources. Call this when you're done using the HorizonServer instance.

effects

fun effects(): EffectsRequestBuilder

Returns an EffectsRequestBuilder instance for querying effects.

feeStats

fun feeStats(): FeeStatsRequestBuilder

Returns a FeeStatsRequestBuilder instance for querying fee statistics.

health

fun health(): HealthRequestBuilder

Returns a HealthRequestBuilder instance for querying server health status.

ledgers

fun ledgers(): LedgersRequestBuilder

Returns a LedgersRequestBuilder instance for querying ledgers.

liquidityPools

fun liquidityPools(): LiquidityPoolsRequestBuilder

Returns a LiquidityPoolsRequestBuilder instance for querying liquidity pools.

loadAccount

suspend fun loadAccount(address: String): Account

Loads an account from Horizon and returns it as a TransactionBuilderAccount.

offers

fun offers(): OffersRequestBuilder

Returns an OffersRequestBuilder instance for querying offers.

operations

fun operations(): OperationsRequestBuilder

Returns an OperationsRequestBuilder instance for querying operations.

orderBook

fun orderBook(): OrderBookRequestBuilder

Returns an OrderBookRequestBuilder instance for querying order books.

payments

fun payments(): PaymentsRequestBuilder

Returns a PaymentsRequestBuilder instance for querying payment operations.

root

fun root(): RootRequestBuilder

Returns a RootRequestBuilder instance for querying server and network information.

strictReceivePaths

fun strictReceivePaths(): StrictReceivePathsRequestBuilder

Returns a StrictReceivePathsRequestBuilder instance for finding payment paths with strict receive.

strictSendPaths

fun strictSendPaths(): StrictSendPathsRequestBuilder

Returns a StrictSendPathsRequestBuilder instance for finding payment paths with strict send.

submitTransaction

suspend fun submitTransaction(transactionEnvelopeXdr: String): TransactionResponse

Submits a transaction to the Stellar network.

suspend fun submitTransaction(transactionEnvelopeXdr: String, skipMemoRequiredCheck: Boolean): TransactionResponse

Submits a transaction to the Stellar network with optional memo required check.

submitTransactionAsync

suspend fun submitTransactionAsync(transactionEnvelopeXdr: String): SubmitTransactionAsyncResponse

Submits a transaction to the Stellar network asynchronously.

suspend fun submitTransactionAsync(transactionEnvelopeXdr: String, skipMemoRequiredCheck: Boolean): SubmitTransactionAsyncResponse

Submits a transaction to the Stellar network asynchronously with optional memo required check.

tradeAggregations

fun tradeAggregations(baseAssetType: String, baseAssetCode: String?, baseAssetIssuer: String?, counterAssetType: String, counterAssetCode: String?, counterAssetIssuer: String?, startTime: Long, endTime: Long, resolution: Long, offset: Long = 0): TradeAggregationsRequestBuilder

Returns a TradeAggregationsRequestBuilder instance for querying trade aggregations.

trades

fun trades(): TradesRequestBuilder

Returns a TradesRequestBuilder instance for querying trades.

transactions

fun transactions(): TransactionsRequestBuilder

Returns a TransactionsRequestBuilder instance for querying transactions.