Practical overview
When it fits
Use it when writing browser- or Node.js-based software that needs programmatic access to Kuma v1 REST or WebSocket APIs, rather than a ready-made exchange interface.
Who it is for
- JavaScript and TypeScript developers integrating applications with Kuma v1 APIs.
- Teams building market-data displays, WebSocket monitors or account-connected exchange applications.
Documented uses
- Request public market information through the REST client.
- Connect an application to Kuma’s WebSocket API for streaming data.
- Make authenticated account requests, such as retrieving wallets.
- Use the SDK’s Typechain types and factories in a contract-integrated TypeScript application.
Requirements & limits
The repository is public and the SDK is released under the MIT License. The README documents installation through npm using the beta package tag.
- The SDK targets Kuma v1 APIs, so it is relevant when the intended integration is with that API version.
- Node.js usage requires version 16 or later and import/export map resolution.
- TypeScript configuration should use Node16 or NodeNext module and moduleResolution settings.
- Authenticated client examples require a wallet private key, API key and API secret; the README recommends obtaining sandbox API keys for sandbox testing.
- Typechain types and factories are imported from the
/typechainexport, not the main package export.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install the SDK and prepare a sandbox client
Add the Kuma SDK to a JavaScript or TypeScript project and configure the documented sandbox public client.
Before you start
- npm
- Node.js 16 or later with import/export map resolution
- For TypeScript, configure module and moduleResolution as Node16 or NodeNext
Steps
Install the package with the command below.
npm install @kumabid/kuma-sdk@betaImport the package and create a
RestPublicClientwithsandbox: true.For TypeScript, set
moduleandmoduleResolutiontoNode16orNodeNext.
Expected outcome
The project has the SDK installed and a sandbox-configured public REST client ready for integration work.
Guide limitations
- This covers package installation and client configuration, not a verified API call or deployment.
- Authenticated requests require wallet and API credentials; sandbox API keys are obtained through Kuma’s v1 API documentation.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 8 October 2026
- Original website title
- kumabid/kuma-sdk-js · Official homepage title · retained in its source language

