{ "opencollection": "1.0.0", "info": { "name": "Platform Server Accounts Order Books API", "version": "3.0.0" }, "items": [ { "info": { "name": "Order Books", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an Order Book", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/order_book", "params": [ { "name": "selling_asset_type", "value": "", "type": "query", "description": "The type for the asset being sold (base asset). Either `native`, `credit_alphanum4`, or `credit_alphanum12`." }, { "name": "selling_asset_issuer", "value": "", "type": "query", "description": "The Stellar address of the issuer of the asset being sold (base asset). Required if the `selling_asset_type` is not `native`." }, { "name": "selling_asset_code", "value": "", "type": "query", "description": "The code for the asset being sold (base asset). Required if the `selling_asset_type` is not `native`." }, { "name": "buying_asset_type", "value": "", "type": "query", "description": "The type for the asset being bought (counter asset). Either `native`, `credit_alphanum4`, or `credit_alphanum12`." }, { "name": "buying_asset_issuer", "value": "", "type": "query", "description": "The Stellar address of the issuer of the asset being bought (counter asset). Required if the `buying_asset_type` is not `native`." }, { "name": "buying_asset_code", "value": "", "type": "query", "description": "The code for the asset being bought (counter asset). Required if the `buying_asset_type` is not `native`." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records returned. The limit can range from 1 to 200 — an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 20 for order books." } ] }, "docs": "The order book endpoint provides an order book's bids and asks and can be used in [streaming](https://developers.stellar.org/docs/data/apis/horizon/api-reference/structure/streaming) mode.\n\nWhen filtering for a specific order book, you must use use all six of these arguments: `base_asset_type`, `base_asset_issuer`, `base_asset_code`, `counter_asset_type`, `counter_asset_issuer`, and `counter_asset_code`. If the base or counter asset is XLM, you only need to indicate the asset type as `native` an" } ] } ], "bundled": true }