Subscribe to RFQ requests

REQUEST wss://connection.bitvavo.com:8004/rfq/v1 rfqRequests

Subscribes to rfqRequest and rfqTermination events for the specified rfqTypes. Once subscribed, the server sends events whenever a taker starts, refreshes, or ends an RFQ session that matches your subscription.

Request

Schema

Body

actionstringrequired
Set to subscribe to start the subscription.
Possible values: [subscribe]
Example: subscribe
requestIdinteger<int64>
An identifier that you assign to the request. The server echoes it back in the matching response so you can correlate the two.
Example: 9021001
channels object[]required
The channels to subscribe to.
Array [
namestringrequired
The name of the channel. Currently, rfqRequests is the only available channel. It streams rfqRequest and rfqTermination events.
Possible values: [rfqRequests]
rfqTypesstring[]required
The types of RFQ requests to subscribe to. Possible values:
• priceGuarantee — the standard Price Guarantee RFQ for spot markets.
• priceGuaranteeUK — the Price Guarantee RFQ variant for United Kingdom customers.
• priceGuaranteeConvert — the Price Guarantee RFQ variant used for asset-to-asset conversions (the Convert product).
Possible values: [priceGuarantee, priceGuaranteeUK, priceGuaranteeConvert]
]

Example (body)

{
  "action": "subscribe",
  "requestId": 9021002,
  "channels": [
    {
      "name": "rfqRequests",
      "rfqTypes": [
        "priceGuarantee",
        "priceGuaranteeConvert"
      ]
    }
  ]
}

Response

subscribed

Schema

Schema

eventstringrequired

Confirmation that the server accepted the subscription, together with the list of subscriptions that are active for your session.

Possible values: [subscribed]

Example: subscribed

requestIdinteger<int64>

An identifier that you assign to the request. The server echoes it back in the matching response so you can correlate the two.

Example: 9021001

subscriptions objectrequired

The subscriptions that are currently active on your session, grouped by channel.

rfqRequestsstring[]required

The RFQ types that are currently active on the rfqRequests channel. Possible values:

• priceGuarantee — the standard Price Guarantee RFQ for spot markets.
• priceGuaranteeUK — the Price Guarantee RFQ variant for United Kingdom customers.
• priceGuaranteeConvert — the Price Guarantee RFQ variant used for asset-to-asset conversions (the Convert product).

Possible values: [priceGuarantee, priceGuaranteeUK, priceGuaranteeConvert]

Example (body)

{
  "event": "subscribed",
  "subscriptions": {
    "rfqRequests": [
      "priceGuarantee",
      "priceGuaranteeConvert"
    ]
  }
}

rfqRequest

Schema

Schema

eventstringrequired
The details of a new RFQ session, or a refresh of an active session. Includes base, quote, takerSide, amount, and collectionWindowMs.
Possible values: [rfqRequest]
Example: rfqRequest
rfqIdinteger<int64>required
The unique identifier of the RFQ session.
Example: 840001234567
rfqCycleIdinteger<int32>required
The identifier of the current cycle within the RFQ session. A cycle is one round of quote collection. It begins when the taker starts or refreshes the RFQ session, and ends when the collection window closes.
The value starts at 0 for the first cycle, and increases by 1 each time the taker refreshes the RFQ.
Example: 2
rfqTypestringrequired
The type of the RFQ. Possible values:
• priceGuarantee — the standard Price Guarantee RFQ for spot markets.
• priceGuaranteeUK — the Price Guarantee RFQ variant for United Kingdom customers.
• priceGuaranteeConvert — the Price Guarantee RFQ variant used for asset-to-asset conversions (the Convert product).
Possible values: [priceGuarantee, priceGuaranteeUK, priceGuaranteeConvert]
Example: priceGuarantee
basestringrequired
The code of the asset (for example, BTC or EUR).
Example: BTC
quoterequired
takerSidestringrequired
The side of the trade from the perspective of the taker. Possible values:
• BUY — the taker buys the base asset.
• SELL — the taker sells the base asset.
Possible values: [BUY, SELL]
Example: BUY
amountTypestringrequired
The asset in which amount is denominated. Possible values:
• BASE — amount is denominated in the base asset.
• QUOTE — amount is denominated in the quote asset.
Possible values: [BASE, QUOTE]
Example: BASE
amountstringrequired
The amount that the taker requests, denominated in the asset indicated by amountType.
Example: 0.25000000
requestedFirmMsinteger<int64>required
The duration in milliseconds for which the taker requests the quote to remain firm. Measured from the timestamp in this message. For Price Guarantee, the value is 5000 ms.
Example: 5000
expiresAfterMsinteger<int64>required
The time in milliseconds during which the RFQ remains valid after requestedFirmMs ends. The RFQ expires only if no refresh arrives within requestedFirmMs + expiresAfterMs after timestamp. For Price Guarantee, the value is typically <= 5000 ms.
Example: 5000
collectionWindowMsinteger<int32>required
The duration of the collection window in milliseconds for this cycle. Submit your firm quote before the window closes. For Price Guarantee, the value is 100 ms.
Example: 100
makerFeeBpsstringrequired
The maker fee in basis points.
Example: 80.0
feeCurrencyrequired
timestampinteger<int64>required
A Unix timestamp in milliseconds.
Example: 1739462400123

