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

# Inscrever-se

> Inscreva-se em contas, transações, blocos e atualizações de slots para receber notificações em tempo real usando a API gRPC de alto desempenho.

<hide>
  ## Endpoints

  Serviços gRPC estão disponíveis no mainnet e devnet com os seguintes URLs:

  * **Mainnet** `https://laserstream-mainnet.helius-rpc.com:443`
  * **Devnet** `https://laserstream-devnet.helius-rpc.com:443`
</hide>

## Autorizações

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

## Mensagem

A API gRPC suporta múltiplos tipos de inscrição que podem ser combinados em uma única solicitação:

<ParamField body="accounts" type="object">
  Inscreva-se para atualizações de conta. Retorna dados quando contas específicas são
  modificadas.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="account" type="array">
      Matriz de chaves públicas de conta a serem monitoradas.
    </ParamField>

    <ParamField body="owner" type="array">
      Matriz de chaves públicas de proprietário a serem monitoradas (todas as contas de propriedade desses programas).
    </ParamField>

    <ParamField body="filters" type="object">
      Filtros opcionais para aplicar.

      <Expandable title="opções de filtro">
        <ParamField body="memcmp" type="object">
          Filtre por bytes específicos em um deslocamento nos dados da conta.

          <Expandable title="propriedades">
            <ParamField body="offset" type="integer">
              Posição em bytes para começar a comparar os dados.
            </ParamField>

            <ParamField body="bytes" type="string">
              Os dados para comparar (formato bytes).
            </ParamField>

            <ParamField body="base58" type="string">
              Os dados para comparar (formato base58).
            </ParamField>

            <ParamField body="base64" type="string">
              Os dados para comparar (formato base64).
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="datasize" type="integer">
          Filtre por tamanho exato dos dados da conta em bytes.
        </ParamField>

        <ParamField body="token_account_state" type="boolean">
          Filtrar apenas contas de token.
        </ParamField>

        <ParamField body="lamports" type="object">
          Filtrar pelo saldo de SOL com comparações.

          <Expandable title="operadores de comparação">
            <ParamField body="eq" type="integer">
              Igual ao valor especificado.
            </ParamField>

            <ParamField body="ne" type="integer">
              Diferente do valor especificado.
            </ParamField>

            <ParamField body="lt" type="integer">
              Menor que o valor especificado.
            </ParamField>

            <ParamField body="gt" type="integer">
              Maior que o valor especificado.
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="nonempty_txn_signature" type="boolean">
      Se `true`, incluir apenas atualizações causadas por uma transação. Se `false`, incluir apenas atualizações não causadas por uma transação. Se `undefined`, incluir todas as atualizações.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="slots" type="object">
  Inscreva-se para atualizações de slots.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="filter_by_commitment" type="boolean">
      Filtrar slots por nível de compromisso.
    </ParamField>

    <ParamField body="interslot_updates" type="boolean">
      Incluir atualizações de status intermediário de slots (PROCESSED, CONFIRMED, FINALIZED,
      FIRST\_SHRED\_RECEIVED, COMPLETED, CREATED\_BANK, DEAD).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="transactions" type="object">
  Inscreva-se para atualizações de transações.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="vote" type="boolean">
      Incluir transações de voto.
    </ParamField>

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

    <ParamField body="signature" type="string">
      Monitorar assinatura de transação específica.
    </ParamField>

    <ParamField body="account_include" type="array">
      Incluir apenas transações que afetam essas contas.
    </ParamField>

    <ParamField body="account_exclude" type="array">
      Excluir transações que afetam essas contas.
    </ParamField>

    <ParamField body="account_required" type="array">
      Transações devem afetar todas essas contas.
    </ParamField>

    <ParamField body="token_accounts" type="enum">
      Expansão opcional de conta associada ao token (ATA) (tag de campo 30, `TokenAccountExpansionControlFlag`). Quando definido, uma carteira `account_include` também corresponde a transações onde ela **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. Duas variantes:

      * `ALL` (**0**) — corresponder a qualquer transação que referencie um saldo de token que a carteira possui, mesmo que não tenha mudado. Maior volume.
      * `BALANCE_CHANGED` (**1**) — corresponder quando a carteira possui um saldo de token cujo valor foi alterado (ou cuja conta de token foi fechada) na transação.

      Para desativar a expansão, **deixe o campo ausente** (`None`) — não há valor "desativado" no enum. Um inteiro fora do intervalo é rejeitado na configuração: `Invalid token_accounts value, expected ALL (0) or BALANCE_CHANGED (1)`.

      <Warning>
        `ALL` é o **valor zero**. Um cliente que define o enum como `0` esperando "padrão/desativado" obtém `ALL` — o modo mais amplo e de maior volume. A única maneira de significar "sem expansão" é omitir completamente o campo.
      </Warning>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="transactions_status" type="object">
  Inscreva-se para atualizações de status de transações.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="vote" type="boolean">
      Incluir transações de voto.
    </ParamField>

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

    <ParamField body="signature" type="string">
      Monitorar assinatura de transação específica.
    </ParamField>

    <ParamField body="account_include" type="array">
      Incluir apenas transações que afetam essas contas.
    </ParamField>

    <ParamField body="account_exclude" type="array">
      Excluir transações que afetam essas contas.
    </ParamField>

    <ParamField body="account_required" type="array">
      Transações devem afetar todas essas contas.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="blocks" type="object">
  Inscreva-se para atualizações de blocos.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="account_include" type="array">
      Incluir apenas blocos com transações que afetam essas contas.
    </ParamField>

    <ParamField body="include_transactions" type="boolean">
      Incluir detalhes completos da transação.
    </ParamField>

    <ParamField body="include_accounts" type="boolean">
      Incluir atualizações de contas.
    </ParamField>

    <ParamField body="include_entries" type="boolean">
      Incluir entradas de blocos.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="blocks_meta" type="object">
  Inscreva-se para atualizações de metadados de bloco (mais leves que as atualizações de bloco completas).

  <Expandable title="retornos" defaultOpen>
    <ParamField body="slot" type="integer">
      Número do slot.
    </ParamField>

    <ParamField body="blockhash" type="string">
      Blockhash.
    </ParamField>

    <ParamField body="rewards" type="array">
      Informações de recompensas.
    </ParamField>

    <ParamField body="block_time" type="integer">
      Hora do bloco.
    </ParamField>

    <ParamField body="block_height" type="integer">
      Altura do bloco.
    </ParamField>

    <ParamField body="parent_slot" type="integer">
      Slot pai.
    </ParamField>

    <ParamField body="parent_blockhash" type="string">
      Blockhash pai.
    </ParamField>

    <ParamField body="executed_transaction_count" type="integer">
      Contagem de transações.
    </ParamField>

    <ParamField body="entries_count" type="integer">
      Contagem de entradas.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="entry" type="object">
  Inscreva-se para atualizações de entrada.

  <Expandable title="retornos" defaultOpen>
    <ParamField body="slot" type="integer">
      Número do slot.
    </ParamField>

    <ParamField body="index" type="integer">
      Índice da entrada.
    </ParamField>

    <ParamField body="num_hashes" type="integer">
      Número de hashes.
    </ParamField>

    <ParamField body="hash" type="string">
      Hash.
    </ParamField>

    <ParamField body="executed_transaction_count" type="integer">
      Contagem de transações.
    </ParamField>

    <ParamField body="starting_transaction_index" type="integer">
      Índice inicial da transação.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="commitment" type="enum">
  O nível de compromisso para a inscrição:

  <Expandable title="níveis" defaultOpen>
    <ParamField body="PROCESSED" type="integer">
      (0): Processado pelo nó atual.
    </ParamField>

    <ParamField body="CONFIRMED" type="integer">
      (1): Confirmado por supermaioria do cluster.
    </ParamField>

    <ParamField body="FINALIZED" type="integer">
      (2): Finalizado pelo cluster.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="accounts_data_slice" type="array">
  Especifica dados parciais da conta a serem recebidos:

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="offset" type="integer">
      Posição em bytes para começar a ler os dados.
    </ParamField>

    <ParamField body="length" type="integer">
      Número de bytes a serem lidos.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="ping" type="object">
  Habilitar mensagens de ping-pong para monitoramento da integridade da conexão.

  <Expandable title="propriedades" defaultOpen>
    <ParamField body="id" type="integer">
      Identificador numérico para o ping.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="from_slot" type="integer">
  Slot inicial para receber atualizações. Atualizações para slots anteriores a este valor
  serão excluídas.
