Stellar PHP SDK API Documentation

OrderBookRequestBuilder extends RequestBuilder
in package

Soneso

StellarSDK

Requests

Builds requests for the order book endpoint in Horizon

This class provides methods to query the order book for a specific asset pair on the Stellar decentralized exchange. The order book displays all buy (bid) and sell (ask) offers for the trading pair, providing insight into market depth and liquidity.

Query Methods:

forBuyingAsset(): Set the asset being purchased
forSellingAsset(): Set the asset being sold

Both assets must be specified to retrieve an order book. The response includes lists of bids and asks with prices and amounts, enabling price discovery and market analysis.

Usage Examples:

// Get order book for XLM/USD trading pair $buying = Asset::native(); $selling = Asset::createNonNativeAsset("USD", "GBBD..."); $orderBook = $sdk->orderBook() ->forBuyingAsset($buying) ->forSellingAsset($selling) ->execute();

// Stream real-time order book updates $sdk->orderBook() ->forBuyingAsset($buying) ->forSellingAsset($selling) ->cursor("now") ->stream(function(OrderBookResponse $orderBook) { echo "Bids: " . count($orderBook->getBids()) . 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() : OrderBookRequestBuilder: 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
forBuyingAsset() : OrderBookRequestBuilder: Returns the order book for the given buying asset.
forSellingAsset() : OrderBookRequestBuilder: Returns the order book for the given selling asset.
getAndStream() : void: Streams Server-Sent Events from Horizon to a callback function
limit() : OrderBookRequestBuilder: Sets <code>limit</code> parameter on the request.
order() : OrderBookRequestBuilder: Sets <code>order</code> parameter on the request.
request() : OrderBookResponse: Requests specific <code>url</code> and returns {@link OrderBookResponse}.
stream() : mixed: Streams OrderBookResponse 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) : OrderBookRequestBuilder

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

OrderBookRequestBuilder

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

forBuyingAsset()

Returns the order book for the given buying asset.


    public
                    forBuyingAsset(Asset $buyingAsset) : OrderBookRequestBuilder

Parameters

$buyingAsset : Asset: the buying asset

Return values

OrderBookRequestBuilder —

current instance

forSellingAsset()

Returns the order book for the given selling asset.


    public
                    forSellingAsset(Asset $sellingAsset) : OrderBookRequestBuilder

Parameters

$sellingAsset : Asset: the selling asset

Return values

OrderBookRequestBuilder —

current instance

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

limit()

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


    public
                    limit(int $number) : OrderBookRequestBuilder

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

OrderBookRequestBuilder

order()

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


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

Parameters

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

Return values

OrderBookRequestBuilder

request()

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


    public
                    request(string $url) : OrderBookResponse

Parameters

$url : string

Return values

OrderBookResponse

stream()

Streams OrderBookResponse objects to $callback


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

$callback should have arguments: OrderBookResponse

For example:

$sdk = StellarSDK::getTestNetInstance(); $buyingAsset = Asset::native(); $sellingAsset = Asset::createNonNativeAsset("USD", "GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"); $sdk->orderBook() ->forBuyingAsset($buyingAsset) ->forSellingAsset($sellingAsset) ->cursor("now") ->stream(function(OrderBookResponse $orderBook) { printf('Order Book - Bids: %d, Asks: %d' . PHP_EOL, $orderBook->getBids()->count(), $orderBook->getAsks()->count() ); });

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

OrderBookRequestBuilder 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

forBuyingAsset()

Parameters

Return values

forSellingAsset()

Parameters

Return values

getAndStream()

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

OrderBookRequestBuilder extends RequestBuilder
in package

Soneso

StellarSDK

Requests