> ## 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

> Assine eventos de transação em tempo real com filtros personalizados. Monitore contas específicas, exclua transações de votos e receba notificações instantâneas com níveis de detalhes configuráveis.

## Endpoints

WebSockets aprimorados estão disponíveis na mainnet e na devnet:

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

<Note>Os WebSockets têm um temporizador de inatividade de 10 minutos; é altamente recomendado implementar verificações de integridade e enviar pings a cada minuto para manter a conexão WebSocket ativa.</Note>

## Autorizações

<ParamField query="api-key" type="string" required>
  Sua chave de API Helius. Você pode obter uma gratuitamente no [dashboard](https://dashboard.helius.dev/api-keys).
</ParamField>

## Corpo

<ParamField body="params" type="array" required>
  <Expandable title="TransactionSubscribeFilter" defaultOpen>
    <ParamField body="vote" type="boolean">
      Incluir ou excluir transações relacionadas a votos.
    </ParamField>

    <ParamField body="failed" type="boolean">
      Incluir ou excluir transações que falharam.
    </ParamField>

    <ParamField body="signature" type="string">
      Filtrar atualizações para uma transação específica pela sua assinatura.
    </ParamField>

    <ParamField body="accountInclude" type="string[]">
      Lista de contas para receber atualizações de transação. Uma transação deve incluir **pelo menos uma** dessas contas. Suporta até 50.000 endereços.
    </ParamField>

    <ParamField body="accountExclude" type="string[]">
      Lista de contas a serem excluídas das atualizações de transação. Suporta até 50.000 endereços.
    </ParamField>

    <ParamField body="accountRequired" type="string[]">
      Lista de contas que **todas devem** ser incluídas em uma transação para que ela corresponda. Suporta até 50.000 endereços.
    </ParamField>

    <ParamField body="tokenAccounts" type="string">
      Inscreva-se para expandir a conta de token associada (ATA) para que uma carteira `accountInclude` também corresponda a transações onde **possui** um saldo de token SPL — por exemplo, transferências de token recebidas que tocam na conta de token da carteira em vez de sua chave pública. Aceita:

      * `"balanceChanged"` — corresponde quando a carteira possui um saldo de token cujo valor mudou (ou cuja conta de token foi fechada) na transação.
      * `"all"` — corresponde a qualquer transação que faça referência a um saldo de token que a carteira possui, mesmo que não tenha mudado. Maior volume.
      * `"none"` — igual a omitir o campo (sem expansão). Este é o padrão.

      Um valor inválido retorna o erro JSON-RPC `-32602`: `Invalid tokenAccounts value '<x>', expected one of: none, balanceChanged, all`.
    </ParamField>
  </Expandable>

  <Expandable title="TransactionSubscribeOptions">
    <ParamField body="commitment" type="string">
      Nível de compromisso para buscar dados. Pode ser `processed`, `confirmed` ou `finalized`.
    </ParamField>

    <ParamField body="encoding" type="string">
      Formato de codificação para os dados retornados. Pode ser `base58`, `base64` ou `jsonParsed`.
    </ParamField>

    <ParamField body="transactionDetails" type="string">
      Nível de detalhe para os dados da transação retornados. Pode ser `full`, `signatures`, `accounts` ou `none`.
    </ParamField>

    <ParamField body="showRewards" type="boolean">
      Determina se os dados de recompensa devem ser incluídos nas atualizações.
    </ParamField>

    <ParamField body="maxSupportedTransactionVersion" type="integer">
      A versão mais alta de transação para receber atualizações. Defina para `0` para obter transações tanto legadas quanto com versão.

      <Note>Necessário quando `transactionDetails` está definido para `"accounts"` ou `"full"`.</Note>
    </ParamField>
  </Expandable>
</ParamField>

## Resposta

<ResponseField name="result" type="integer">
  ID da assinatura (necessário para cancelar inscrição)
</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>

## Gerenciando Assinaturas

### IDs de Assinatura

Quando `transactionSubscribe` tem sucesso, o servidor retorna um ID de assinatura no campo `result`. Este é o mesmo número que aparece em `params.subscription` em cada notificação dessa assinatura:

<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>

Armazene o ID da assinatura da resposta. Você precisará dele para cancelar a inscrição.

### Cancelando Inscrição

Para parar de receber notificações, chame `transactionUnsubscribe` com o ID da assinatura. Cada chamada `transactionSubscribe` na mesma conexão cria uma assinatura separada com seu próprio ID, então certifique-se de cancelar a inscrição antes de se reinscrever para evitar receber notificações duplicadas.

<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>

Algumas mensagens em trânsito ainda podem chegar logo após chamar `transactionUnsubscribe`. Este é um comportamento esperado.