SDK
First-party Starkscan SDK guidance and typed client entry points.
SDK
The first-party SDK is the stable TypeScript package for consuming Starkscan from app code. It uses the same Starkscan API key and hosted API base as REST, CLI, and MCP launcher flows.
Why use it
It gives you:
- typed responses
- consistent auth handling
- request ID propagation
- the same public transport contract used by the explorer
Current label
| Surface | Public label | What works today |
|---|---|---|
| REST core API | certified | The route-level certified launch set remains the production-safe base contract. |
| TypeScript SDK | stable | @starkscan/sdk availability is registry-authoritative. The 0.4.0 exact-verification target is usable only after registry and post-publish proof. |
| Agent CLI | stable | Use the CLI for shell workflows and local exports with the same key; @starkscan/cli resolves to the same stable train. |
| Hosted MCP | hosted beta / stable launcher | Hosted MCP uses https://api.starkscan.co/mcp on the API domain or {appBaseUrl}/api/mcp on app-origin deployments. @starkscan/mcp is the local launcher. |
Start here
Install mindset
For external users, @starkscan/sdk is the live package-manager path. Resolve
the exact version from npm before pinning unattended use. The 0.4.0
verification target is available only when npm latest resolves to it and the
post-publish proof is complete. Artifact installs remain a fallback for
controlled distribution and verification.