</ParamField>

<RequestExample>
  ```json Accounts Subscription theme={"system"}
  {
    "slots": {
        "slots": {}
    },
    "accounts": {
        "user-defined-label": {
            "account": [
                "DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu",
                "5U3bH5b6XtG99aVCE9ycvDgBKQx3fVT8WwTNbMToFuEr"
            ],
            "owner": [
                "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
            ],
            "filter": {
                "memcmp": {
                    "offset": 0,
                    "bytes": "0102030405"
                },
                "datasize": 165,
                "token_account_state": true,
                "lamports": {
                    "gt": 100000000
                }
            },
            "nonempty_txn_signature": true
        }
    },
    "transactions": {},
    "blocks": {},
    "blocks_meta": {},
    "accounts_data_slice": [],
    "commitment": 1
  }
  ```

  ```json Slots Subscription theme={"system"}
  {
    "slots": {
      "incoming_slots": {}
    },
    "commitment": 1
  }
  ```

  ```json Transactions Subscription theme={"system"}
  {
    "transactions": {
      "vote": false,
      "failed": true,
      "signature": "4RPMxKBhCBubFmZ1r9BC52ztjG3qBTW9Gp1PXfufUSATQaLKTW3Dj6vQBYyVrhfjgJ4PjZLzwYs4Z92KDCPw8Qym",
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "account_exclude": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
      "account_required": ["11111111111111111111111111111111"]
    },
    "commitment": 2
  }
  ```

  ```json Wallet + Token Transfers (ATA expansion) theme={"system"}
  {
    "transactions": {
      "wallet": {
        "vote": false,
        "failed": false,
        "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
        "account_exclude": [],
        "account_required": [],
        "token_accounts": 1
      }
    },
    "commitment": 1
  }
  ```

  ```json Transaction Status Subscription theme={"system"}
  {
    "transactions_status": {
      "vote": false,
      "failed": true,
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "account_exclude": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
      "account_required": ["11111111111111111111111111111111"]
    },
    "commitment": 2
  }
  ```

  ```json Blocks Subscription theme={"system"}
  {
    "blocks": {
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "include_transactions": 1,
      "include_accounts": 1,
      "include_entries": 0
    },
    "commitment": 2
  }
  ```

  ```json Block Metadata Subscription theme={"system"}
  {
    "blocks_meta": {},
    "commitment": 2,
    "from_slot": 139000000
  }
  ```

  ```json Entry Subscription theme={"system"}
  {
    "entry": {},
    "commitment": 1
  }
  ```

  ```json Partial Account Data Subscription theme={"system"}
  {
    "accounts": {
      "account": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"]
    },
    "accounts_data_slice": [
      {
        "offset": 0,
        "length": 64
      },
      {
        "offset": 128,
        "length": 32
      }
    ],
    "commitment": 2
  }
  ```

  ```json Ping Subscription theme={"system"}
  {
    "ping": {
      "id": 1
    }
  }
  ```

  ```json Combined Subscription theme={"system"}
  {
    "accounts": {
      "account": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "nonempty_txn_signature": true
    },
    "slots": {
      "filter_by_commitment": 1,
      "interslot_updates": 1
    },
    "commitment": 2,
    "from_slot": 139000000,
    "ping": {
      "id": 123
    }
  }
  ```
