Authenticate session

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

Authenticates the WebSocket session so that you can subscribe to RFQ channels and submit firm quotes.

Before you send the authenticate action, you must create the signature. To learn how, see Step 1: Create a signature.

Request

Schema

Body

actionstringrequired
Set to authenticate to start the session.
Possible values: [authenticate]
Example: authenticate
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
keystringrequired
Your Bitvavo API key.
Example: bva_uat_maker_7f3a2c1d
signaturestringrequired
The HMAC-SHA256 hex-encoded signature over the string <timestamp>GET/rfq/v1, computed with your API secret.
Example: 118067f093bef0f7b99bbc2a967a000fa288226d24b5c8ebc10e9cfb4229a6fa
timestampinteger<int64>required
A Unix timestamp in milliseconds.
Example: 1739462400123
windowinteger
The time in milliseconds in which your request is allowed to execute. Default 10000, maximum 60000.
Possible values: >= 1 and <= 60000
Example: 10000

Example (body)

{
  "action": "authenticate",
  "requestId": 9021001,
  "key": "bva_uat_maker_7f3a2c1d",
  "signature": "118067f093bef0f7b99bbc2a967a000fa288226d24b5c8ebc10e9cfb4229a6fa",
  "timestamp": 1739462400123,
  "window": 10000
}

Response

authenticated

Schema

Schema

eventstringrequired
Confirmation that the server accepted the authentication.
Possible values: [authenticate]
Example: authenticate
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
authenticatedbooleanrequired
Indicates whether the session is now authenticated.
Example: true

Example (body)

{
  "event": "authenticate",
  "requestId": 9021001,
  "authenticated": true
}

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