Methods

Connect
Subscribe
Unsubscribe

Connect

Connect to the server to receive real-time prices.

URL Schema

wss://{ subdomain }.finage.ws: { port }/?token={ token }Your assigned WebSocket URL is in your dashboard under the WebSocket section.

How to Connect

To connect, open a WebSocket connection using your assigned URL in your dashboard.

Once connected, you can subscribe to tickers and receive real-time prices as defined in our WebSocket documentation — no additional setup is required.

After Connection

1st Message

{
  "status_code": 200,
  "message": "authorizing",
  "id": "e0fb1b68-1905-48e3-9fd2-d482bf5e1f0a"
}

2nd Message

{
  "status_code": 200,
  "message": "connected to the adapter",
  "id": "e0fb1b68-1905-48e3-9fd2-d482bf5e1f0a"
}

Error Messages

401 - invalid socket key
401 - use your socket key to connect
401 - please upgrade your package to access this market

URL Parameters

Subdomain Our data stream is divided into sections, called subdomains. You can view your specific subdomain on your dashboard. We separate streams in this way to ensure a more stable and reliable flow of data.
Port Port of your server. You can view your specific port on your dashboard.
Token Your unique token, also known as the socket key, is available on your dashboard.