Example (body)

{
  "event": "rfqRequest",
  "rfqId": 840001234567,
  "rfqCycleId": 2,
  "rfqType": "priceGuarantee",
  "base": "BTC",
  "quote": "EUR",
  "takerSide": "BUY",
  "amountType": "BASE",
  "amount": "0.25000000",
  "requestedFirmMs": 5000,
  "expiresAfterMs": 5000,
  "collectionWindowMs": 100,
  "makerFeeBps": "80.0",
  "feeCurrency": "EUR",
  "timestamp": 1739462400200
}

rfqTermination

Schema

Schema

eventstringrequired
The final outcome of the RFQ session, and your result as a maker. The server delays delivery so that the winning maker has time to hedge, and other participants cannot infer the outcome from the timing.
Possible values: [rfqTermination]
Example: rfqTermination
rfqIdinteger<int64>required
The unique identifier of the RFQ session.
Example: 840001234567
rfqCycleIdinteger<int32>required
The identifier of the current cycle within the RFQ session. A cycle is one round of quote collection. It begins when the taker starts or refreshes the RFQ session, and ends when the collection window closes.
The value starts at 0 for the first cycle, and increases by 1 each time the taker refreshes the RFQ.
Example: 2
rfqTypestringrequired
The type of the RFQ. Possible values:
• priceGuarantee — the standard Price Guarantee RFQ for spot markets.
• priceGuaranteeUK — the Price Guarantee RFQ variant for United Kingdom customers.
• priceGuaranteeConvert — the Price Guarantee RFQ variant used for asset-to-asset conversions (the Convert product).
Possible values: [priceGuarantee, priceGuaranteeUK, priceGuaranteeConvert]
Example: priceGuarantee
basestringrequired
The code of the asset (for example, BTC or EUR).
Example: BTC
quoterequired
quoteIdinteger<int64>
The internal identifier of the quote, assigned by Bitvavo. Used for tracing and reporting.
Example: 90011223344
rfqStatusstringrequired
The final status of the RFQ session. Possible values:
• completed — the RFQ completed, and the taker accepted a quote.
• expired — the taker stopped responding. No refresh arrived within requestedFirmMs + expiresAfterMs.
• noQuotes — no maker submitted a quote during the collection window.
• error — the RFQ ended in an unexpected error state.
Possible values: [completed, expired, noQuotes, error]
Example: completed
makerResultstringrequired
Your outcome for this RFQ session. Possible values:
• traded — your quote won, and the trade settled successfully.
• lost — another maker submitted a better quote.
• noTrade — no trade took place. Either the RFQ expired, or no quotes arrived during the collection window.
• makerSettlementFailed — your quote won, but the settlement on your side failed.
• takerSettlementFailed — your quote won, but the settlement on the taker side failed.
Possible values: [traded, lost, noTrade, makerSettlementFailed, takerSettlementFailed]
Example: lost
timestampinteger<int64>required
A Unix timestamp in milliseconds.
Example: 1739462400123

Example (body)

{
  "event": "rfqTermination",
  "rfqId": 840001234567,
  "rfqCycleId": 2,
  "rfqType": "priceGuarantee",
  "base": "BTC",
  "quote": "EUR",
  "rfqStatus": "completed",
  "makerResult": "lost",
  "timestamp": 1739462405400
}

error

Schema

Schema

actionstring
The action that caused the error, if applicable.
Example: subscribe
eventstringrequired
The details of an error returned by the server.
Possible values: [error]
Example: error
errorCodeintegerrequired
The Bitvavo error code.
Example: 320
errorstringrequired
A human-readable description of the error.
Example: RFQ maker access required. Contact Bitvavo to enable RFQ participation.
requestIdinteger<int64>
An identifier that you assign to the request. The server echoes it back in the matching response so you can correlate the two.
Example: 9021001
operatorIdinteger<int64>
The numeric identifier of the operator.
Example: 12345

Example (body)

{
  "action": "subscribe",
  "event": "error",
  "errorCode": 320,
  "error": "RFQ maker access required. Contact Bitvavo to enable RFQ participation."
}