Get started

Are you familiar with Docker? Fantastic! We have prepared a simple Docker image that allows you to check how our Websocket API works.

Step 1. Prepare your local environment

To run our Docker image, please follow the official instruction of installing Docker. If you already have Docker installed on your machine, you can skip this step.

Step 2. Prepare your API key

If you are a registered user, please sign in to your account and copy your API key. Don't have an account yet? Register it here. It's free. You don't need to provide your credit card details.

Step 3. Decide which of available currency pairs you want to track.

Visit the list of the available currencies and choose which of them you want to track using our API.

Step 4. Run Docker container

Execute the following command:

docker run -e API_KEY=your-api-key -e CURRENCY_PAIRS=comma-separated-list-of-selected-currency-pairs -it xchangeapi/websocket

For example:

docker run -e API_KEY=your-api-key -e CURRENCY_PAIRS=GBPEUR,USDCHF,JPYNOK,EURINR -it xchangeapi/websocket

If everything went good, you will get:

       ____ _                               _    ____ ___
__  __/ ___| |__   __ _ _ __   __ _  ___   / \  |  _ \_ _|  ___ ___  _ __ ___
\ \/ / |   | '_ \ / _` | '_ \ / _` |/ _ \ / _ \ | |_) | |  / __/ _ \| '_ ` _ \
 >  <| |___| | | | (_| | | | | (_| |  __// ___ \|  __/| | | (_| (_) | | | | | |
/_/\_\\____|_| |_|\__,_|_| |_|\__, |\___/_/   \_\_|  |___(_)___\___/|_| |_| |_|
                              |___/

Consistent, reliable exchange rates.

2020-04-26 14:28:43,697 API connection opened.
2020-04-26 14:28:43,796 Received update for JPYNOK (ASK price: 9.90322, BID price: 9.84720)
2020-04-26 14:28:43,796 Received update for USDCHF (ASK price: 0.97430, BID price: 0.97397)
2020-04-26 14:28:43,797 Received update for EURINR (ASK price: 81.81094, BID price: 81.78262)
2020-04-26 14:28:43,797 Received update for GBPEUR (ASK price: 1.14418, BID price: 1.14372)