get

suspend fun get(options: RequestOptions.AptosRequestOptions, apiType: AptosApiType = AptosApiType.FULLNODE): Result<AptosResponse, AptosSdkError>

Executes a GET request to an Aptos API endpoint using a configurable Ktor client.

This function does not throw exceptions for network or HTTP errors. Instead, it returns a Result object: Ok<AptosResponse> on success and Err<AptosNetworkException> on failure.

Usage

// Assuming `aptos` is your client instance
val options = RequestOptions.AptosRequestOptions(...)
val result = aptos.get(options)

when (result) {
is Ok -> println("Success! Status: ${result.value.status}")
is Err -> println("Failed! Reason: ${result.error.message}")
}

Return

A Result which is either Ok(AptosResponse) on success or Err(AptosNetworkException) on failure.

Parameters

options

The request configuration, including path, parameters, and client settings.

apiType

The type of Aptos API to target (e.g., FULLNODE, INDEXER).