Skip to main content

The Order Book Object

When Horizon returns information about an order book, it uses the following format:

  • ATTRIBUTEDATA TYPE

    DESCRIPTION

  • bidsobject

    The prices and amounts for the buyside of the asset pair.

    Show child attributes
    • price_robject

      A precise representation of the bid price of the asset pair.

      Show child attributes
      • nnumber

        The numerator.

      • dnumber

        The denominator.

    • pricestring

      The bid price of the base asset denominated in the counter asset. A number representing the decimal form of price_r.

    • amountstring

      The amount of counter asset that the account making this offer is willing to buy at this price.

  • asksobject

    The prices and amounts for the sellside of the asset pair.

    Show child attributes
    • price_robject

      A precise representation of the ask price of the asset pair.

      Show child attributes
      • nnumber

        The numerator.

      • dnumber

        The denominator.

    • pricestring

      The ask price of the base asset denominated in the counter asset. A number representing the decimal form of price_r.

    • amountstring

      The amount of counter asset that the account making this offer is willing to sell at this price.

  • baseobject

    Details about the base asset.

    Show child attributes
    • asset_typestring

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

    • asset_codestring

      The code for the base asset.

    • asset_issuerstring

      The Stellar address of the base asset’s issuer.

  • counterobject

    Details about the counter asset.

    Show child attributes
    • asset_typestring

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

    • asset_codestring

      The code for the counter asset.

    • asset_issuerstring

      The Stellar address of the counter asset’s issuer.