HomeDocumentationAPI Reference
Log In
API Reference

(Wallet) Rfqs

Channel Name Schema

{wallet}.rfqs

Subscribe to RFQs directed to a given wallet.

Channel Parameters

walletstringrequired
Account (wallet) of RFQ market maker

Notification Data

channelstringrequired
Subscribed channel name
dataarray of objectsrequired
data[].cancel_reasonstringrequired
Cancel reason, if any
enum user_requestinsufficient_marginsigned_max_fee_too_lowmmp_triggercancel_on_disconnectsession_key_deregisteredsubaccount_withdrawnrfq_no_longer_opencompliance
data[].creation_timestampintegerrequired
Creation timestamp in ms since Unix epoch
data[].fill_ratestring or nullrequired
Average taker fill rate, from 0 to 1. Returns null for users with insufficient RFQ history.
data[].filled_directionstring or nullrequired
Direction at which the RFQ was filled (only if filled)
enum buysell
data[].filled_pctstringrequired
Percentage of the RFQ that has been filled, from 0 to 1.
data[].last_update_timestampintegerrequired
Last update timestamp in ms since Unix epoch
data[].partial_fill_stepstringrequired
Step size for partial fills (default: 1)
data[].preferred_directionstring or nullrequired
If disclosed, the direction the user is aiming to execute as.
enum buysell
data[].recent_fill_ratestring or nullrequired
Taker fill rate, weighted towards the recent several days of activity, from 0 to 1. Returns null for users with insufficient recent RFQ history.
data[].reducing_directionstring or nullrequired
If applicable, the direction from user's perspective that would reduce their position in each leg.
enum buysell
data[].rfq_idstringrequired
RFQ ID
data[].statusstringrequired
Status
enum openfilledcancelledexpired
data[].subaccount_idintegerrequired
Subaccount ID
data[].total_coststring or nullrequired
Total cost for the RFQ (only if filled)
data[].valid_untilintegerrequired
RFQ expiry timestamp in ms since Unix epoch
data[].walletstringrequired
Wallet address of the RFQ sender
data[].legsarray of objectsrequired
RFQ legs
data[].legs[].amountstringrequired
Amount in units of the base
data[].legs[].directionstringrequired
Leg direction
enum buysell
data[].legs[].instrument_namestringrequired
Instrument name

Example

Subscriptions are only available via websockets.

{request_example_javascript}
{request_example_python}

Notification messages on this channel will look like this:

{response_example_json}