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.
Required minimum session key permission level is read_only
Parameters
| subaccount_idintegerrequired Subaccount ID for auth purposes, returned data will be scoped to this subaccount. |
| from_timestampinteger Earliest timestamp to filter by (in ms since Unix epoch). If not provied, defaults to 0. |
| pageinteger Page number of results to return (default 1, returns last if above num_pages) |
| page_sizeinteger Number of results per page (default 100, max 1000) |
| quote_idstring Quote ID filter, if applicable |
| rfq_idstring RFQ ID filter, if applicable |
| statusstring Quote status filter, if applicable enum openfilledcancelledexpired |
| to_timestampinteger Latest timestamp to filter by (in ms since Unix epoch). If not provied, defaults to returning all data up to current time. |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.paginationobjectrequired Pagination info |
| result.pagination.countintegerrequired Total number of items, across all pages |
| result.pagination.num_pagesintegerrequired Number of pages |
| result.quotesarray of objectsrequired Quotes matching filter criteria |
| result.quotes[].cancel_reasonstringrequired Cancel reason, if any enum user_requestinsufficient_marginsigned_max_fee_too_lowmmp_triggercancel_on_disconnectsession_key_deregisteredsubaccount_withdrawnrfq_no_longer_opencompliance |
| result.quotes[].creation_timestampintegerrequired Creation timestamp in ms since Unix epoch |
| result.quotes[].directionstringrequired Quote direction enum buysell |
| result.quotes[].extra_feestringrequired Extra fee in USDC added by the referring client (included in quote fee) |
| result.quotes[].feestringrequired Fee paid for this quote (if executed) |
| result.quotes[].fill_pctstringrequired Percentage of the RFQ that this quote would fill, from 0 to 1. |
| result.quotes[].is_transferbooleanrequired Whether the order was generated through private/transfer_position |
| result.quotes[].labelstringrequired User-defined label, if any |
| result.quotes[].last_update_timestampintegerrequired Last update timestamp in ms since Unix epoch |
| result.quotes[].legs_hashstringrequired Hash of the legs of the best quote to be signed by the taker. |
| result.quotes[].liquidity_rolestringrequired Liquidity role enum makertaker |
| result.quotes[].max_feestringrequired Signed max fee |
| result.quotes[].mmpbooleanrequired Whether the quote is tagged for market maker protections (default false) |
| result.quotes[].nonceintegerrequired Nonce |
| result.quotes[].quote_idstringrequired Quote ID |
| result.quotes[].rfq_idstringrequired RFQ ID |
| result.quotes[].signaturestringrequired Ethereum signature of the quote |
| result.quotes[].signature_expiry_secintegerrequired Unix timestamp in seconds |
| result.quotes[].signerstringrequired Owner wallet address or registered session key that signed the quote |
| result.quotes[].statusstringrequired Status enum openfilledcancelledexpired |
| result.quotes[].subaccount_idintegerrequired Subaccount ID |
| result.quotes[].tx_hashstring or nullrequired Blockchain transaction hash (only for executed quotes) |
| result.quotes[].tx_statusstring or nullrequired Blockchain transaction status (only for executed quotes) enum requestedpendingsettledrevertedignoredtimed_out |
| result.quotes[].legsarray of objectsrequired Quote legs |
| result.quotes[].legs[].amountstringrequired Amount in units of the base |
| result.quotes[].legs[].directionstringrequired Leg direction enum buysell |
| result.quotes[].legs[].instrument_namestringrequired Instrument name |
| result.quotes[].legs[].pricestringrequired Leg price |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}