Getting started

Additionally YouHodler Converts API provides a WebSocket interface for receiving real-time market rates and convert status updates.

Connection

Connection URL: wss://api.youhodler.com/partners/ws

Authentication

A valid API key must be provided in the request headers as x-apikey.

If the API key is missing or invalid, the server sends an error payload and closes the connection.

Message format

All messages are exchanged in JSON format.

Each client request must contain:

FieldTypeDescription
channelstringChannel name (rates or exchange)
actionstringAction to perform (subscribe or unsubscribe)
dataobjectRequest payload for the selected channel

Channel-specific request/response examples are documented on the Channels page.

Error payload format is documented on the Error Messages page.