Unsubscribe from RFQ requests

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

Unsubscribes from rfqRequest and rfqTermination events for the specified rfqTypes.

RFQ sessions that you are already participating in continue to their final state, so you may still receive rfqTermination events for those sessions.

Unsubscribing removes the listed types entirely, including their markets filters. The server ignores markets in an unsubscribe action. To stop receiving a single market, subscribe again with only the markets you still want.

Request

Schema

Body

actionstringrequired
Set to unsubscribe to end the subscription.
Possible values: [unsubscribe]
Example: unsubscribe
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 unsubscribe from.
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]
marketsstring[]
Optional. The markets for which you receive rfqRequest events. If you omit this field, you receive every market. An empty list matches no market. Ignored in an unsubscribe action.
Possible values: <= 1000
]

Example (body)

{
  "action": "unsubscribe",
  "requestId": 9021003,
  "channels": [
    {
      "name": "rfqRequests",
      "rfqTypes": [
        "priceGuarantee"
      ]
    }
  ]
}

Response

unsubscribed

Schema

Schema

eventstringrequired
Confirmation that the server accepted the unsubscription, together with the list of subscriptions that remain active for your session.
Possible values: [unsubscribed]
Example: unsubscribed
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]
marketFilters object[]
The markets filters that are active on your session, one entry per filtered RFQ type. Omitted when none of your subscriptions has a filter.
Array [
rfqTyperequired
marketsstring[]required
The markets for which you receive rfqRequest events of this type.
Possible values: Value must match regular expression ^[A-Z0-9]+-[A-Z0-9]+$
]

Example (body)

{
  "event": "unsubscribed",
  "subscriptions": {
    "rfqRequests": [
      "priceGuarantee"
    ]
  }
}

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."
}