Orders

Gets all valid quote(s) on the orderbook by using broad query params. If no parameters are supplied the entire orderbook is returned.

get

/orderbook/orders

Authorizations

Query parameters

poolAddressstring

unique address of the pool

Example: 0x3ba638...fb25e

Pattern: ^0x[a-fA-F0-9]{40}$

sizenumber

number of contracts (ie 4)

Example: 4

sidestring

orderbook side ("ask" or "bid")

Example: bid

Pattern: ^bid$|^ask$

providerstring

unique address of the provider

Example: 0x3ba638...fb25e

Pattern: ^0x[a-fA-F0-9]{40}$

typestring

optional flag to get invalid quotes

Pattern: ^invalid$

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/orderbook/orders' \
  --header 'x-apikey: YOUR_API_KEY'

200

400

401

200

[
  {
    "base": "WETH",
    "quote": "USDC",
    "expiration": "03NOV23",
    "strike": 1700,
    "remainingSize": 3,
    "provider": "0x3ba638...fb25e",
    "taker": "0x0000000000000000000000000000000000000000",
    "price": ".15",
    "deadline": 184,
    "quoteId": "0x3ba638...fb25e",
    "ts": 1698952534,
    "type": "P",
    "side": "bid"
  }
]

Successful operation