The Path Object

When Horizon returns information about a path, it uses the following format:

ATTRIBUTEDATA TYPE

DESCRIPTION

source_asset_typestring

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

source_asset_codestring

The code for the source asset.

source_asset_issuerstring

The Stellar address of the source asset’s issuer.

source_amountstring

An estimated cost for making a payment of destination_amount on this path. Suitable for use in the sendMax field of a path payment operation.

destination_asset_typestring

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

destination_asset_codestring

The code for the destination asset.

destination_asset_issuerstring

The Stellar address of the destination asset’s issuer.

destination_amountstring

The destination amount specified in the search that found this path.

patharray of objects

The intermediary assets that this path hops through.

Show child attributes

asset_codestring

The code for this intermediary asset.

asset_issuerstring

The Stellar address of the intermediary asset’s issuer.

asset_typestring

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

The latest ledger known to Horizon is included as an HTTP header in the response.

Example

{
  "_embedded": {
    "records": [
      {
        "source_asset_type": "credit_alphanum4",
        "source_asset_code": "USD",
        "source_asset_issuer": "GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX",
        "source_amount": "4.1900246",
        "destination_asset_type": "credit_alphanum4",
        "destination_asset_code": "BB1",
        "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
        "destination_amount": "5.0000000",
        "path": [
          {
            "asset_type": "credit_alphanum4",
            "asset_code": "NGNT",
            "asset_issuer": "GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"
          },
          {
            "asset_type": "native"
          }
        ]
      },
      {
        "source_asset_type": "native",
        "source_amount": "162.0291692",
        "destination_asset_type": "credit_alphanum4",
        "destination_asset_code": "BB1",
        "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
        "destination_amount": "5.0000000",
        "path": [
          {
            "asset_type": "credit_alphanum4",
            "asset_code": "EURT",
            "asset_issuer": "GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
          }
        ]
      },
      {
        "source_asset_type": "native",
        "source_amount": "162.3284659",
        "destination_asset_type": "credit_alphanum4",
        "destination_asset_code": "BB1",
        "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
        "destination_amount": "5.0000000",
        "path": [
          {
            "asset_type": "credit_alphanum4",
            "asset_code": "USD",
            "asset_issuer": "GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"
          },
          {
            "asset_type": "credit_alphanum4",
            "asset_code": "EURT",
            "asset_issuer": "GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"
          }
        ]
      },
      {
        "source_asset_type": "native",
        "source_amount": "367.4324508",
        "destination_asset_type": "credit_alphanum4",
        "destination_asset_code": "BB1",
        "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
        "destination_amount": "5.0000000",
        "path": [
          {
            "asset_type": "credit_alphanum4",
            "asset_code": "BTC",
            "asset_issuer": "GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"
          }
        ]
      }
    ]
  }
}