</RequestExample>

## Níveis de Compromisso

Todas as inscrições suportam os seguintes níveis de compromisso:

* `PROCESSED`: Processado pelo nó atual (0)
* `CONFIRMED`: Confirmado por supermaioria do cluster (1)
* `FINALIZED`: Finalizado pelo cluster (2)

## Estrutura de Resposta

As respostas de inscrição incluem:

* `filters`: Os nomes dos filtros que corresponderam a esta atualização
* Um dos seguintes tipos de atualização:
  * `account`: Dados da conta, proprietário, lamports, status executável, etc.
  * `slot`: Informações e atualizações de status de slots
  * `transaction`: Detalhes completos da transação, assinatura e metadados
  * `transaction_status`: Status de execução da transação (sucesso/erro)
  * `block`: Dados completos do bloco com transações, contas, recompensas, etc.
  * `block_meta`: Metadados leves de bloco sem detalhes completos da transação
  * `entry`: Detalhes de entrada dentro de um bloco
  * `ping`/`pong`: Mensagens de verificação de integridade da conexão
* `created_at`: Timestamp quando a atualização foi criada

<ResponseExample>
  ```json Account Update theme={"system"}
  {
    "filters": ["accounts"],
    "account": {
      "account": {
        "pubkey": "BASE58_ENCODED_PUBKEY",
        "lamports": 12345678,
        "owner": "BASE58_ENCODED_OWNER",
        "executable": false,
        "rent_epoch": 361,
        "data": "BASE64_ENCODED_DATA",
        "write_version": 123,
        "txn_signature": "BASE58_ENCODED_SIGNATURE"
      },
      "slot": 189554321,
      "is_startup": false
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Slot Update theme={"system"}
  {
    "filters": ["slots"],
    "slot": {
      "slot": 189554321,
      "parent": 189554320,
      "status": 2,
      "dead_error": null
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Transaction Update theme={"system"}
  {
    "filters": ["transactions"],
    "transaction": {
      "transaction": {
        "signature": "BASE58_ENCODED_SIGNATURE",
        "is_vote": false,
        "transaction": {
          "signatures": ["BASE58_ENCODED_SIGNATURE"],
          "message": {
            "header": {
              "num_required_signatures": 1,
              "num_readonly_signed_accounts": 0,
              "num_readonly_unsigned_accounts": 1
            },
            "account_keys": ["BASE58_ENCODED_PUBKEY1", "BASE58_ENCODED_PUBKEY2"],
            "recent_blockhash": "BASE58_ENCODED_BLOCKHASH",
            "instructions": [
              {
                "program_id_index": 1,
                "accounts": [0],
                "data": "BASE64_ENCODED_INSTRUCTION_DATA"
              }
            ]
          }
        },
        "meta": {
          "err": null,
          "fee": 5000,
          "pre_balances": [10000000, 1],
          "post_balances": [9995000, 1],
          "pre_token_balances": [],
          "post_token_balances": [],
          "log_messages": ["Program log: Instruction executed"],
          "rewards": []
        },
        "index": 2
      },
      "slot": 189554321
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Block Metadata Update theme={"system"}
  {
    "filters": ["blocks_meta"],
    "block_meta": {
      "slot": 189554321,
      "blockhash": "BASE58_ENCODED_BLOCKHASH",
      "rewards": [
        {
          "pubkey": "BASE58_ENCODED_PUBKEY",
          "lamports": 1785000,
          "post_balance": 48589432109,
          "reward_type": 0,
          "commission": 10
        }
      ],
      "block_time": 1682684096,
      "block_height": 185432109,
      "parent_slot": 189554320,
      "parent_blockhash": "BASE58_ENCODED_PARENT_BLOCKHASH",
      "executed_transaction_count": 2576,
      "entries_count": 16
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Entry Update theme={"system"}
  {
    "filters": ["entry"],
    "entry": {
      "slot": 189554321,
      "index": 5,
      "num_hashes": 8765432,
      "hash": "BASE58_ENCODED_HASH",
      "executed_transaction_count": 128,
      "starting_transaction_index": 1024
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Pong Response theme={"system"}
  {
    "filters": [],
    "pong": {
      "id": 1
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```
</ResponseExample>