> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# transactionSubscribe

> カスタムフィルターを使用してリアルタイムのトランザクションイベントを購読します。特定のアカウントを監視し、投票トランザクションを除外し、設定可能な詳細レベルで即時通知を受け取ります。

## エンドポイント

強化されたWebSocketはmainnetとdevnetで利用可能です。

* **Mainnet** `wss://mainnet.helius-rpc.com/?api-key=<api-key>`
* **Devnet** `wss://devnet.helius-rpc.com/?api-key=<api-key>`

<Note>WebSocketには10分の非アクティブタイマーがあります。WebSocket接続を維持するために、ヘルスチェックを実装し、毎分pingを送信することを強くお勧めします。</Note>

## 認可

<ParamField query="api-key" type="string" required>
  あなたのHelius APIキー。無料で[ダッシュボード](https://dashboard.helius.dev/api-keys)から取得できます。
</ParamField>

## ボディ

<ParamField body="params" type="array" required>
  <Expandable title="TransactionSubscribeFilter" defaultOpen>
    <ParamField body="vote" type="boolean">
      投票関連のトランザクションを含めるか除外するか。
    </ParamField>

    <ParamField body="failed" type="boolean">
      失敗したトランザクションを含めるか除外するか。
    </ParamField>

    <ParamField body="signature" type="string">
      トランザクションの署名で特定のトランザクションの更新をフィルタリングします。
    </ParamField>

    <ParamField body="accountInclude" type="string[]">
      トランザクション更新を受け取るアカウントのリスト。トランザクションにはこれらのアカウントの**少なくとも1つ**が含まれている必要があります。最大50,000のアドレスをサポート。
    </ParamField>

    <ParamField body="accountExclude" type="string[]">
      トランザクション更新から除外するアカウントのリスト。最大50,000のアドレスをサポート。
    </ParamField>

    <ParamField body="accountRequired" type="string[]">
      トランザクションに**すべて含まれているべき**アカウントのリスト。最大50,000のアドレスをサポート。
    </ParamField>

    <ParamField body="tokenAccounts" type="string">
      関連トークンアカウント(ATA)の拡張にオプトインすることで、`accountInclude`ウォレットが、SPLトークン残高を**所有する**トランザクションにも一致するようにします。例えば、ウォレットのトークンアカウントに触れるトークン転送の受取。

      * `"balanceChanged"` — トランザクションでウォレットが所有するトークン残高が変更された(またはトークンアカウントが閉じられた)場合に一致します。
      * `"all"` — 変更がない場合でもウォレットが所有するトークン残高を参照するトランザクションに一致します。高ボリューム。
      * `"none"` — フィールドを省略した場合と同じ(拡張なし)。これがデフォルトです。

      無効な値はJSON-RPCエラー`-32602`: `Invalid tokenAccounts value '<x>', expected one of: none, balanceChanged, all`を返します。
    </ParamField>
  </Expandable>

  <Expandable title="TransactionSubscribeOptions">
    <ParamField body="commitment" type="string">
      データ取得のコミットメントレベル。`processed`, `confirmed`, `finalized`を指定できます。
    </ParamField>

    <ParamField body="encoding" type="string">
      返されるデータのエンコーディング形式。`base58`, `base64`, `jsonParsed`を指定できます。
    </ParamField>

    <ParamField body="transactionDetails" type="string">
      返されるトランザクションデータの詳細レベル。`full`, `signatures`, `accounts`, `none`を指定できます。
    </ParamField>

    <ParamField body="showRewards" type="boolean">
      更新に報酬データを含めるかどうか。
    </ParamField>

    <ParamField body="maxSupportedTransactionVersion" type="integer">
      更新を受け取る最高のトランザクションバージョン。レガシーおよびバージョン付きトランザクションの両方を取得するには`0`に設定します。

      <Note>`transactionDetails`が`"accounts"`または`"full"`に設定されている場合に必要です。</Note>
    </ParamField>
  </Expandable>
</ParamField>

## レスポンス

<ResponseField name="result" type="integer">
  購読ID（購読解除に必要）
</ResponseField>

<RequestExample>
  ```json Request theme={"system"}
  {
    "jsonrpc": "2.0",
    "id": 420,
    "method": "transactionSubscribe",
    "params": [
      {
        "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
      },
      {
        "commitment": "processed",
        "encoding": "jsonParsed",
        "transactionDetails": "full",
        "showRewards": true,
        "maxSupportedTransactionVersion": 0
      }
    ]
  }
  ```

  ```json Watch a wallet incl. token transfers theme={"system"}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "transactionSubscribe",
    "params": [
      {
        "accountInclude": ["<WALLET_PUBKEY>"],
        "tokenAccounts": "balanceChanged"
      },
      { "commitment": "confirmed", "encoding": "jsonParsed" }
    ]
  }
  ```

  ```javascript Code Example theme={"system"}
  const WebSocket = require("ws");

  const ws = new WebSocket("wss://mainnet.helius-rpc.com/?api-key=<API_KEY>");

  ws.on("open", () => {
    ws.send(JSON.stringify({
      jsonrpc: "2.0",
      id: 420,
      method: "transactionSubscribe",
      params: [
        { accountInclude: ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"] },
        {
          commitment: "processed",
          encoding: "jsonParsed",
          transactionDetails: "full",
          maxSupportedTransactionVersion: 0,
        },
      ],
    }));

    // Keep connection alive
    setInterval(() => ws.ping(), 30_000);
  });

  ws.on("message", (data) => {
    console.log(JSON.parse(data.toString()));
  });
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={"system"}
  {
    "jsonrpc": "2.0",
    "result": 4743323479349712,
    "id": 420
  }
  ```

  ```json Notification theme={"system"}
  {
    "jsonrpc": "2.0",
    "method": "transactionNotification",
    "params": {
      "subscription": 4743323479349712,
      "result": {
        "transaction": {
          "transaction": [
            "Ae6zfSExLsJ/E1+q0jI+3ueAtSoW+6HnuDohmuFwagUo2BU4OpkSdUKYNI1dJfMOonWvjaumf4Vv1ghn9f3Avg0BAAEDGycH0OcYRpfnPNuu0DBQxTYPWpmwHdXPjb8y2P200JgK3hGiC2JyC9qjTd2lrug7O4cvSRUVWgwohbbefNgKQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0HcpwKokfYDDAJTaF/TWRFWm0Gz5/me17PRnnywHurMBAgIAAQwCAAAAoIYBAAAAAAA=",
            "base64"
          ],
          "meta": {
            "err": null,
            "status": {
              "Ok": null
            },
            "fee": 5000,
            "preBalances": [
              28279852264,
              158122684,
              1
            ],
            "postBalances": [
              28279747264,
              158222684,
              1
            ],
            "innerInstructions": [],
            "logMessages": [
              "Program 11111111111111111111111111111111 invoke [1]",
              "Program 11111111111111111111111111111111 success"
            ],
            "preTokenBalances": [],
            "postTokenBalances": [],
            "rewards": null,
            "loadedAddresses": {
              "writable": [],
              "readonly": []
            },
            "computeUnitsConsumed": 0
          }
        },
        "signature": "5moMXe6VW7L7aQZskcAkKGQ1y19qqUT1teQKBNAAmipzdxdqVLAdG47WrsByFYNJSAGa9TByv15oygnqYvP6Hn2p",
        "slot": 224341380,
        "transactionIndex": 42
      }
    }
  }
  ```
</ResponseExample>

## サブスクリプション管理

### サブスクリプションID

`transactionSubscribe`が成功した場合、サーバーは`result`フィールドにサブスクリプションIDを返します。これは、そのサブスクリプションからのすべての通知に現れる`params.subscription`と同じ番号です。

<CodeGroup>
  ```json Subscribe Response theme={"system"}
  {
    "jsonrpc": "2.0",
    "result": 4743323479349712,
    "id": 420
  }
  ```

  ```json Notification theme={"system"}
  {
    "jsonrpc": "2.0",
    "method": "transactionNotification",
    "params": {
      "subscription": 4743323479349712,
      "result": {}
    }
  }
  ```
</CodeGroup>

レスポンスからサブスクリプションIDを保存します。購読解除にはこれが必要です。

### 購読解除

通知の受信を停止するには、サブスクリプションIDで`transactionUnsubscribe`を呼び出します。同じ接続での各`transactionSubscribe`呼び出しは、独自のIDを持つ個別のサブスクリプションを作成するため、再購読する前に購読解除して重複する通知を受信しないようにする必要があります。

<CodeGroup>
  ```json Request theme={"system"}
  {
    "jsonrpc": "2.0",
    "id": 421,
    "method": "transactionUnsubscribe",
    "params": [4743323479349712]
  }
  ```

  ```json Response theme={"system"}
  {
    "jsonrpc": "2.0",
    "result": true,
    "id": 421
  }
  ```
</CodeGroup>

`transactionUnsubscribe`を呼び出した後も、いくつかのメッセージは短時間到着することがあります。これは予想される動作です。