Introduction

Enable limit orders in your app or take liquidity directly from the 0x Orderbook.

0x has an Orderbook API on the following chains:

• Ethereum
• Binance Smart Chain
• Polygon

In previous versions of 0x API prior to 0x v4, this functionality was exposed by the "SRA" endpoint. Legacy docs: https://github.com/0xProject/standard-relayer-api.

How It Works

The Orderbook API surfaces the 0x Limit Orders, a standard 0x Order Type. 0x Limit Orders encode a possible trade between a Maker and a Taker. These orders are typically distributed via the /orderbook endpoint, and can be filled through the functions on the Exchange Proxy, the main contract of the 0x Protocol that manages the process and performs the exchange of assets.

To leverage it, check out the Orderbook API References. In addition, 0x exploses a websocket server at the root endpoint. The server will allow you to subscribe to 0x Limit Order updates, and will push updates whenever the status (eg: open, filled, expired) of an order changes.

Get Started

Checkout Guides, Concepts, and API References to get started building with Orderbook API:

info

To get your live API keys to access the Orderbook API, visit the 0x Dashboard to create a 0x account.

Guides

0x Starter Project includes with a number of scenarios using the 0x v4 protocol that can be run from the command-line:

• Create a Limit Order
• Cancel a Limit Order
• Fill a Limit Order
• Limit Order Status
• Cancel Several Limit Orders at Once

Concepts

• Limit Order Structure
• Monitoring 0x Limit Orders
• Rate Limiting
• Connections Limits

API References

• API Overview
• GET /orderbook/v1/order
• GET /orderbook/v1/orders
• POST /orderbook/v1/order
• POST /orderbook/v1/orders
• GET /orderbook/v1/order/orderhash.md
• POST /orderbook/v1-order/_config.md
• GET /orderbook-v1-fee/_recipients.md
• Websocket API