POST リクエスト

このページでは、WebSocket APIを使用したポストリクエストについて説明します。

リクエスト形式

WebSocket APIは、通常HTTP APIを通じてポストできるリクエストの送信に対応しています。これらのリクエストは、infoリクエストまたは署名付きアクションのいずれかです。infoリクエストのペイロードの例については、Info endpointのセクションを参照してください。署名付きアクションのペイロードの例については、Exchange endpointのセクションを参照してください。

いずれかのタイプのペイロードをWebSocket API経由で送信するには、次のようにラップする必要があります：

{
  "method": "post",
  "id": <number>,
  "request": {
    "type": "info" | "action",
    "payload": { ... }
  }
}

注： method と id フィールドは必須です。チャンネルを通じて未完了のリクエストを追跡するために、送信する各ポストリクエストに一意の id を使用することを推奨します。

注： explorer リクエストはWebSocket経由ではサポートされていません。

応答形式

サーバーはポストリクエストに対して成功またはエラーのいずれかで応答します。エラーの場合、HTTPでリクエストが送信された場合に返されるHTTPステータスコードと説明を反映した String が返されます。

{
  "channel": "post",
  "data": {
    "id": <number>,
    "response": {
      "type": "info" | "action" | "error",
      "payload": { ... }
    }
  }
}

例

サブスクリプションメッセージを使用して異なるフィードをサブスクライブするいくつかの例を以下に示します：

L2Book infoリクエストの送信：

{
  "method": "post",
  "id": 123,
  "request": {
    "type": "info",
    "payload": {
      "type": "l2Book",
      "coin": "ETH",
      "nSigFigs": 5,
      "mantissa": null
    }
  }
}

応答のサンプル：

{
  "channel": "post",
  "data": {
    "id": <number>,
    "response": {
      "type": "info",
      "payload": {
        "type": "l2Book",
        "data": {
          "coin": "ETH",
          "time": <number>,
          "levels": [
            [{"px":"3007.1","sz":"2.7954","n":1}],
            [{"px":"3040.1","sz":"3.9499","n":1}]
          ]
        }
      }
    }
  }
}

注文の署名付きアクションリクエストの送信：

{
  "method": "post",
  "id": 256,
  "request": {
    "type": "action",
    "payload": {
      "action": {
        "type": "order",
        "orders": [{"a": 4, "b": true, "p": "1100", "s": "0.2", "r": false, "t": {"limit": {"tif": "Gtc"}}}],
        "grouping": "na"
      },
      "nonce": 1713825891591,
      "signature": {
        "r": "...",
        "s": "...",
        "v": "..."
      },
      "vaultAddress": "0x12...3"
    }
  }
}

応答のサンプル：

{
  "channel": "post",
  "data": {
    "id": 256,
    "response": {
      "type":"action",
      "payload": {
        "status": "ok",
        "response": {
          "type": "order",
          "data": {
            "statuses": [
              {
                "resting": {
                  "oid": 88383,
                }
              }
            ]
          }
        }
      }
    }
  }
}