Method Name
private/poll_rfqs
private/poll_rfqsRetrieves a list of RFQs matching filter criteria. Market makers can use this to poll RFQs directed to them.
Required minimum session key permission level is read_only
Parameters
| subaccount_id
integer
required
Subaccount ID for auth purposes, returned data will be scoped to this subaccount. |
| from_timestamp
integer
Earliest last_update_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) |
| rfq_id
string
RFQ ID filter, if applicable |
| rfq_subaccount_id
integer
Filter returned RFQs by rfq requestor subaccount |
| status
string
RFQ status filter, if applicable enum open filled cancelled expired |
| to_timestamp
integer
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
| 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.rfqs
array of objects
required
RFQs matching filter criteria |
| result.rfqs[].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.rfqs[].creation_timestamp
integer
required
Creation timestamp in ms since Unix epoch |
| result.rfqs[].filled_direction
string or null
required
Direction at which the RFQ was filled (only if filled) enum buy sell |
| result.rfqs[].last_update_timestamp
integer
required
Last update timestamp in ms since Unix epoch |
| result.rfqs[].rfq_id
string
required
RFQ ID |
| result.rfqs[].status
string
required
Status enum open filled cancelled expired |
| result.rfqs[].subaccount_id
integer
required
Subaccount ID |
| result.rfqs[].total_cost
string or null
required
Total cost for the RFQ (only if filled) |
| result.rfqs[].valid_until
integer
required
RFQ expiry timestamp in ms since Unix epoch |
| result.rfqs[].legs
array of objects
required
RFQ legs |
| result.rfqs[].legs[].amount
string
required
Amount in units of the base |
| result.rfqs[].legs[].direction
string
required
Leg direction enum buy sell |
| result.rfqs[].legs[].instrument_name
string
required
Instrument name |
Example
{request_example_shell}
{request_example_javascript}
{request_example_python}
The above command returns JSON structured like this:
{response_example_json}