Method Name
private/get_rfqs
private/get_rfqsRetrieves a list of RFQs matching filter criteria. Takers can use this to get their open RFQs, RFQ 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 last_update_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) |
| rfq_idstring RFQ ID filter, if applicable |
| statusstring RFQ status filter, if applicable enum openfilledcancelledexpired |
| to_timestampinteger Latest last_update_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.rfqsarray of objectsrequired RFQs matching filter criteria |
| result.rfqs[].ask_total_coststring or nullrequired Ask total cost for the RFQ implied from orderbook (as sell) |
| result.rfqs[].bid_total_coststring or nullrequired Bid total cost for the RFQ implied from orderbook (as buy) |
| result.rfqs[].cancel_reasonstringrequired Cancel reason, if any enum user_requestinsufficient_marginsigned_max_fee_too_lowmmp_triggercancel_on_disconnectsession_key_deregisteredsubaccount_withdrawnrfq_no_longer_opencompliance |
| result.rfqs[].counterpartiesarray of strings or nullrequired List of requested counterparties, if applicable |
| result.rfqs[].creation_timestampintegerrequired Creation timestamp in ms since Unix epoch |
| result.rfqs[].filled_directionstring or nullrequired Direction at which the RFQ was filled (only if filled) enum buysell |
| result.rfqs[].filled_pctstringrequired Percentage of the RFQ that has been filled, from 0 to 1. |
| result.rfqs[].labelstringrequired User-defined label, if any |
| result.rfqs[].last_update_timestampintegerrequired Last update timestamp in ms since Unix epoch |
| result.rfqs[].mark_total_coststring or nullrequired Mark total cost for the RFQ (assuming buy direction) |
| result.rfqs[].max_total_coststring or nullrequired Max total cost for the RFQ |
| result.rfqs[].min_total_coststring or nullrequired Min total cost for the RFQ |
| result.rfqs[].partial_fill_stepstringrequired Step size for partial fills (default: 1) |
| result.rfqs[].preferred_directionstring or nullrequired If disclosed, the direction the user is aiming to execute as. enum buysell |
| result.rfqs[].reducing_directionstring or nullrequired If applicable, the direction from user's perspective that would reduce their position in each leg. enum buysell |
| result.rfqs[].rfq_idstringrequired RFQ ID |
| result.rfqs[].statusstringrequired Status enum openfilledcancelledexpired |
| result.rfqs[].subaccount_idintegerrequired Subaccount ID |
| result.rfqs[].total_coststring or nullrequired Total cost for the RFQ (only if filled) |
| result.rfqs[].valid_untilintegerrequired RFQ expiry timestamp in ms since Unix epoch |
| result.rfqs[].walletstringrequired Wallet address of the RFQ sender |
| result.rfqs[].legsarray of objectsrequired RFQ legs |
| result.rfqs[].legs[].amountstringrequired Amount in units of the base |
| result.rfqs[].legs[].directionstringrequired Leg direction enum buysell |
| result.rfqs[].legs[].instrument_namestringrequired Instrument name |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}