本文へ移動
QuantLabTickDirect

ドキュメント

概要

QuantLab TickDirect の仕組みと、このドキュメントで使う言葉です。

QuantLab TickDirect は、FX などのティックを UDP で配信するサービスです。LP(ティックの配信元)と地域の組ごとに置いた Tick サーバーが、LP から受け取ったティックを SBE 形式のバイナリにして、購読しているクライアントへ送ります。

β版です

SLA はありません。

仕組み

  1. クライアントは UDP のソケットを 1 つ開き、Tick サーバーに Hello を送って認証を始めます。
  2. ggguilds で発行した APIキー(Ed25519 のキーペア)で JWT に署名し、Authenticate で送ります。
  3. 認証が済んだら、受け取りたいシンボルの名前を Subscribe で送ります。
  4. 以降、購読したシンボルのティックが Ticks メッセージで届き続けます。
  5. クライアントは 1 秒ごとに Heartbeat を送ります。5 秒途絶えると、Tick サーバーは購読を終わらせます。
クライアントTick サーバー
認証
  1. 1Hello

    認証を始める

  2. 2Challenge

    cookie(16 バイト)

  3. 3Authenticate

    cookie を nonce に入れ、APIキーで署名した JWT

  4. 4AuthenticateAck

    購読者トークン

購読
  1. 5Subscribe

    シンボル名の一覧

  2. 6SubscribeAck

    シンボルごとのシンボル ID

受信
  1. 7Ticks

    ティックが届くたびに送られる

  2. 8Heartbeat

    1 秒ごと

  3. 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
シンボル IDTick サーバーがシンボルに割り当てる番号。Ticks にはシンボル名ではなくシンボル ID が入ります。
APIキーggguilds が契約ごとに発行する Ed25519 のキーペア。キー ID(ggg_ で始まる値)と秘密鍵からなります。
購読者認証が済んだクライアント。送信元の IP アドレスとポートの組で区別します。
購読者トークン認証が済んだときに Tick サーバーが発行する 16 バイトの値。Subscribe と Heartbeat に載せます。
上流時刻LP がティックに付けた時刻(UTC)
受信時刻Tick サーバーがティックを受け取った時刻(UTC)

読む順番