WebSocket API Quickstart

Get your API key

You’ll need an API key to authenticate your requests. You can create one in Profile -> Keys.More information about API keys can be found on the Authentication page.

Install WebSocket client

We recommend using websocat for testing WebSocket connections.

brew install websocat

wget -qO websocat https://github.com/vi/websocat/releases/latest/download/websocat.x86_64-unknown-linux-musl
chmod a+x websocat
sudo mv websocat /usr/local/bin/

Pre-built binaries for Windows, OS X and Android are available on the releases page: https://github.com/vi/websocat/releases

Connect

Connect to the WebSocket API using your API key. Replace <YOUR_API_KEY> with your actual key.

websocat -H='api-key: <YOUR-API-KEY>' wss://api.xchangeapi.com/websocket/live

You won’t receive a confirmation message upon connecting. You can proceed directly to the next step.

Once connected, paste the following JSON message to subscribe to currency pairs:

{"pairs": ["EURUSD", "GBPUSD"]}

Receive Data

You will receive an initial message followed by live updates.

0{"session_uid":"572733aab7e148cb852564cd5eef5d14","time_mult":1000,"start_time":1766933673.1651759148,"order":["name","ask","bid","time"],"mapping":{"1":"GBPUSD","0":"EURUSD"}}
10|1.17714|1.17680|-14373540
11|1.35004|1.34965|-14373539

What’s Next

Now that you’re connected, check out these resources to build your integration:

Protocol Overview

Learn about the WebSocket protocol details and message format.

Example Implementation

See a complete example implementation in JavaScript and Node.js.

Getting Started

HTTP API Reference

Websocket API Reference

Guides & Recipes

What’s Next

Protocol Overview

Example Implementation

​What’s Next

Protocol Overview

Example Implementation

What’s Next