# algosdk
> The official JavaScript SDK for Algorand
Latest version **3.7.0** (published 2026-08-19) · MIT license · 0 weekly downloads
## Install
```sh
npm install algosdk
pnpm add algosdk
yarn add algosdk
bun add algosdk
```
## Health
**Score 70/100 (B)** — status: active.
Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.
Warnings: low downloads.
## Facts
| | |
|---|---|
| Version | 3.7.0 |
| Published | 2026-08-19 |
| First published | 2019-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 8 |
| Unpacked size | 7.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 297 |
| Author | Algorand, llc |
| Maintainers | algojohnlee, joe-p, algo-devops-service |
## Links
- npm: https://www.npmjs.com/package/algosdk
- Repository: https://github.com/algorand/js-algorand-sdk
- Homepage: https://github.com/algorand/js-algorand-sdk#readme
- Issues: https://github.com/algorand/js-algorand-sdk/issues
- npm.io page: https://npm.io/package/algosdk
## Dependencies (8)
- [vlq](https://npm.io/package/vlq.md) ^2.0.4
- [js-sha3](https://npm.io/package/js-sha3.md) ^0.8.0
- [hi-base32](https://npm.io/package/hi-base32.md) ^0.5.1
- [js-sha256](https://npm.io/package/js-sha256.md) ^0.9.0
- [js-sha512](https://npm.io/package/js-sha512.md) ^0.8.0
- [tweetnacl](https://npm.io/package/tweetnacl.md) ^1.0.3
- [json-bigint](https://npm.io/package/json-bigint.md) ^1.0.0
- [algorand-msgpack](https://npm.io/package/algorand-msgpack.md) ^1.1.0
## Recent versions
- 3.7.0 (latest) — 2026-08-19
- 3.7.0-beta.1 (beta) — 2026-08-11
- 3.6.0 — 2026-06-10
- 3.5.2 — 2025-09-26
- 3.5.1 — 2025-09-24
- 3.5.0 — 2025-09-18
- 3.4.0 — 2025-08-05
- 3.3.1 — 2025-05-30
- 3.3.0 — 2025-05-23
- 2.11.0 — 2025-02-13
- 3.2.0 — 2025-02-13
- 2.10.0 — 2025-01-15
- 3.1.0 — 2025-01-15
- 3.0.0 — 2024-09-12
- 3.0.0-beta.2 — 2024-08-26
- … 68 more at https://npm.io/package/algosdk/versions
## README
# js-algorand-sdk
[](https://github.com/algorand/js-algorand-sdk/actions/workflows/ci-pr.yml) [](https://www.npmjs.com/package/algosdk)
AlgoSDK is the official JavaScript library for communicating with the Algorand network. It's designed for modern browsers and Node.js.
## New Major Version 3
Existing codebases using v2 of this library will be incompatible with v3. The v3 release introduces breaking changes to the API, and a migration guide is available [here](https://github.com/algorand/js-algorand-sdk/blob/main/v2_TO_v3_MIGRATION_GUIDE.md).
## Installation
### [Node.js](https://nodejs.org/en/download/)
```
$ npm install algosdk
```
> This package provides TypeScript types, but you will need [TypeScript](https://www.typescriptlang.org/) version 4.2 or higher to use them properly.
### Browser
Include a minified browser bundle directly in your HTML like so:
```html
```
or
```html
```
Information about hosting the package for yourself, finding the browser bundles of previous versions, and computing the SRI hash is [available here](FAQ.md).
## Quick Start
```javascript
const token = 'Your algod API token';
const server = 'http://127.0.0.1';
const port = 8080;
const client = new algosdk.Algodv2(token, server, port);
(async () => {
console.log(await client.status().do());
})().catch((e) => {
console.log(e);
});
```
## Documentation
Documentation for this SDK is available here: https://algorand.github.io/js-algorand-sdk/. Additional resources are available on https://developer.algorand.org.
## Examples
Running examples requires access to a running node. Follow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.
**As portions of the codebase are written in TypeScript, example files cannot be run directly using `node`**. Please refer to the instructions described in the [examples/README.md](examples/README.md) file for more information regarding running the examples.
## SDK Development
### Building
To build a new version of the library, run:
```bash
npm run build
```
### Generating Documentation
To generate the documentation website, run:
```bash
npm run docs
```
The static website will be located in the `docs/` directory.
### Testing
We have two test suites: mocha tests in this repo, and the Algorand SDK test suite from https://github.com/algorand/algorand-sdk-testing.
#### Node.js
To run the mocha tests in Node.js, run:
```bash
npm test
```
To run the SDK test suite in Node.js, run:
```bash
make docker-test
```
#### Browsers
The test suites can also run in browsers. To do so, set the environment variable `TEST_BROWSER` to
one of our supported browsers. Currently we support testing in `chrome` and `firefox`. When
`TEST_BROWSER` is set, the mocha and SDK test suites will run in that browser.
For example, to run mocha tests in Chrome:
```bash
TEST_BROWSER=chrome npm test
```
And to run SDK tests in Firefox:
```bash
TEST_BROWSER=firefox make docker-test
```
### Code Style
This project enforces a modified version of the [Airbnb code style](https://github.com/airbnb/javascript).
We've setup linters and formatters to help catch errors and improve the development experience:
- [Prettier](https://prettier.io/) – ensures that code is formatted in a readable way.
- [ESLint](https://eslint.org/) — checks code for antipatterns as well as formatting.
> If using the Visual Studio Code editor with the [recommended extensions](.vscode/extensions.json), ESLint errors should be highlighted in red and the Prettier extension should format code on every save.
#### Precommit Hook
The linters and formatters listed above should run automatically on each commit to catch errors early and save CI running time.
## License
js-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/js-algorand-sdk/blob/master/LICENSE) file for details.
---
_Source: https://npm.io/package/algosdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._