Skip to main content

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.