Skip to main content

List Strict Send Payment Paths

GET 
https://horizon-testnet.stellar.org/paths/strict-send

The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books.

For this search, Horizon loads a list of assets that the recipient can receive (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.

Request​

Query Parameters

    source_asset_type stringrequired

    Possible values: [native, credit_alphanum4, credit_alphanum12]

    The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.

    source_asset_issuer string

    The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native.

    source_asset_code string

    The code for the source asset. Required if the source_asset_type is not native.

    source_amount stringrequired

    The amount of the source asset that should be sent.

    destination_account string

    The Stellar address of the receiver. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments.

    destination_assets string

    A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.

Responses​

Success

Schema
    _embedded object
    records object[]
  • Array [
    • source_asset_typestring
    source_asset_codestring
    source_asset_issueraddress (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    source_amountstring
    destination_asset_typestring
    destination_asset_codestring
    destination_asset_issueraddress (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    destination_amountstring
    path object[]
  • Array [
    • asset_typestringrequired
    asset_codestring
    asset_issueraddress (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

  • ]
  • ]
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://horizon-testnet.stellar.org/paths/strict-send");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://horizon-testnet.stellar.org
Parameters
— queryrequired
— queryrequired
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!

Supports Streaming
This endpoint supports streaming. To read more about this, visit thestreaming section.
Did you find this page helpful?
Last updated on by chowbao