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
- The client opens one UDP socket and sends
Helloto the Tick server to start authentication. - The client signs a JWT with the API key (an Ed25519 key pair) issued on ggguilds, and sends it in
Authenticate. - After authentication, the client sends the names of the symbols it wants in
Subscribe. - From then on, ticks for the subscribed symbols keep arriving in
Ticksmessages. - The client sends
Heartbeatevery second. After 5 seconds without one, the Tick server ends the subscription.
ClientTick server
Authenticate
- 1HelloStart authentication
Start authentication
- 2ChallengeA 16-byte cookie
A 16-byte cookie
- 3AuthenticateA JWT signed with your API key, with the cookie as nonce
A JWT signed with your API key, with the cookie as nonce
- 4AuthenticateAckYour subscriber token
Your subscriber token
Subscribe
- 5SubscribeThe symbol names you want
The symbol names you want
- 6SubscribeAckA symbol ID for each symbol
A symbol ID for each symbol
Receive
- 7TicksSent as ticks arrive
Sent as ticks arrive
- 8HeartbeatEvery second
Every second
- 9HeartbeatAckWhether the subscription is alive
Whether the subscription is alive
Key specifications
| Item | Details |
|---|---|
| Transport | UDP over IPv4. Control messages and ticks share one port. |
| Encoding | FIX Simple Binary Encoding (SBE), little-endian. One message per datagram, up to 1,200 bytes. |
| Prices | Bid and ask as int64 fixed-point values (× 10⁻⁸). |
| Timestamps | The 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 detection | Each datagram carries a per-subscriber sequence number. Lost datagrams are not resent. |
| Subscription | By symbol name, up to 64 symbols per subscriber. |
| Authentication | A JWT signed with the API key (Ed25519) that ggguilds issues to you. |
| Keepalive | The client sends a Heartbeat every second. The subscription ends after 5 seconds without one. |
Terms
| Term | Meaning |
|---|---|
| LP | The source of the ticks (liquidity provider). LP names are not disclosed for contractual reasons; each LP has a codename (today, one LP: Alpha). |
| Tick server | A server placed for each pair of one LP and one region. Example: tokyo-alpha-1 |
| Tick | One update of the bid and ask of a symbol at a point in time |
| Symbol | The name of an instrument that has a price. Example: EURUSD |
| Symbol ID | A number that the Tick server assigns to a symbol. Ticks carries symbol IDs, not symbol names. |
| API key | An Ed25519 key pair that ggguilds issues for each contract. It consists of a key ID (a value starting with ggg_) and a private key. |
| Subscriber | A client that has authenticated. Subscribers are identified by the pair of source IP address and port. |
| Subscriber token | A 16-byte value that the Tick server issues when authentication succeeds. It goes in Subscribe and Heartbeat. |
| Upstream time | The time the LP put on the tick (UTC) |
| Receive time | The time the Tick server received the tick (UTC) |
Where to start
- If you are new to the service, start with the Quickstart.
- Server addresses and the symbols available in each region are in Tick servers and symbols.
- If you are writing your own client, read Connection flow, Authentication (JWT), and Message format in that order. The formal definition of the messages is the SBE schema.
- A working implementation is in the Python sample.