Stellar PHP SDK API Documentation

AssetsRequestBuilder extends RequestBuilder
in package

Builds requests for the assets endpoint in Horizon

This class provides methods to query all assets on the Stellar network, with optional filtering by asset code and/or issuer account. Assets represent currencies or tokens that can be traded and held by accounts.

Query Methods:

  • forAssetCode(): Filter assets by their asset code (e.g., "USD", "BTC")
  • forAssetIssuer(): Filter assets by their issuing account ID

Both filters can be combined to retrieve a specific asset. The response includes detailed statistics for each asset including supply, number of accounts, and trustlines.

Usage Examples:

// Get all assets with pagination $assets = $sdk->assets() ->limit(50) ->order("desc") ->execute();

// Get assets by code $usdAssets = $sdk->assets() ->forAssetCode("USD") ->execute();

// Get a specific asset by code and issuer $asset = $sdk->assets() ->forAssetCode("USD") ->forAssetIssuer("GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5") ->execute();

Tags
see
AssetsPageResponse

For the response format

see
https://developers.stellar.org

Stellar developer docs Horizon API Assets endpoint

Table of Contents

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()  : AssetsRequestBuilder
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
forAssetCode()  : AssetsRequestBuilder
Filter assets by asset code
forAssetIssuer()  : AssetsRequestBuilder
Filter assets by issuer account
getAndStream()  : void
Streams Server-Sent Events from Horizon to a callback function
limit()  : AssetsRequestBuilder
Sets <code>limit</code> parameter on the request.
order()  : AssetsRequestBuilder
Sets <code>order</code> parameter on the request.
request()  : AssetsPageResponse
Requests specific <code>url</code> and returns {@link AssetsRequestBuilder}.
setSegments()  : RequestBuilder
Sets the URL path segments for this request

Constants

HEADERS

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

Properties

$queryParameters

protected array<string|int, mixed> $queryParameters

Methods

__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

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")

Tags
throws
HorizonRequestException

If the request fails or response cannot be parsed

Return values
Response —

The parsed response object of the specified type

forAssetCode()

Filter assets by asset code

public forAssetCode(string $assetCode) : AssetsRequestBuilder

Restricts the returned assets to those with the specified asset code. Can be combined with forAssetIssuer() to retrieve a specific asset.

Parameters
$assetCode : string

The asset code to filter by (e.g., "USD", "BTC", "EURT")

Return values
AssetsRequestBuilder —

This builder for method chaining

forAssetIssuer()

Filter assets by issuer account

public forAssetIssuer(string $assetIssuer) : AssetsRequestBuilder

Restricts the returned assets to those issued by the specified account. Can be combined with forAssetCode() to retrieve a specific asset.

Parameters
$assetIssuer : string

The Stellar account ID (public key) of the asset issuer

Return values
AssetsRequestBuilder —

This builder for method chaining

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)

Tags
throws
GuzzleException

If a network error occurs and retryOnServerException is false

Return values
void —

This method runs indefinitely until interrupted

limit()

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

public limit(int $number) : AssetsRequestBuilder

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
AssetsRequestBuilder

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

Tags
throws
RuntimeException

If segments have already been set

Return values
RequestBuilder —

This instance for method chaining


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results