HomeDocumentationAPI Reference
Log In
API Reference

Get Rfqs

Method Name

private/get_rfqs

Retrieves 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_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

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[]. ask_total_cost  string or null required
Ask total cost for the RFQ implied from orderbook (as sell)

result.rfqs[]. bid_total_cost  string or null required
Bid total cost for the RFQ implied from orderbook (as buy)

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[]. counterparties  array of strings or null required
List of requested counterparties, if applicable

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[]. filled_pct  string required
Percentage of the RFQ that has been filled, from 0 to 1.

result.rfqs[]. label  string required
User-defined label, if any

result.rfqs[]. last_update_timestamp  integer required
Last update timestamp in ms since Unix epoch

result.rfqs[]. mark_total_cost  string or null required
Mark total cost for the RFQ (assuming buy direction)

result.rfqs[]. max_total_cost  string or null required
Max total cost for the RFQ

result.rfqs[]. min_total_cost  string or null required
Min total cost for the RFQ

result.rfqs[]. partial_fill_step  string required
Step size for partial fills (default: 1)

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[]. wallet  string required
Wallet address of the RFQ sender

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}