> ## Documentation Index > Fetch the complete documentation index at: https://docs.joyride.exchange/llms.txt > Use this file to discover all available pages before exploring further. # rfq channel (pushes) > Delivered as `subscription` frames with `params.channel` `rfq` on a socket that called `rfq.subscribe`. Each push carries the whole request object. ## AsyncAPI ````yaml _generated/asyncapi.yaml rfq id: rfq title: rfq channel (pushes) description: >- Delivered as `subscription` frames with `params.channel` `rfq` on a socket that called `rfq.subscribe`. Each push carries the whole request object. servers: - id: trading protocol: wss host: joyride.exchange bindings: [] variables: [] address: rfq parameters: [] bindings: [] operations: - &ref_8 id: rfq.pushes title: Rfq.pushes type: send messages: - &ref_9 id: quote contentType: application/json payload: - name: quote description: >- A quote arrived on your request; `rfq.quote`, `rfq.best` and `rfq.funding` hold the best live price. Sent for every quote, so a later push may show a better price. type: object properties: - name: const type: string description: quote required: false - name: rfq type: object description: >- The caller's view of its own request, from `rfq.get`, `rfq.list`, and every `rfq` push. required: true properties: - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: client_ref type: string required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: side type: string description: >- The side named at creation; `two_way` when none was. Only this side (either on `two_way`) may be accepted. required: true - name: state type: string enumValues: - pending - quoted - accepted - submitting - filled - declined - expired - failed required: true - name: request_deadline type: string required: true - name: nearest_leg_close type: string description: >- RFC3339 UTC with milliseconds; the earliest expiry among the legs. required: false - name: deployment type: object description: >- The deployment the request is bound to. `quote.taker_subaccount` is the PDA for seeds `["subaccount", owner]` under `program_id`; a client can re-derive it, and it also appears in `quote.quote_payload`, which hashes to `quote_id`. required: false properties: - name: program_id type: string description: Solana base58 program id. required: true - name: deployment_id type: string required: true - name: config_pda type: string description: Solana base58 config PDA. required: true - name: quote type: object description: >- The one quote the taker is shown: the accepted quote once accepted; before that, on a `buy` request the best live ask and on a `sell` request the best live bid, which can change between pushes as better quotes land. Absent on a `two_way` request while it is quoted, because its best bid and best ask may be different makers' quotes: read `best`. required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: best type: object description: >- Present while `state` is `quoted`: the best live quote per side, possibly from different makers, and the only quotes a `two_way` request shows. Accept `ask` to buy and `bid` to sell. required: false properties: - name: bid type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: ask type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: funding type: object description: >- Present while the request is quoted and not yet accepted; each side computed from that side's best quote, recomputed from the live risk view. required: false properties: - name: anchored type: boolean description: >- Whether a durable subaccount anchor is covered by the live watcher heartbeat. required: true - name: free_balance type: string required: true - name: buy type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: sell type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: accepted_side type: string enumValues: - buy - sell required: false - name: tx_signature type: string description: Solana base58 transaction signature. required: false - name: fill_finality type: string enumValues: - confirmed - finalized - reverted required: false - name: decline_reason type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: decline_reasons type: array description: >- Each maker that declined this request, by reason, in arrival order; makers are not named. Present while the request is still `pending` and after it drains. required: false properties: - name: item type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: failure type: object required: false properties: - name: code type: string enumValues: - RFQ_ATTESTATION_FAILED - RFQ_TX_FAILED - RFQ_PRICE_TOLERANCE - RFQ_BALANCE_INSUFFICIENT - RFQ_FEE_LIMIT_EXCEEDED - RFQ_LOCK_LIMIT_EXCEEDED required: true - name: detail type: string required: false - name: tx_signature type: string required: false - name: onchain_code type: integer required: false - name: created_at type: string required: true - name: updated_at type: string required: true headers: [] jsonPayloadSchema: type: object additionalProperties: false required: - type - rfq properties: type: const: quote x-parser-schema-id: rfq: &ref_7 type: object description: >- The caller's view of its own request, from `rfq.get`, `rfq.list`, and every `rfq` push. properties: rfq_id: &ref_0 type: string pattern: ^[0-9a-f]{32}$ description: 16-byte RFQ id encoded as lowercase hexadecimal. x-parser-schema-id: RfqId client_ref: type: string format: uuid x-parser-schema-id: legs: &ref_1 type: array minItems: 1 maxItems: 13 items: type: object additionalProperties: false description: > One strategy leg as the venue returns it: the submitted `instrument` and `quantity` plus the instrument's resolved terms, which are the values the signed quote encodes for the leg. properties: instrument: type: string description: Listed instrument symbol. example: SOL_USDC-6MAR26-150-C x-parser-schema-id: quantity: allOf: - &ref_2 type: string pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]{1,6})?$ description: > Canonical signed decimal with at most six fractional digits. Negative zero, JSON numbers, exponents, and values outside the signed 64-bit 6dp range (`i64::MIN` excluded) are rejected. x-parser-schema-id: RfqSignedDecimal description: >- Non-zero signed 6dp contracts in taker-buy orientation. x-parser-schema-id: asset: type: integer enum: - 0 - 1 - 2 description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. x-parser-schema-id: strike: allOf: - &ref_3 type: string pattern: ^(0|[1-9][0-9]*)(\.[0-9]{1,6})?$ description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. x-parser-schema-id: RfqDecimal description: Strike in USDC, 6dp. x-parser-schema-id: expiry: type: integer description: Instrument expiry as Unix seconds. x-parser-schema-id: kind: type: string enum: - call - put x-parser-schema-id: required: - instrument - quantity - asset - strike - expiry - kind x-parser-schema-id: RfqResolvedLeg description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. x-parser-schema-id: RfqResolvedLegs side: allOf: - type: string enum: - buy - sell - two_way description: >- The taker's direction over the package (spec 16 §2.1); `two_way` is the direction-blind request. x-parser-schema-id: RfqRequestSide description: >- The side named at creation; `two_way` when none was. Only this side (either on `two_way`) may be accepted. x-parser-schema-id: state: type: string enum: - pending - quoted - accepted - submitting - filled - declined - expired - failed x-parser-schema-id: RfqState request_deadline: type: string format: date-time x-parser-schema-id: nearest_leg_close: type: string format: date-time description: >- RFC3339 UTC with milliseconds; the earliest expiry among the legs. x-parser-schema-id: deployment: allOf: - type: object description: >- The margin-vault deployment the request is bound to. `program_id` and `deployment_id` are copied into every signed quote and acceptance. properties: program_id: type: string description: Solana base58 program id. x-parser-schema-id: deployment_id: type: string pattern: ^[0-9a-f]{64}$ x-parser-schema-id: config_pda: type: string description: Solana base58 config PDA. x-parser-schema-id: required: - program_id - deployment_id - config_pda x-parser-schema-id: RfqDeployment description: >- The deployment the request is bound to. `quote.taker_subaccount` is the PDA for seeds `["subaccount", owner]` under `program_id`; a client can re-derive it, and it also appears in `quote.quote_payload`, which hashes to `quote_id`. x-parser-schema-id: quote: allOf: - &ref_4 type: object description: >- One maker's immutable signed quote as shown to the taker. The taker is never told which maker, or how many quoted. properties: quote_id: type: string pattern: ^[0-9a-f]{64}$ description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. x-parser-schema-id: QuoteId rfq_id: *ref_0 legs: *ref_1 bid: oneOf: - *ref_2 - type: 'null' x-parser-schema-id: description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. x-parser-schema-id: ask: oneOf: - *ref_2 - type: 'null' x-parser-schema-id: description: >- What the taker pays buying the package; `null` when the maker did not quote that side. x-parser-schema-id: maker_subaccount: type: string description: Solana base58 PDA. x-parser-schema-id: taker_subaccount: type: string description: Solana base58 PDA. x-parser-schema-id: issued_at: type: integer format: int64 x-parser-schema-id: expires_at: type: integer format: int64 x-parser-schema-id: max_maker_fee: *ref_3 max_maker_locked_balance: *ref_3 quote_payload: type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. x-parser-schema-id: maker_signature: type: string description: Base64 of the 64-byte Ed25519 signature. x-parser-schema-id: required: - quote_id - rfq_id - legs - bid - ask - maker_subaccount - taker_subaccount - issued_at - expires_at - max_maker_fee - max_maker_locked_balance - quote_payload - maker_signature x-parser-schema-id: QuoteObject description: >- The one quote the taker is shown: the accepted quote once accepted; before that, on a `buy` request the best live ask and on a `sell` request the best live bid, which can change between pushes as better quotes land. Absent on a `two_way` request while it is quoted, because its best bid and best ask may be different makers' quotes: read `best`. x-parser-schema-id: best: type: object description: >- Present while `state` is `quoted`: the best live quote per side, possibly from different makers, and the only quotes a `two_way` request shows. Accept `ask` to buy and `bid` to sell. properties: bid: oneOf: - *ref_4 - type: 'null' x-parser-schema-id: x-parser-schema-id: ask: oneOf: - *ref_4 - type: 'null' x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: funding: allOf: - type: object additionalProperties: false description: >- Live advisory funding view; the attestation signer remains authoritative. properties: anchored: type: boolean description: >- Whether a durable subaccount anchor is covered by the live watcher heartbeat. x-parser-schema-id: free_balance: oneOf: - *ref_3 - type: 'null' x-parser-schema-id: x-parser-schema-id: buy: oneOf: - &ref_5 type: object additionalProperties: false description: > Taker-perspective requirement for one accept side, computed from one frozen strategy risk view: `required = cash_debit + max_fee + lock_increase`. properties: required: allOf: - *ref_3 description: >- Free balance required to accept this side of the quote. x-parser-schema-id: estimate: type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. x-parser-schema-id: funded: type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. x-parser-schema-id: package_cash_delta: allOf: - *ref_2 description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. x-parser-schema-id: cash_debit: allOf: - *ref_3 description: '`max(-package_cash_delta, 0)`.' x-parser-schema-id: fee: allOf: - *ref_3 description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. x-parser-schema-id: max_fee: allOf: - *ref_3 description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. x-parser-schema-id: writer: type: boolean description: >- True when this side leaves the viewed party short at least one leg. x-parser-schema-id: lock_increase: allOf: - *ref_3 description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. x-parser-schema-id: post_fill_locked: allOf: - *ref_3 description: >- Unbuffered absolute lock for the viewed party after the fill. x-parser-schema-id: max_locked_balance: allOf: - *ref_3 description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. x-parser-schema-id: required: - required - estimate - funded x-parser-schema-id: RfqFundingRequirement - type: 'null' x-parser-schema-id: x-parser-schema-id: sell: oneOf: - *ref_5 - type: 'null' x-parser-schema-id: x-parser-schema-id: required: - anchored - free_balance - buy - sell x-parser-schema-id: RfqTakerFunding description: >- Present while the request is quoted and not yet accepted; each side computed from that side's best quote, recomputed from the live risk view. x-parser-schema-id: accepted_side: type: string enum: - buy - sell x-parser-schema-id: tx_signature: type: string description: Solana base58 transaction signature. x-parser-schema-id: fill_finality: type: string enum: - confirmed - finalized - reverted x-parser-schema-id: decline_reason: &ref_6 type: string enum: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. x-parser-schema-id: RfqDeclineReason decline_reasons: type: array items: *ref_6 description: >- Each maker that declined this request, by reason, in arrival order; makers are not named. Present while the request is still `pending` and after it drains. x-parser-schema-id: failure: type: object properties: code: type: string enum: - RFQ_ATTESTATION_FAILED - RFQ_TX_FAILED - RFQ_PRICE_TOLERANCE - RFQ_BALANCE_INSUFFICIENT - RFQ_FEE_LIMIT_EXCEEDED - RFQ_LOCK_LIMIT_EXCEEDED x-parser-schema-id: detail: type: string x-parser-schema-id: tx_signature: type: string x-parser-schema-id: onchain_code: type: integer x-parser-schema-id: required: - code x-parser-schema-id: created_at: type: string format: date-time x-parser-schema-id: updated_at: type: string format: date-time x-parser-schema-id: required: - rfq_id - client_ref - legs - side - state - request_deadline - created_at - updated_at x-parser-schema-id: RfqObject x-parser-schema-id: RfqQuotePush title: Quote description: >- A quote arrived on your request; `rfq.quote`, `rfq.best` and `rfq.funding` hold the best live price. Sent for every quote, so a later push may show a better price. example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: quote - &ref_10 id: state contentType: application/json payload: - name: state description: Your request changed state. type: object properties: - name: const type: string description: state required: false - name: rfq type: object description: >- The caller's view of its own request, from `rfq.get`, `rfq.list`, and every `rfq` push. required: true properties: - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: client_ref type: string required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: side type: string description: >- The side named at creation; `two_way` when none was. Only this side (either on `two_way`) may be accepted. required: true - name: state type: string enumValues: - pending - quoted - accepted - submitting - filled - declined - expired - failed required: true - name: request_deadline type: string required: true - name: nearest_leg_close type: string description: >- RFC3339 UTC with milliseconds; the earliest expiry among the legs. required: false - name: deployment type: object description: >- The deployment the request is bound to. `quote.taker_subaccount` is the PDA for seeds `["subaccount", owner]` under `program_id`; a client can re-derive it, and it also appears in `quote.quote_payload`, which hashes to `quote_id`. required: false properties: - name: program_id type: string description: Solana base58 program id. required: true - name: deployment_id type: string required: true - name: config_pda type: string description: Solana base58 config PDA. required: true - name: quote type: object description: >- The one quote the taker is shown: the accepted quote once accepted; before that, on a `buy` request the best live ask and on a `sell` request the best live bid, which can change between pushes as better quotes land. Absent on a `two_way` request while it is quoted, because its best bid and best ask may be different makers' quotes: read `best`. required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: best type: object description: >- Present while `state` is `quoted`: the best live quote per side, possibly from different makers, and the only quotes a `two_way` request shows. Accept `ask` to buy and `bid` to sell. required: false properties: - name: bid type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: ask type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: funding type: object description: >- Present while the request is quoted and not yet accepted; each side computed from that side's best quote, recomputed from the live risk view. required: false properties: - name: anchored type: boolean description: >- Whether a durable subaccount anchor is covered by the live watcher heartbeat. required: true - name: free_balance type: string required: true - name: buy type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: sell type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: accepted_side type: string enumValues: - buy - sell required: false - name: tx_signature type: string description: Solana base58 transaction signature. required: false - name: fill_finality type: string enumValues: - confirmed - finalized - reverted required: false - name: decline_reason type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: decline_reasons type: array description: >- Each maker that declined this request, by reason, in arrival order; makers are not named. Present while the request is still `pending` and after it drains. required: false properties: - name: item type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: failure type: object required: false properties: - name: code type: string enumValues: - RFQ_ATTESTATION_FAILED - RFQ_TX_FAILED - RFQ_PRICE_TOLERANCE - RFQ_BALANCE_INSUFFICIENT - RFQ_FEE_LIMIT_EXCEEDED - RFQ_LOCK_LIMIT_EXCEEDED required: true - name: detail type: string required: false - name: tx_signature type: string required: false - name: onchain_code type: integer required: false - name: created_at type: string required: true - name: updated_at type: string required: true headers: [] jsonPayloadSchema: type: object additionalProperties: false required: - type - rfq properties: type: const: state x-parser-schema-id: rfq: *ref_7 x-parser-schema-id: RfqStatePush title: State description: Your request changed state. example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: state - &ref_11 id: finality contentType: application/json payload: - name: finality description: '`rfq.fill_finality` moved to `finalized` or `reverted`.' type: object properties: - name: const type: string description: finality required: false - name: rfq type: object description: >- The caller's view of its own request, from `rfq.get`, `rfq.list`, and every `rfq` push. required: true properties: - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: client_ref type: string required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: side type: string description: >- The side named at creation; `two_way` when none was. Only this side (either on `two_way`) may be accepted. required: true - name: state type: string enumValues: - pending - quoted - accepted - submitting - filled - declined - expired - failed required: true - name: request_deadline type: string required: true - name: nearest_leg_close type: string description: >- RFC3339 UTC with milliseconds; the earliest expiry among the legs. required: false - name: deployment type: object description: >- The deployment the request is bound to. `quote.taker_subaccount` is the PDA for seeds `["subaccount", owner]` under `program_id`; a client can re-derive it, and it also appears in `quote.quote_payload`, which hashes to `quote_id`. required: false properties: - name: program_id type: string description: Solana base58 program id. required: true - name: deployment_id type: string required: true - name: config_pda type: string description: Solana base58 config PDA. required: true - name: quote type: object description: >- The one quote the taker is shown: the accepted quote once accepted; before that, on a `buy` request the best live ask and on a `sell` request the best live bid, which can change between pushes as better quotes land. Absent on a `two_way` request while it is quoted, because its best bid and best ask may be different makers' quotes: read `best`. required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: best type: object description: >- Present while `state` is `quoted`: the best live quote per side, possibly from different makers, and the only quotes a `two_way` request shows. Accept `ask` to buy and `bid` to sell. required: false properties: - name: bid type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: ask type: object required: false properties: - name: quote_id type: string description: >- SHA-256 of the canonical 1,066-byte StrategyQuotePayload. required: true - name: rfq_id type: string description: 16-byte RFQ id encoded as lowercase hexadecimal. required: true - name: legs type: array description: >- Ordered strategy legs, in the taker's submitted order, with resolved terms. required: true properties: - name: instrument type: string description: Listed instrument symbol. required: true - name: quantity type: string description: >- Non-zero signed 6dp contracts in taker-buy orientation. required: true - name: asset type: integer description: Underlying id; 0 is BTC, 1 is ETH, 2 is SOL. enumValues: - 0 - 1 - 2 required: true - name: strike type: string description: Strike in USDC, 6dp. required: true - name: expiry type: integer description: Instrument expiry as Unix seconds. required: true - name: kind type: string enumValues: - call - put required: true - name: bid type: string description: >- What the taker receives selling the package; `null` when the maker did not quote that side. At least one of `bid` / `ask` is a price. required: true - name: ask type: string description: >- What the taker pays buying the package; `null` when the maker did not quote that side. required: true - name: maker_subaccount type: string description: Solana base58 PDA. required: true - name: taker_subaccount type: string description: Solana base58 PDA. required: true - name: issued_at type: integer required: true - name: expires_at type: integer required: true - name: max_maker_fee type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: max_maker_locked_balance type: string description: >- Canonical unsigned decimal with at most six fractional digits; JSON numbers and exponents are rejected. required: true - name: quote_payload type: string description: >- Base64 of the canonical 1,066-byte v3 StrategyQuotePayload. required: true - name: maker_signature type: string description: Base64 of the 64-byte Ed25519 signature. required: true - name: funding type: object description: >- Present while the request is quoted and not yet accepted; each side computed from that side's best quote, recomputed from the live risk view. required: false properties: - name: anchored type: boolean description: >- Whether a durable subaccount anchor is covered by the live watcher heartbeat. required: true - name: free_balance type: string required: true - name: buy type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: sell type: object required: true properties: - name: estimate type: boolean description: >- True only for a writer-side requirement computed over a never-anchored empty portfolio. required: true - name: funded type: boolean description: >- True only for a non-estimated requirement with a covered anchor and `free_balance >= required`. required: true - name: package_cash_delta type: string description: >- Signed cash movement before fees from the viewed party's seat; positive means that party receives premium. required: false - name: cash_debit type: string description: '`max(-package_cash_delta, 0)`.' required: false - name: fee type: string description: >- The viewed party's trading fee over the current prices, using its taker or maker tier as appropriate: per leg `min(index_notional × fee_bps / 10000, leg_value × trade_fee_cap_bps / 10000)`, floored and summed. required: false - name: max_fee type: string description: >- `fee` with the venue's signed-fee tolerance applied and rounded up once; the figure to sign as the fee maximum. `required` funds it, and the signer refuses a fill whose exact fee exceeds the signed maximum. required: false - name: writer type: boolean description: >- True when this side leaves the viewed party short at least one leg. required: false - name: lock_increase type: string description: >- `max(post_fill_locked - current_locked, 0)`; zero when the viewed party is not a writer. required: false - name: post_fill_locked type: string description: >- Unbuffered absolute lock for the viewed party after the fill. required: false - name: max_locked_balance type: string description: >- Current lock plus `lock_increase` with the venue's signed-lock tolerance applied and rounded up once; the figure to sign as the lock maximum. Equals `post_fill_locked` when the party is not a writer. required: false - name: accepted_side type: string enumValues: - buy - sell required: false - name: tx_signature type: string description: Solana base58 transaction signature. required: false - name: fill_finality type: string enumValues: - confirmed - finalized - reverted required: false - name: decline_reason type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: decline_reasons type: array description: >- Each maker that declined this request, by reason, in arrival order; makers are not named. Present while the request is still `pending` and after it drains. required: false properties: - name: item type: string description: >- The six maker reasons, plus `timeout` (the window closed with no quote) and `leg_not_tradable` (a leg stopped trading while the request was open), which only the venue sets. enumValues: - unlisted_instrument - near_expiry - size_limit - stale_data - low_confidence - queue_overflow - timeout - leg_not_tradable required: false - name: failure type: object required: false properties: - name: code type: string enumValues: - RFQ_ATTESTATION_FAILED - RFQ_TX_FAILED - RFQ_PRICE_TOLERANCE - RFQ_BALANCE_INSUFFICIENT - RFQ_FEE_LIMIT_EXCEEDED - RFQ_LOCK_LIMIT_EXCEEDED required: true - name: detail type: string required: false - name: tx_signature type: string required: false - name: onchain_code type: integer required: false - name: created_at type: string required: true - name: updated_at type: string required: true headers: [] jsonPayloadSchema: type: object additionalProperties: false required: - type - rfq properties: type: const: finality x-parser-schema-id: rfq: *ref_7 x-parser-schema-id: RfqFinalityPush title: Finality description: '`rfq.fill_finality` moved to `finalized` or `reverted`.' example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: finality bindings: [] extensions: - id: x-parser-unique-object-id value: rfq sendOperations: [] receiveOperations: - *ref_8 sendMessages: [] receiveMessages: - *ref_9 - *ref_10 - *ref_11 extensions: - id: x-parser-unique-object-id value: rfq securitySchemes: [] ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.