@starkscan/sdk
v0.0.2
Published
Typed Starkscan API client for beta integrations. Stable latest is fail-closed; use @starkscan/sdk@alpha.
Maintainers
Readme
@starkscan/sdk
Typed Starkscan API client for beta integrations.
The npm
latestchannel is intentionally fail-closed until the stable SDK is released. Install@starkscan/sdk@alpha, or pin an exact alpha version for unattended agents and production services.
Install
| Use case | Command |
| --- | --- |
| Try the current beta | npm install @starkscan/sdk@alpha |
| Pin the smoked beta | npm install @starkscan/[email protected] |
| Stable channel | npm install @starkscan/sdk installs a fail-closed placeholder; calling createStarkscanClient() throws upgrade guidance |
First request
export STARKSCAN_BASE_URL="https://starkscan.co/api"
export STARKSCAN_API_KEY="<store this in your shell or agent secret store>"
export STARKSCAN_CHAIN="SN_MAIN"import { createStarkscanClient } from "@starkscan/sdk";
const starkscan = createStarkscanClient({
apiKey: process.env.STARKSCAN_API_KEY!,
baseUrl: process.env.STARKSCAN_BASE_URL ?? "https://starkscan.co/api",
chainId: process.env.STARKSCAN_CHAIN ?? "SN_MAIN",
});
const status = await starkscan.status();
console.log(status.chainId);What this package is for
- Build server-side integrations against certified Starkscan API routes.
- Keep Starknet data access behind
X-Starkscan-Api-Keyand request IDs. - Give agents a typed client instead of hand-written fetch wrappers.
Trust model
latestfails closed by design until stable GA.alphais the beta channel; use exact pins for unattended jobs.- Package metadata links to public docs because the canonical engineering repo is private.
- Package trust, release policy, and Socket/OpenSSF signals are documented at https://starkscan.co/docs/build/package-trust.
Links
- SDK docs: https://starkscan.co/docs/sdk/typescript
- API docs: https://starkscan.co/docs/api
- Package trust: https://starkscan.co/docs/build/package-trust
- npm versions: https://www.npmjs.com/package/@starkscan/sdk?activeTab=versions
