Skip to content
QuantLabTickDirect

DocsGetting started

Quickstart

The steps from subscribing to a plan to receiving ticks with the Python sample.

1. Subscribe to a plan

On the ggguilds product page, choose the plan that matches the number of IP addresses you will connect from at the same time. You pay in USDC from Coinbase Wallet, and the subscription renews every 30 days. For the differences between plans, see Plans and limits.

2. Issue an API key

Once your first payment is confirmed, you can issue an API key on the "API keys" tab of the ggguilds contract page.

  • You receive a key ID (a value starting with ggg_) and a private key (a PKCS#8 PEM file).
  • The private key is shown only once, when you issue it. Do not put it in source code or logs; keep it in a file with restricted access permissions or similar. If it leaks, reissue the key from the contract page (the old key stops working).
  • It takes up to about a minute before a newly issued key works on the Tick servers. Until then, authentication is rejected with UnknownKey.

3. Choose a server

  • Tokyo18 symbols

    tokyo-alpha-1.tick.quantlab.fi:17000

    AWS Tokyo Regionap-northeast-1

  • Singapore18 symbols

    singapore-alpha-1.tick.quantlab.fi:17000

    AWS Singapore Regionap-southeast-1

  • London20 symbols

    london-alpha-1.tick.quantlab.fi:17000

    AWS London Regioneu-west-2

  • New York11 symbols

    newyork-alpha-1.tick.quantlab.fi:17000

    AWS New York Local Zoneus-east-1-nyc-2a

  • Allow your client to send to port 17000/UDP on the Tick server. Replies and ticks from the Tick server arrive on the socket you sent from.
  • Only IPv4 is supported.
  • Running your client in the same AWS Region as the Tick server shortens the time it takes ticks to reach you.

4. Receive ticks with the Python sample

You need Python 3.10 or later and PyJWT.

pip install "pyjwt[crypto]"
curl -O https://quantlab.fi/downloads/freqrelay_client.py
python freqrelay_client.py --server tokyo-alpha-1.tick.quantlab.fi:17000 \
  --key-id ggg_xxxxxxxx --key-file ggguilds-api-key.pem \
  --symbols EURUSD,USDJPY

After authenticating and subscribing, the sample prints each tick, and prints a summary every 5 seconds.

Authenticated
Subscribed to 2 symbols: EURUSD, USDJPY
EURUSD bid=1.08529 ask=1.08540 upstream=09:41:08.108Z
USDJPY bid=151.01200 ask=151.02500 upstream=09:41:08.112Z
...
datagrams=992 ticks=1041 lost=0 delivery-latency p50=65us p99=140us

When you stop it with Ctrl+C, the sample sends an empty Subscribe to end the subscription. The IP address slot is freed immediately. The options, and what to check when something goes wrong, are in the Python sample.

5. Build your own client

See Connection flow, Authentication (JWT), and Message format. Things to watch out for when implementing a client are collected in Implementation notes.