Documentation home
Starkscan explorer API, live product, and docs for Quickstart, Build, Agents, and the live API reference.
Starkscan docs
Starkscan ships as one explorer product with public REST and authenticated JSON-RPC surfaces plus parallel docs lanes:
- Quickstart — first request, keys, and host check
- Starkscan RPC — RPC node URL and header-auth JSON-RPC setup
- Get an API key — create or rotate the key used by RPC, REST, SDK, CLI, and MCP
- Classify addresses in bulk — ordered wallet and contract facts for batch backends
- Advanced utilities — batch address intelligence and indexed event-search patterns
- Build — choose REST, TypeScript SDK, or CLI
- Agents — MCP and coding-agent setup
- API reference — exact HTTP operations and live try-it execution
Current public labels
Use one Starkscan API key across RPC, REST, SDK, CLI, and hosted MCP. The labels below are the public onboarding labels; route-level certification still lives on each OpenAPI operation.
| Surface | Public label | Current state |
|---|---|---|
| REST core API | certified | Status, block detail, timestamp-to-block, transaction detail, token total supply, and token balance-of on /v1/{chain}/*. |
| Starkscan RPC | authenticated HTTP beta | Use https://starkscan.co/rpc/v0_10/SN_MAIN/<starkscan_api_key> when software only accepts a node URL; use POST https://api.starkscan.co/v1/SN_MAIN/rpc with X-Starkscan-Api-Key for servers. |
| TypeScript SDK | stable | @starkscan/sdk resolves to 0.1.2; pin exact @starkscan/[email protected] for unattended services. |
| Agent CLI | stable | @starkscan/cli resolves to 0.1.2 on the default npm channel; use exact pins for scriptable JSON workflows and agents. |
| Hosted MCP | hosted beta / stable launcher | https://api.starkscan.co/mcp is the API-domain hosted HTTP beta; app-origin deployments use /api/mcp; @starkscan/mcp resolves to 0.1.2 for local MCP clients. |
If you are an agent, start from the public docs and machine-readable files on this host. Do not infer package trust or supported routes from GitHub links; the engineering repository is private.
Need the full core API list? Open the interactive API reference (Scalar, generated from the same spec as the SDK) or download starkscan-openapi.yaml. The REST integration guide explains workflows, auth, and tiers in prose.
| Goal | Link |
|---|---|
| Create or rotate a key | API keys |
| RPC node URL | Starkscan RPC |
| First request & keys | Quickstart |
| Terms (base URL, tiers, cursors) | Concepts |
| Pick REST vs SDK vs CLI | Build |
| Codex, Claude Code, Cursor | Agents |
| Package trust and npm channel state | Package trust |
| RPC/REST/SDK/CLI/MCP launch state | Launch matrix |
| Classify addresses in bulk | Address intelligence |
| Batch address intelligence and event search | Advanced utilities |
| OpenAPI + downloads | Reference |
| Every path, try-it client | API reference |
| Workflows beyond the spec | REST guide |
Machine-readable entrypoints
starkscan-openapi.yamlfor HTTP routes, schemas, and certification metadata.public-client-surface-matrix.jsonfor RPC, REST, SDK, CLI, and MCP launch state./llms.txtand/llms-full.txtfor crawler-friendly docs discovery./llms.mdx/docs/build/package-trust/content.mdfor the package trust page in Markdown form.
Keep the product close
Use the live explorer on this host when you want to sanity-check what the API returns.
Choose a lane by job
- Use Quickstart when you have a host and a key and need the safest first request.
- Use Starkscan RPC when your app needs a Starknet node URL or JSON-RPC method names.
- Use Build when you are choosing between REST, the TypeScript SDK, and the CLI.
- Use Agents when a coding agent or tool-calling client needs Starkscan instead of direct HTTP.
- Use API reference when you need exact HTTP operations and live try-it execution.
- Use Reference catalogs when you need generated catalogs or deeper implementation context.
Shortest working paths
- API reference when you need every path, method, and parameter in one UI.
- Starkscan RPC for the copyable mainnet node URL and JSON-RPC setup.
- Quickstart for the first successful request and API-key setup.
- REST guide for integration semantics beyond the raw spec.
- Classify addresses in bulk for wallet/paymaster address intelligence.
- Advanced utilities for batch helpers and indexed event search.
- Monitor 10 wallets for the canonical multi-wallet starter across REST, SDK, and CLI.
- Build for the main implementation lane overview.
- TypeScript SDK for app integrations.
- MCP quickstart for Codex, Claude Code, and similar clients.