Quotes
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
base token symbol (ie WETH)
WETH
quote token symbol (ie USDC)
USDC
option expiration (ie 03NOV23)
03NOV23
option strike (ie 1800)
1800
C or P
P
Pattern: ^C$|^P$
number of contracts (ie 4)
4
orderbook side (ie bid)
bid
Pattern: ^bid$|^ask$
unique address of the provider (maker)
0x3ba638...fb25e
Pattern: ^0x[a-fA-F0-9]{40}$
unique address of the taker (only for rfq quotes)
0x3ba638...fb25e
Pattern: ^0x[a-fA-F0-9]{40}$
Successful operation
Invalid parameters supplied
Not authorized
GET /orderbook/quotes?base=WETH"e=USDC&expiration=03NOV23&strike=1800&type=P&size=4&side=bid 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
}
]
WETH
USDC
03NOV23
Pattern: ^\d\d\w\w\w\d\d$
1800
P
Pattern: ^C$|^P$
bid
Pattern: ^bid$|^ask$
4
.13
120
0x...4cFF2
Pattern: ^0x[a-fA-F0-9]{40}$
Quote exists
Quote created
Bad request
Not authorized
POST /orderbook/quotes HTTP/1.1
Host:
x-apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 152
[
{
"base": "WETH",
"quote": "USDC",
"expiration": "03NOV23",
"strike": 1800,
"type": "P",
"side": "bid",
"size": 4,
"price": ".13",
"deadline": 120,
"taker": "0x...4cFF2"
}
]
{
"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
}
]
}
0x3ba638...fb25e
Quote cancelled
Invalid parameters supplied
Not authorized
DELETE /orderbook/quotes HTTP/1.1
Host:
x-apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35
[
{
"quoteIds": [
"0x3ba638...fb25e"
]
}
]
{
"success": [
"0x3ba638...fb25e"
],
"failed": [
"0x3ba638...fb25e"
],
"omitted": [
"0x3ba638...fb25e"
]
}
4
0x3ba638...fb25e
Pattern: [a-fA-F0-9]{64}$
Quotes filled
Bad request
Not authorized
PATCH /orderbook/quotes HTTP/1.1
Host:
x-apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46
[
{
"tradeSize": 4,
"quoteId": "0x3ba638...fb25e"
}
]
{
"success": [
"0x3ba638...fb25e"
],
"failed": [
"0x3ba638...fb25e"
]
}