REST API
Rest API End Points
Last updated
Was this helpful?
Rest API End Points
Last updated
Was this helpful?
Arbitrum Goerli (421613)
https://test.orderbook.premia.finance
Arbitrum One (42161)
https://orderbook.premia.finance
To submit a quote to the orderbook, POST
quotes can be used. In the background, we will take this quote an submit an event on Arbitrum Nova on the users behalf. One the quote event is generated on Arbitrum Nova, it will be added to the orderbook.
When using GET
quotes, orders are returned based on the params details provided. quotes
endpoint is ideal for determining which order(s) will satisfy a specific order size
and side
. The returned quotes are ordered by price, and only the order(s) that satisfy the size
(cumulatively) will be returned.
Additionally, it is possible to receive RFQ quotes along with public quotes by specifying a taker
address. The allows users to find the best possible public/private quote combination for a particular quote size.
GET
orders is a general purpose query of orders in the orderbook. Many of the params are optional to suit the needs of the query. Orders are returned in descending order based on the timestamp in which they were created.
Good To Know: size
param in GET
orders is not the same as size
param in GET
quotes. See param descriptions.
When publishing an RFQ, users can for quotes via WEBSOCKET or use the rfq_quotes endpoint to retrieve only RFQ quotes via REST API.
unique address of the pool
^0x[a-fA-F0-9]{40}$
min order size of each order (1 contract = 1e18)
^[0-9]*$
orderbook side ("ask" or "bid")
^bid$|^ask$
chain id ("42161" or "421613")
^42161$|^421613$
unique address of the provider
^0x[a-fA-F0-9]{40}$
^42161$|^421613$
^0x[a-fA-F0-9]{40}$
^0x[a-fA-F0-9]{40}$
unique address of the pool
^0x[a-fA-F0-9]{40}$
fill size (1 contract = 1e18)
^[0-9]*$
orderbook side ("ask" or "bid")
^bid$|^ask$
chain id ("42161" or "421613")
^42161$|^421613$
unique address of the provider
^0x[a-fA-F0-9]{40}$
unique address of the taker (for rfq quotes)
^0x[a-fA-F0-9]{40}$
unique address of the pool
^0x[a-fA-F0-9]{40}$
orderbook side ("ask" or "bid")
^bid$|^ask$
chain id ("42161" or "421613")
^42161$|^421613$
taker address
^0x[a-fA-F0-9]{40}$