Practical overview
When it fits
Use Starknet.js when a JavaScript or TypeScript project needs the library’s Starknet API, or when consulting its development guides and examples.
Who it is for
- JavaScript and TypeScript developers building software that interacts with Starknet.
- Developers creating Starknet integration utilities or code examples.
- AI coding-agent users who want the project’s official skill in a compatible workflow.
Documented uses
- Add Starknet API use to a JavaScript application.
- Create utilities that integrate JavaScript code with Starknet.
- Consult the library’s guides, API reference and code examples while developing.
Requirements & limits
- The project is a library installed into a developer’s own project, not a hosted application.
- The README documents separate npm package names for official, pre-release and beta channels.
- The repository identifies the project as TypeScript and MIT-licensed.
- An official Agent Skills package is available for compatible AI coding-agent workflows.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install starknet.js and consult its API
Add the starknet package to a JavaScript or TypeScript project and find the API reference for its functions.
Before you start
- A project that uses npm.
Steps
Install the latest official release with the command below; alternatively, install the documented pre-release with the command below or beta with the command below.
npm install starknetnpm install starknet@nextnpm install starknet@betaImport
starknetin your project.Consult the API reference and usage guides for the functionality you need.
Expected outcome
The package is installed and available to import, with API and usage documentation linked for further integration.
Guide limitations
- The installation instructions do not document project creation, configuration, or a test procedure.
- API capabilities vary by API area: for example, RpcProvider supports network interaction without signing, while signing and account operations use other APIs.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- starknet-io/starknet.js · Official homepage title · retained in its source language

