Getting Started

Feed Authentication

  1. Generate an SSH key pair by following the instructions below.

  2. Upon generating the SSH key pair, send an e-mail to [email protected] with a specified username to connect to the SSH Feed, along with your public key attached.

  3. You will be notified once your username has been authorised.

Mac OS X

  1. Open the Terminal application.

  2. Enter the following command in the Terminal window and hit enter:

    ssh-keygen -t rsa
  3. You will be prompted to specify the directory to store the key and a passphrase. Follow these prompts accordingly.

  4. Navigate to the specified directory to retrieve your public key (.pub file)

Windows

  1. Open the Command Prompt application.

  2. Enter the following command in the Command Prompt window and hit enter:

    ssh-keygen -t rsa
  3. You will be prompted to specify the directory to store the generated keys and a passphrase. Follow these prompts accordingly.

  4. Navigate to the specified directory to retrieve your public key (.pub file)

Testing the Connection

  1. Open up either the Terminal or Command Prompt application (depending on whether you're using Mac OS or Windows).

  2. Enter the following command and hit enter:

Staging (we support port 22 and 2093)

Prod (we support port 22 and 2093)

Note: you will need to replace [username] with the username given from the Feed Authentication section and [private key path] with the path to your private key file i.e.

  1. You will be prompted to enter in your passphrase, enter this in accordingly. This will connect you to the feed.

  2. After entering in your password, immediately enter the following command and hit enter:

If this isn't done within 10 seconds upon connection, we will disconnect with this message

The response to the "init" request will contain a unique session_id. Please provide this session id when raising any queries regarding the messages received for a given session as per below

From this time, we will start sending heartbeats

Please be aware that the init alone is not going to start the data flow process and at this point you should explicitly subscribe to either all or selected markets. This is covered here.

Last updated

Was this helpful?