Method Name
private/get_quotes
private/get_quotesRetrieves a list of quotes matching filter criteria.
Market makers can use this to get their open quotes, quote history, etc.
Parameters
| subaccount_id
integer
required
Subaccount ID for auth purposes, returned data will be scoped to this subaccount. |
| from_timestamp
integer
Earliest timestamp to filter by (in ms since Unix epoch). If not provied, defaults to 0. |
| page
integer
Page number of results to return (default 1, returns last if above num_pages) |
| page_size
integer
Number of results per page (default 100, max 1000) |
| quote_id
string
Quote ID filter, if applicable |
| rfq_id
string
RFQ ID filter, if applicable |
| status
string
Quote status filter, if applicable enum open filled cancelled expired |
| to_timestamp
integer
Latest timestamp to filter by (in ms since Unix epoch). If not provied, defaults to returning all data up to current time. |
Response
| id
string or integer
required
|
| result
object
required
|
| result.pagination
object
required
Pagination info |
| result.pagination.count
integer
required
Total number of items, across all pages |
| result.pagination.num_pages
integer
required
Number of pages |
| result.quotes
array of objects
required
Quotes matching filter criteria |
| result.quotes[].cancel_reason
string
required
Cancel reason, if any enum user_request insufficient_margin signed_max_fee_too_low mmp_trigger cancel_on_disconnect session_key_deregistered subaccount_withdrawn rfq_no_longer_open compliance |
| result.quotes[].creation_timestamp
integer
required
Creation timestamp in ms since Unix epoch |
| result.quotes[].direction
string
required
Quote direction enum buy sell |
| result.quotes[].fee
string
required
Fee paid for this quote (if executed) |
| result.quotes[].is_transfer
boolean
required
Whether the order was generated through private/transfer_position |
| result.quotes[].label
string
required
User-defined label, if any |
| result.quotes[].last_update_timestamp
integer
required
Last update timestamp in ms since Unix epoch |
| result.quotes[].legs_hash
string
required
Hash of the legs of the best quote to be signed by the taker. |
| result.quotes[].liquidity_role
string
required
Liquidity role enum maker taker |
| result.quotes[].max_fee
string
required
Signed max fee |
| result.quotes[].mmp
boolean
required
Whether the quote is tagged for market maker protections (default false) |
| result.quotes[].nonce
integer
required
Nonce |
| result.quotes[].quote_id
string
required
Quote ID |
| result.quotes[].rfq_id
string
required
RFQ ID |
| result.quotes[].signature
string
required
Ethereum signature of the quote |
| result.quotes[].signature_expiry_sec
integer
required
Unix timestamp in seconds |
| result.quotes[].signer
string
required
Owner wallet address or registered session key that signed the quote |
| result.quotes[].status
string
required
Status enum open filled cancelled expired |
| result.quotes[].subaccount_id
integer
required
Subaccount ID |
| result.quotes[].tx_hash
string or null
required
Blockchain transaction hash (only for executed quotes) |
| result.quotes[].tx_status
string or null
required
Blockchain transaction status (only for executed quotes) enum requested pending settled reverted ignored |
| result.quotes[].legs
array of objects
required
Quote legs |
| result.quotes[].legs[].amount
string
required
Amount in units of the base |
| result.quotes[].legs[].direction
string
required
Leg direction enum buy sell |
| result.quotes[].legs[].instrument_name
string
required
Instrument name |
| result.quotes[].legs[].price
string
required
Leg price |
Example
{request_example_shell}
{request_example_javascript}
{request_example_python}
The above command returns JSON structured like this:
{response_example_json}