Practical overview
When it fits
Use the SDK when an application written for a modern browser or Node.js needs a JavaScript interface to an Algorand node. Its quick-start example is specifically suited to requesting node status.
Who it is for
- JavaScript and TypeScript developers building browser applications that communicate with Algorand nodes.
- Node.js developers creating services that query node status or perform Algorand network interactions.
Documented uses
- Add Algorand network communication to a browser or Node.js application.
- Create an Algod client using a node's token, server address and port.
- Request and handle a node status response.
Requirements & limits
The repository identifies the SDK as MIT licensed. The README documents npm installation for Node.js and a browser bundle for browser projects.
- Version 3 includes breaking API changes for existing version 2 code; the repository provides a migration guide.
- TypeScript 4.2 or higher is needed to use the included TypeScript types properly.
- Running the repository's examples requires access to a running node; its README directs users to Algorand developer resources for local node installation.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Query node status with the Algod client
Use the documented quick-start flow to request status from an Algorand node.
Before you start
- The SDK installed or its browser bundle included.
- A reachable Algorand node, its server address and port, and an Algod API token.
Steps
Create an
Algodv2client with the API token, server address and port.Call
client.status().do()and await the response.
Expected outcome
The example logs the node status response, or logs an error if the request fails.
Guide limitations
- The request depends on access to a running node and valid connection details.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- algorand/js-algorand-sdk · Official homepage title · retained in its source language

