Quotes

PreviousOrderbook NextOrders

Last updated 11 months ago

Was this helpful?

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

Authorizations

Body

quoteIdsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/orderbook/quotes' \
  --header 'x-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[{"quoteIds":["0x3ba638...fb25e"]}]'

200

400

401

{
  "success": [
    "0x3ba638...fb25e"
  ],
  "failed": [
    "0x3ba638...fb25e"
  ],
  "omitted": [
    "0x3ba638...fb25e"
  ]
}

Quote cancelled

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

Authorizations

Body

tradeSizenumberrequired

Example: 4

quoteIdstringrequired

Example: 0x3ba638...fb25e

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/orderbook/quotes' \
  --header 'x-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[{"tradeSize":4,"quoteId":"0x3ba638...fb25e"}]'

200

400

401

{
  "success": [
    "0x3ba638...fb25e"
  ],
  "failed": [
    "0x3ba638...fb25e"
  ]
}

Quotes filled

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

Authorizations

Query parameters

basestringrequired

base token symbol (ie WETH)

Example: WETH

quotestringrequired

quote token symbol (ie USDC)

Example: USDC

expirationstringrequired

option expiration (ie 03NOV23)

Example: 03NOV23

strikenumberrequired

option strike (ie 1800)

Example: 1800

typestringrequired

C or P

Example: P

Pattern: ^C$|^P$

sizenumberrequired

number of contracts (ie 4)

Example: 4

sidestringrequired

orderbook side (ie bid)

Example: bid

Pattern: ^bid$|^ask$

providerstring

unique address of the provider (maker)

Example: 0x3ba638...fb25e

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

takerstring

unique address of the taker (only for rfq quotes)

Example: 0x3ba638...fb25e

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/orderbook/quotes?base=WETH&quote=USDC&expiration=03NOV23&strike=1800&type=P&size=4&side=bid' \
  --header 'x-apikey: YOUR_API_KEY'

200

400

401

[
  {
    "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

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

Authorizations

Body

basestringrequired

Example: WETH

quotestringrequired

Example: USDC

expirationstringrequired

Example: 03NOV23

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

strikenumberrequired

Example: 1800

typestringrequired

Example: P

Pattern: ^C$|^P$

sidestringrequired

Example: bid

Pattern: ^bid$|^ask$

sizenumberrequired

Example: 4

pricenumberrequired

Example: .13

deadlineintegerrequired

Example: 120

takerstring

Example: 0x...4cFF2

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/orderbook/quotes' \
  --header 'x-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[{"base":"WETH","quote":"USDC","expiration":"03NOV23","strike":1800,"type":"P","side":"bid","size":4,"price":".13","deadline":120,"taker":"0x...4cFF2"}]'

200

201

400

401

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

Quote exists