Skip to content
QuantLabTickDirect

Docs

Overview

How QuantLab TickDirect works, and the terms used in these docs.

QuantLab TickDirect delivers ticks for FX and other symbols over UDP. There is one Tick server for each pair of LP (the source of the ticks) and region. Each Tick server encodes the ticks it receives from the LP as SBE binary messages and sends them to the subscribed clients.

This is a beta service

There is no SLA.

How it works

  1. The client opens one UDP socket and sends Hello to the Tick server to start authentication.
  2. The client signs a JWT with the API key (an Ed25519 key pair) issued on ggguilds, and sends it in Authenticate.
  3. After authentication, the client sends the names of the symbols it wants in Subscribe.
  4. From then on, ticks for the subscribed symbols keep arriving in Ticks messages.
  5. The client sends Heartbeat every second. After 5 seconds without one, the Tick server ends the subscription.
ClientTick server
Authenticate
  1. 1Hello

    Start authentication

  2. 2Challenge

    A 16-byte cookie

  3. 3Authenticate

    A JWT signed with your API key, with the cookie as nonce

  4. 4AuthenticateAck

    Your subscriber token

Subscribe
  1. 5Subscribe

    The symbol names you want

  2. 6SubscribeAck

    A symbol ID for each symbol

Receive
  1. 7Ticks

    Sent as ticks arrive

  2. 8Heartbeat

    Every second

  3. 9HeartbeatAck

    Whether the subscription is alive

Key specifications

ItemDetails
TransportUDP over IPv4. Control messages and ticks share one port.
EncodingFIX Simple Binary Encoding (SBE), little-endian. One message per datagram, up to 1,200 bytes.
PricesBid and ask as int64 fixed-point values (× 10⁻⁸).
TimestampsThe time the LP put on the tick (upstream time) and the time the Tick server received it (receive time), both in UTC nanoseconds. LP Alpha does not timestamp its ticks, so both fields hold the receive time.
Loss detectionEach datagram carries a per-subscriber sequence number. Lost datagrams are not resent.
SubscriptionBy symbol name, up to 64 symbols per subscriber.
AuthenticationA JWT signed with the API key (Ed25519) that ggguilds issues to you.
KeepaliveThe client sends a Heartbeat every second. The subscription ends after 5 seconds without one.

Terms

TermMeaning
LPThe source of the ticks (liquidity provider). LP names are not disclosed for contractual reasons; each LP has a codename (today, one LP: Alpha).
Tick serverA server placed for each pair of one LP and one region. Example: tokyo-alpha-1
TickOne update of the bid and ask of a symbol at a point in time
SymbolThe name of an instrument that has a price. Example: EURUSD
Symbol IDA number that the Tick server assigns to a symbol. Ticks carries symbol IDs, not symbol names.
API keyAn Ed25519 key pair that ggguilds issues for each contract. It consists of a key ID (a value starting with ggg_) and a private key.
SubscriberA client that has authenticated. Subscribers are identified by the pair of source IP address and port.
Subscriber tokenA 16-byte value that the Tick server issues when authentication succeeds. It goes in Subscribe and Heartbeat.
Upstream timeThe time the LP put on the tick (UTC)
Receive timeThe time the Tick server received the tick (UTC)

Where to start