Quotes

Get all quotes for a specific option up to a specified size/qty. All orders will be ranked from best to worst according to price. Please note that this will not show the full state of the orderbook if the total market liquidity is greater than the size specified.

GET/orderbook/quotes

Authorization

Query parameters

Response

Successful operation

Body

base*string

Example: "WETH"

quote*string

Example: "USDC"

expiration*string

Example: "03NOV23"

Pattern: ^\d\d\w\w\w\d\d$

strike*number

Example: 1700

type*enum

Example: "P"

side*enum

Example: "bid"

askbid

remainingSize*number

Example: 3

provider*string

Example: "0x3ba638...fb25e"

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

taker*string

Example: "0x0000000000000000000000000000000000000000"

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

price*number

Example: ".15"

deadline*number

Example: 184

quoteIdstring

Example: "0x3ba638...fb25e"

Pattern: [a-fA-F0-9]{64}$

ts*number

Example: 1698952534

Request

Response

Publishes option quote(s) on-chain and into the orderbook (max quotes quantity is 200). Please note there is no gas that is paid to publish quotes. Deadline is the number of seconds the order is valid for. Price is normalized. For calls, price is denominated in the base token (ie 0.13 WETH), and for puts price is in denominated in the quote token but normalized using strike. For example, a put price of 0.13 => (234 USDC price / 1800 Strike ) is equivalent to 234 USDC if the strike is 1800. The takerAddress is optional and should only be populated if responding to an RFQ, otherwise omit.

POST/orderbook/quotes

Authorization

Body

base*string

Example: "WETH"

quote*string

Example: "USDC"

expiration*string

Example: "03NOV23"

Pattern: ^\d\d\w\w\w\d\d$

strike*number

Example: 1800

type*string

Example: "P"

Pattern: ^C$|^P$

side*string

Example: "bid"

Pattern: ^bid$|^ask$

size*number

Example: 4

price*number

Example: ".13"

deadline*integer

Example: 120

takerstring

Example: "0x...4cFF2"

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

Response

Quote exists

Body

failedarray of object

existsarray of object

Request

const response = await fetch('/orderbook/quotes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "base": "WETH",
        "quote": "USDC",
        "expiration": "03NOV23",
        "strike": 1800,
        "type": "P",
        "side": "bid",
        "size": 4,
        "price": ".13",
        "deadline": 120
      }
    ]),
});
const data = await response.json();

Response

{
  "failed": [
    {
      "reason": "Quote deadline is invalid (cannot be less than 10 sec)",
      "quote": {
        "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
      }
    }
  ],
  "exists": [
    {
      "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
    }
  ]
}

Deletes the quote(s) from the orderbook that have not exceeded their deadline (max quotes quantity is 25). Please note that orders that have surpassed their deadline do NOT need to be cancelled. They are automatically removed from the orderbook and are unfillable on-chain. Cancelling orders does incur on-chain gas fees.

DELETE/orderbook/quotes

Authorization

Body

quoteIds*array of string

Response

Quote cancelled

Body

successarray of string

failedarray of string

omittedarray of string

Request

Response

Used to fill quote(s) (max quotes quantity is 25). Only the size and quoteId for each quote are required. All quoteIds are returned either as 'success' or 'failed'. Each limit order that is trying to be filled is an "all or nothing" attempt.

PATCH/orderbook/quotes

Authorization

Body

tradeSize*number

Example: 4

quoteId*string

Example: "0x3ba638...fb25e"

Pattern: [a-fA-F0-9]{64}$

Response

Quotes filled

Body

successarray of string

failedarray of string

Request

Response

PreviousOrderbook NextOrders

Last updated 8 months ago

const response = await fetch('/orderbook/quotes', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify([ { "base": "WETH", "quote": "USDC", "expiration": "03NOV23", "strike": 1800, "type": "P", "side": "bid", "size": 4, "price": ".13", "deadline": 120 } ]), }); const data = await response.json();

{ "failed": [ { "reason": "Quote deadline is invalid (cannot be less than 10 sec)", "quote": { "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 } } ], "exists": [ { "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 } ] }