APIs

Introduction to the APIs

The technical aspects of the Orion API are covered in this section. It is made up of different API divisions, which are each described in detail below:

  1. Order API. Supports both spot and futures orders, making it simple for users to create, retrieve, and cancel orders. The API also includes specialized endpoints for internal orders, retrieving order history based on certain parameters, and determining order liquidation status. Key features include the ability to monitor order status with a maximum display of 20 orders at a time and the option to cancel orders forcibly with sufficient authority.

  2. Exchange API. Allows enabling or disabling exchanges and asset pairs to tailor user trading experience. Retrieve a list of exchanges via API endpoints.

  3. Swap API. Allows users to retrieve and interact with information related to token swaps. This includes obtaining detailed swap data and establishing swap parameters such as the assets involved, the quantity of assets, the desired settlement, and the specific exchanges to be used. This API section allows users to gain insights into various swap scenarios effectively and strategize their trading decisions accordingly.

  4. Orderbook API. Gives the a complete way to view aggregated order book data. This API has endpoints for general order book data, detailed order book data for a specific exchange and asset pair, and a private order book tied to a specific asset pair. Users can change the level of the order book data by giving query parameters. This API part helps users understand how trading works, so they can make better decisions based on what's happening on the market right now.

  5. Pairs API. Serves as a tool for getting complete information about asset pairs. Users can get lists of available asset pairs, either as a simple list or as a more detailed list special to a given exchange. Users can also use the API to get thorough information about specific asset pairs or about a pair as it relates to a specific exchange. In essence, this part of the API gives users a wide view of the available trading pairs and information about them, which helps them make trading decisions.

  6. Paths API. Makes it easier to look into trading paths between two assets. Users can ask for the best path for a certain exchange or get a general path between two assets, regardless of the exchange. This API part is meant to give users the information they need to plan their trading activities smoothly and effectively.

  7. Pools API. Gives users tools to get vital details about liquidity pools. It has endpoints to get reserves from all known pools or specific reserves for a given factory and asset pair. This API also lets users get estimates of all known pools, which gives them useful information for trading strategies. Users can look at the estimate of a specific factory and asset pair for a more thorough view. This API area helps users stay up-to-date on the system's liquidity, which helps them make well-informed trading decisions.

  8. Atomic Swap API. Facilitates the seamless implementation of atomic swaps - an innovative feature that allows for the immediate and direct exchange of assets between two distinct blockchains.

Last updated