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

Required scopes

This endpoint requires the following scopes:

Authorizations

api_key

x-apikeystringRequired

Query parameters

poolAddressstringOptional

unique address of the pool

Example: 0x3ba638...fb25ePattern: ^0x[a-fA-F0-9]{40}$

sizenumberOptional

number of contracts (ie 4)

Example: 4

sidestringOptional

orderbook side ("ask" or "bid")

Example: bidPattern: ^bid$|^ask$

providerstringOptional

unique address of the provider

Example: 0x3ba638...fb25ePattern: ^0x[a-fA-F0-9]{40}$

typestringOptional

optional flag to get invalid quotes

Pattern: ^invalid$

Responses

200

Successful operation

application/json

400

Invalid parameters supplied

application/json

401

Not authorized

application/json

get

/orderbook/orders

HTTPcURLJavaScriptPython

GET /orderbook/orders HTTP/1.1
Host: 
x-apikey: YOUR_API_KEY
Accept: */*

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