Stellar PHP SDK API Documentation

LedgersRequestBuilder extends RequestBuilder
in package

Soneso

StellarSDK

Requests

Builds requests for the ledgers endpoint in Horizon

This class provides methods to query ledgers on the Stellar network. Ledgers represent the state of the Stellar universe at a specific point in time. They close approximately every 5 seconds and contain all transactions, operations, and effects that occurred during that period.

Query Methods:

ledger(): Fetch a single ledger by sequence number
stream(): Stream ledgers in real-time as they close

Ledgers are the fundamental unit of time in Stellar and are essential for understanding the network's history and current state.

Usage Examples:

// Get a specific ledger by sequence number $ledger = $sdk->ledgers()->ledger("123456");

// Get recent ledgers with pagination $ledgers = $sdk->ledgers() ->limit(20) ->order("desc") ->execute();

// Stream ledgers in real-time $sdk->ledgers() ->cursor("now") ->stream(function(LedgerResponse $ledger) { echo "Ledger closed: " . $ledger->getSequence() . PHP_EOL; });

Constants

HEADERS = ["X-Client-Name" => "stellar_php_sdk", "X-Client-Version" => \Soneso\StellarSDK\StellarSDK::VERSION_NR]

Properties

$httpClient : Client
$queryParameters : array<string|int, mixed>
$segments : array<string|int, mixed>

Methods

__construct() : mixed: Constructor
buildUrl() : string: Builds the complete request URL with all segments and query parameters
cursor() : LedgersRequestBuilder: Sets <code>cursor</code> parameter on the request.
execute() : Response: Build and execute request.
executeRequest() : Response: Executes an HTTP request to Horizon and returns a parsed response object
getAndStream() : void: Streams Server-Sent Events from Horizon to a callback function
ledger() : LedgerResponse: Requests <code>GET /ledgers/{ledgerSequence}</code>
limit() : LedgersRequestBuilder: Sets <code>limit</code> parameter on the request.
order() : LedgersRequestBuilder: Sets <code>order</code> parameter on the request.
request() : LedgersPageResponse: Requests specific <code>url</code> and returns {@link LedgersPageResponse}.
stream() : mixed: Streams Ledger objects to $callback
setSegments() : RequestBuilder: Sets the URL path segments for this request

HEADERS


    public
        mixed
    HEADERS
    = ["X-Client-Name" => "stellar_php_sdk", "X-Client-Version" => \Soneso\StellarSDK\StellarSDK::VERSION_NR]

$httpClient


        protected
            Client
    $httpClient

$queryParameters


        protected
            array<string|int, mixed>
    $queryParameters

$segments


        protected
            array<string|int, mixed>
    $segments

__construct()

Constructor


    public
                    __construct(Client $httpClient) : mixed

Parameters

$httpClient : Client: The HTTP client used for making requests to Horizon

buildUrl()

Builds the complete request URL with all segments and query parameters


    public
                    buildUrl() : string

Combines the URL path segments with query parameters to create the final request URL string that will be sent to Horizon.

Return values

string —

The constructed URL with query parameters

cursor()

Sets <code>cursor</code> parameter on the request.


    public
                    cursor(string $cursor) : LedgersRequestBuilder

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.

Parameters

$cursor : string

Return values

LedgersRequestBuilder

execute()

Build and execute request.


    public
                    execute() : Response

@throws HorizonRequestException

Return values

Response —

The parsed response object

executeRequest()

Executes an HTTP request to Horizon and returns a parsed response object


    public
                    executeRequest(string $url, string $requestType[, string|null $requestMethod = "GET" ]) : Response

This method sends the HTTP request to the Horizon server, handles errors, and parses the JSON response into the appropriate response type.

Parameters

$url : string: The complete request URL to fetch
$requestType : string: The expected response type for parsing
$requestMethod : string|null = "GET": The HTTP method to use (default: "GET")

Return values

Response —

The parsed response object of the specified type

getAndStream()

Streams Server-Sent Events from Horizon to a callback function


    public
                    getAndStream(string $relativeUrl, callable $callback[, bool $retryOnServerException = true ]) : void

This method establishes a persistent connection to Horizon's streaming endpoints using Server-Sent Events (SSE). It processes each event and passes the parsed data to the provided callback function. The stream automatically reconnects on server exceptions if retryOnServerException is true.

Horizon streaming uses SSE to push real-time updates. The stream sends:

"hello" message on connection
"byebye" message on disconnection
JSON data objects for actual events

Parameters

$relativeUrl : string: The relative URL to stream from
$callback : callable: Function to receive parsed event data
$retryOnServerException : bool = true: If true, automatically retry on server errors (default: true)

Return values

void —

This method runs indefinitely until interrupted

ledger()

Requests <code>GET /ledgers/{ledgerSequence}</code>


    public
                    ledger(string $ledgerSequence) : LedgerResponse

Parameters

$ledgerSequence : string: (ledger_id) of the ledger to fetch

Return values

LedgerResponse

limit()

Sets <code>limit</code> parameter on the request.


    public
                    limit(int $number) : LedgersRequestBuilder

It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Parameters

$number : int: Maximum number of records to return

Return values

LedgersRequestBuilder

order()

Sets <code>order</code> parameter on the request.


    public
                    order([string $direction = "asc" ]) : LedgersRequestBuilder

Parameters

$direction : string = "asc": "asc" or "desc"

Return values

LedgersRequestBuilder

request()

Requests specific <code>url</code> and returns {@link LedgersPageResponse}.


    public
                    request(string $url) : LedgersPageResponse

Parameters

$url : string

Return values

LedgersPageResponse

stream()

Streams Ledger objects to $callback


    public
                    stream([callable|null $callback = null ]) : mixed

$callback should have arguments: LedgerResponse

For example:

$sdk = StellarSDK::getTestNetInstance(); $sdk->ledgers()->cursor("now")->stream(function(LedgerResponse $ledger) { printf('Ledger closed at: %s' . PHP_EOL, $ledger->getCreatedAt()); });

Parameters

$callback : callable|null = null

setSegments()

Sets the URL path segments for this request


    protected
                    setSegments(string ...$segments) : RequestBuilder

This method constructs the URL path by combining multiple segments. Can only be called once per request builder instance.

Parameters

$segments : string: Variable number of URL path segments

Return values

RequestBuilder —

This instance for method chaining

LedgersRequestBuilder extends RequestBuilder in package Soneso StellarSDK Requests

Tags

Table of Contents

Constants

Properties

Methods

Constants

HEADERS

Properties

$httpClient

$queryParameters

$segments

Methods

__construct()

Parameters

buildUrl()

Return values

cursor()

Parameters

Tags

Return values

execute()

Return values

executeRequest()

Parameters

Tags

Return values

getAndStream()

Parameters

Tags

Return values

ledger()

Parameters

Tags

Return values

limit()

Parameters

Return values

order()

Parameters

Return values

request()

Parameters

Tags

Return values

stream()

Parameters

Tags

setSegments()

Parameters

Tags

Return values

LedgersRequestBuilder extends RequestBuilder
in package

Soneso

StellarSDK

Requests