QuantLab TickDirect は、FX などのティックを UDP で配信するサービスです。LP(ティックの配信元)と地域の組ごとに置いた Tick サーバーが、LP から受け取ったティックを SBE 形式のバイナリにして、購読しているクライアントへ送ります。
β版です
SLA はありません。
仕組み
- クライアントは UDP のソケットを 1 つ開き、Tick サーバーに
Helloを送って認証を始めます。 - ggguilds で発行した APIキー(Ed25519 のキーペア)で JWT に署名し、
Authenticateで送ります。 - 認証が済んだら、受け取りたいシンボルの名前を
Subscribeで送ります。 - 以降、購読したシンボルのティックが
Ticksメッセージで届き続けます。 - クライアントは 1 秒ごとに
Heartbeatを送ります。5 秒途絶えると、Tick サーバーは購読を終わらせます。
クライアントTick サーバー
認証
- 1Hello認証を始める
認証を始める
- 2Challengecookie(16 バイト)
cookie(16 バイト)
- 3Authenticatecookie を nonce に入れ、APIキーで署名した JWT
cookie を nonce に入れ、APIキーで署名した JWT
- 4AuthenticateAck購読者トークン
購読者トークン
購読
- 5Subscribeシンボル名の一覧
シンボル名の一覧
- 6SubscribeAckシンボルごとのシンボル ID
シンボルごとのシンボル ID
受信
- 7Ticksティックが届くたびに送られる
ティックが届くたびに送られる
- 8Heartbeat1 秒ごと
1 秒ごと
- 9HeartbeatAck購読が続いているか
購読が続いているか
仕様の要点
| 項目 | 内容 |
|---|---|
| 通信 | UDP(IPv4)。制御と配信は同じポートで行います。 |
| 形式 | FIX SBE(Simple Binary Encoding)、リトルエンディアン。1 データグラムに 1 メッセージ、1,200 バイト以下です。 |
| 価格 | Bid と Ask を、int64 の固定小数点(× 10⁻⁸)で送ります。 |
| 時刻 | LP がティックに付けた時刻(上流時刻)と、Tick サーバーが受け取った時刻(受信時刻)。どちらも UTC のナノ秒です。LP Alpha はティックに時刻を付けないため、両方に受信時刻が入ります。 |
| 欠損の検知 | データグラムに購読者ごとの連番が付きます。失われたデータグラムは送り直しません。 |
| 購読 | シンボル名で指定します。1 つの購読で 64 シンボルまでです。 |
| 認証 | ggguilds で発行する APIキー(Ed25519)で署名した JWT を使います。 |
| 生存確認 | クライアントが Heartbeat を 1 秒ごとに送ります。5 秒途絶えると購読が終わります。 |
用語
| 用語 | 意味 |
|---|---|
| LP | ティックの配信元(Liquidity Provider)。名前は契約上の理由で公開しておらず、コードネームで呼びます(現在は Alpha の 1 つ)。 |
| Tick サーバー | 1 つの LP と 1 つの地域の組ごとに置くサーバー。例: tokyo-alpha-1 |
| ティック | あるシンボルの、ある時点の Bid と Ask の更新 1 件 |
| シンボル | 価格が付く銘柄の名前。例: EURUSD |
| シンボル ID | Tick サーバーがシンボルに割り当てる番号。Ticks にはシンボル名ではなくシンボル ID が入ります。 |
| APIキー | ggguilds が契約ごとに発行する Ed25519 のキーペア。キー ID(ggg_ で始まる値)と秘密鍵からなります。 |
| 購読者 | 認証が済んだクライアント。送信元の IP アドレスとポートの組で区別します。 |
| 購読者トークン | 認証が済んだときに Tick サーバーが発行する 16 バイトの値。Subscribe と Heartbeat に載せます。 |
| 上流時刻 | LP がティックに付けた時刻(UTC) |
| 受信時刻 | Tick サーバーがティックを受け取った時刻(UTC) |
読む順番
- はじめて使うときは、クイックスタートから読んでください。
- 接続先と、地域ごとに届くシンボルは Tick サーバーとシンボルにあります。
- クライアントを自分で実装するときは、接続の流れ、認証(JWT)、メッセージの形式の順に読んでください。メッセージの正式な定義は SBE スキーマです。
- 動く実装は Python サンプルにあります。