This repository contains the official JavaScript/TypeScript SDK for the OCTA API.
| Package | Version | Description |
|---|---|---|
@octaspace/sdk |
Core SDK — Node.js, browser, edge runtimes | |
@octaspace/sdk-query |
TanStack Query v5 integration (framework-agnostic) | |
@octaspace/sdk-react |
React context and hooks without TanStack Query |
npm install @octaspace/sdk
# or
pnpm add @octaspace/sdkimport { 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()- Core SDK:
packages/sdk/README.md - TanStack Query integration:
packages/sdk-query/README.md - React hooks/context:
packages/sdk-react/README.md
pnpm install
pnpm build
pnpm typecheck
pnpm lint
pnpm testSee CONTRIBUTING.md for the full development guide.