transactionSubscribe

{
  "jsonrpc": "2.0",
  "id": 420,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
    },
    {
      "commitment": "processed",
      "encoding": "jsonParsed",
      "transactionDetails": "full",
      "showRewards": true,
      "maxSupportedTransactionVersion": 1
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["<WALLET_PUBKEY>"],
      "tokenAccounts": "balanceChanged"
    },
    { "commitment": "confirmed", "encoding": "jsonParsed" }
  ]
}

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: 1,
      },
    ],
  }));

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

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

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "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
    }
  }
}

Points de terminaison

Les WebSockets améliorés sont disponibles sur le mainnet et le devnet :

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

Les WebSockets ont une minuterie d’inactivité de 10 minutes; il est fortement recommandé de mettre en place des vérifications de santé et d’envoyer des pings chaque minute pour maintenir la connexion WebSocket active.

Autorisations

string

requis

Votre clé API Helius. Vous pouvez en obtenir une gratuitement dans le tableau de bord.

Corps

array

requis

Masquer TransactionSubscribeFilter

boolean

Inclure ou exclure les transactions liées aux votes.

boolean

Inclure ou exclure les transactions qui ont échoué.

string

Filtrer les mises à jour d’une transaction spécifique par sa signature.

string[]

Liste des comptes pour lesquels recevoir des mises à jour de transactions. Une transaction doit inclure au moins un de ces comptes. Prend en charge jusqu’à 50,000 adresses.

string[]

Liste des comptes à exclure des mises à jour de transactions. Prend en charge jusqu’à 50,000 adresses.

string[]

Liste des comptes qui doivent tous être inclus dans une transaction pour qu’elle corresponde. Prend en charge jusqu’à 50,000 adresses.

string

Optez pour l’expansion du compte de jeton associé (ATA) afin qu’un portefeuille accountInclude corresponde également aux transactions où il détient un solde de jeton SPL — par exemple, les transferts de jetons entrants qui touchent le compte de jetons du portefeuille plutôt que sa clé publique. Accepte :

"balanceChanged" — correspond lorsqu’un portefeuille détient un solde de jeton dont le montant a changé (ou dont le compte de jeton a été fermé) dans la transaction.
"all" — correspond à toute transaction référencée à un solde de jeton que le portefeuille détient, même s’il n’a pas changé. Volume plus élevé.
"none" — identique à l’omission du champ (pas d’expansion). Ceci est la valeur par défaut.

Une valeur invalide renvoie une erreur JSON-RPC -32602: Invalid tokenAccounts value '<x>', expected one of: none, balanceChanged, all.

Afficher TransactionSubscribeOptions

string

Niveau d’engagement pour la récupération des données. Peut être processed, confirmed, ou finalized.

string

Format d’encodage pour les données retournées. Peut être base58, base64, ou jsonParsed.

string

Niveau de détail pour les données de transaction retournées. Peut être full, signatures, accounts, ou none.

boolean

Inclure ou non les données de récompense dans les mises à jour.

integer

La version de transaction la plus élevée pour laquelle recevoir des mises à jour. Définissez sur 1 pour recevoir les transactions legacy, v0 et v1.

Requis lorsque transactionDetails est défini sur "accounts" ou "full".

Réponse

integer

Identifiant de souscription (nécessaire pour se désabonner)

{
  "jsonrpc": "2.0",
  "id": 420,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
    },
    {
      "commitment": "processed",
      "encoding": "jsonParsed",
      "transactionDetails": "full",
      "showRewards": true,
      "maxSupportedTransactionVersion": 1
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["<WALLET_PUBKEY>"],
      "tokenAccounts": "balanceChanged"
    },
    { "commitment": "confirmed", "encoding": "jsonParsed" }
  ]
}

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: 1,
      },
    ],
  }));

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

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

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "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
    }
  }
}

Gestion des abonnements

Identifiants de souscription

Lorsque transactionSubscribe réussit, le serveur renvoie un identifiant de souscription dans le champ result. C’est le même numéro qui apparaît dans params.subscription à chaque notification de cet abonnement :

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "jsonrpc": "2.0",
  "method": "transactionNotification",
  "params": {
    "subscription": 4743323479349712,
    "result": {}
  }
}

Conservez l’identifiant de souscription de la réponse. Vous en avez besoin pour vous désabonner.

Désabonnement

Pour arrêter de recevoir des notifications, appelez transactionUnsubscribe avec l’identifiant de souscription. Chaque appel transactionSubscribe sur la même connexion crée un abonnement distinct avec son propre identifiant, alors assurez-vous de vous désabonner avant de vous réabonner afin d’éviter de recevoir des notifications en double.

{
  "jsonrpc": "2.0",
  "id": 421,
  "method": "transactionUnsubscribe",
  "params": [4743323479349712]
}

{
  "jsonrpc": "2.0",
  "result": true,
  "id": 421
}

Quelques messages en cours peuvent encore arriver brièvement après avoir appelé transactionUnsubscribe. Cela est un comportement attendu.

⌘I

{
  "jsonrpc": "2.0",
  "id": 420,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8"]
    },
    {
      "commitment": "processed",
      "encoding": "jsonParsed",
      "transactionDetails": "full",
      "showRewards": true,
      "maxSupportedTransactionVersion": 1
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transactionSubscribe",
  "params": [
    {
      "accountInclude": ["<WALLET_PUBKEY>"],
      "tokenAccounts": "balanceChanged"
    },
    { "commitment": "confirmed", "encoding": "jsonParsed" }
  ]
}

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: 1,
      },
    ],
  }));

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

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

{
  "jsonrpc": "2.0",
  "result": 4743323479349712,
  "id": 420
}

{
  "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
    }
  }
}

Commencer

Diffusion de données et écoute d'événements

API de données et RPC

Trading

Envoyer des transactions

Gestion de compte

Points de terminaison

Autorisations

Corps

Réponse

Gestion des abonnements

Identifiants de souscription

Désabonnement

​Points de terminaison

​Autorisations

​Corps

​Réponse

​Gestion des abonnements

​Identifiants de souscription

​Désabonnement

Points de terminaison

Autorisations

Corps

Réponse

Gestion des abonnements

Identifiants de souscription

Désabonnement