Skip to content

octaspace/js-sdk

Repository files navigation

OctaSpace JS SDK — monorepo

This repository contains the official JavaScript/TypeScript SDK for the OCTA API.

License: MIT

Packages

Package Version Description
@octaspace/sdk npm Core SDK — Node.js, browser, edge runtimes
@octaspace/sdk-query npm TanStack Query v5 integration (framework-agnostic)
@octaspace/sdk-react npm React context and hooks without TanStack Query

Quick start

npm install @octaspace/sdk
# or
pnpm add @octaspace/sdk
import { OctaClient } from '@octaspace/sdk'

const client = new OctaClient({ apiKey: process.env.OCTA_API_KEY })

const account = await client.accounts.get()
const nodes = await client.nodes.list()
const stats = await client.network.get()

Public-only usage is also supported:

const publicClient = new OctaClient({})
const stats = await publicClient.network.get()

Package docs

Development

pnpm install
pnpm build
pnpm typecheck
pnpm lint
pnpm test

See CONTRIBUTING.md for the full development guide.

About

JavaScript SDK

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages