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 a public HTTP contract (OpenAPI) and parallel docs lanes:

Quickstart — first request, keys, and host check
Get an API key — create or rotate the key used by REST, SDK, CLI, and MCP
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 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	What works today
REST core API	`certified`	Status, block detail, timestamp-to-block, transaction detail, token total supply, and token balance-of on `/v1/{chain}/*`.
TypeScript SDK	`alpha`	`@starkscan/sdk@alpha` wraps the same REST contract for typed app code.
Agent CLI	`alpha`	Pin exact `@starkscan/[email protected]` for scriptable JSON workflows and `X-Starkscan-Api-Key` auth.
Hosted MCP	`beta` hosted / `alpha` launcher	`{baseUrl}/mcp` is the hosted HTTP beta; pin exact `@starkscan/[email protected]` launcher in agent configs.

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
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
REST/SDK/CLI/MCP launch state	Launch matrix
OpenAPI + downloads	Reference
Every path, try-it client	API reference
Workflows beyond the spec	REST guide

Machine-readable entrypoints

starkscan-openapi.yaml for HTTP routes, schemas, and certification metadata.
public-client-surface-matrix.json for REST, SDK, CLI, and MCP launch state.
/llms.txt and /llms-full.txt for crawler-friendly docs discovery.
/llms.mdx/docs/build/package-trust/content.md for 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 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.
Quickstart for the first successful request and API-key setup.
REST guide for integration semantics beyond the raw spec.
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.

Documentation home