Starkscan ExplorerStarkscanDocs
QuickstartBuildAgentsReference
Open explorer
Documentation homeQuickstartAuthenticationBase URLs and chainsConceptsGet your first API keyMonitor 10 WalletsPagination and cursorsRead a transactionYour first error
BuildLaunch MatrixPackage TrustAPIAdvanced UtilitiesAgent HTTP quickstartMigration skillsRate limitsRoute CertificationRoute examplesSelf-serve account routesSDKTypeScript SDK

Live reference

Interactive API referenceReference hub
AgentsAgent CLIBuild an agentConnect your agentMCP QuickstartMCP tools reference
Reference Hub
Docs/Build/Launch Matrix

Launch Matrix

Production-readiness status for Starkscan REST, RPC, SDK, CLI, and MCP surfaces.

API referenceReferenceQuickstartTypeScript SDK

In this guide

Current public labelsRoute certificationHow agents should choose
Loading documentation content…
PreviousBuildChoose the right Starkscan integration surface for code and automation.NextPackage TrustPublic trust source for Starkscan npm SDK, CLI, and MCP packages.

On this page

Current public labelsRoute certificationHow agents should choose
Starkscan ExplorerStarkscanDocumentation

One product surface across the explorer, HTTP API, CLI, SDK, and MCP transport. The docs should guide you into the right path instead of behaving like a separate app.

Open explorerAPI referenceBack to top

Launch matrix

Use this page when deciding which Starkscan surface an agent or client should use today.

Machine-readable source: public-client-surface-matrix.json

Package trust surface: Package trust

Current public labels

SurfacePublic labelCurrent useMain blocker
REST core APIcertifiedProduction-safe for named clients on status, block, timestamp-to-block, tx, token total supply, and token balance-of.None for the certified route set.
Starkscan RPC providerprovider pilot, not migration-readyJSON-RPC route and auth shape exist for gated proof. Keep customer traffic on the existing Starknet RPC provider until a dedicated mainnet RPC upstream passes provider-readiness attestation with starknet_specVersion >= 0.10.2.Dedicated mainnet upstream/LB, provider-readiness deploy gate, partner wallet workload report, live parity report, method-level observability, writes, WebSockets, and short-lived RPC-only URL tokens before full-provider promotion.
TypeScript SDKalpha0.1.0-alpha.2 is published on alpha and imports under Node ESM from a clean package install.Resolve publish-control / public-source metadata before promotion beyond alpha.
Agent CLIalpha0.1.0-alpha.2 is published on alpha with bundled native artifacts, manifest/checksum verification, and unauthenticated request IDs with the starkscan-cli- prefix.Resolve publish-control / public-source metadata before promotion beyond alpha.
Hosted MCP HTTPbetaUsable with API-key auth on the hosted /api/mcp endpoint; protected-resource discovery is live.None for the hosted HTTP transport; package launcher promotion is tracked separately.
Official MCP launcheralpha0.1.0-alpha.2 is published on alpha, delegates to the exact matching CLI version, and passes packaged launcher/request-ID smoke.Resolve publish-control / public-source metadata before promotion beyond alpha.

The machine-readable matrix still uses experimental for package surfaces whose publish-control or public-source decisions are incomplete. The human-facing package label is alpha, matching the npm channel and homepage.

Route certification

Route-level certification is surfaced in starkscan-openapi.yaml from the checked-in correctness manifest. The current certified launch set is intentionally narrow:

  • GET /v1/{chain}/status
  • GET /v1/{chain}/block/{number_or_hash}
  • GET /v1/{chain}/block-at-timestamp
  • GET /v1/{chain}/tx/{tx_hash}
  • GET /v1/{chain}/token/{token}/total-supply
  • GET /v1/{chain}/token/{token}/balance-of/{address}

GET /v1/{chain}/block-at-timestamp is certified for turning a calendar-close instant into the concrete block number used by the certified balance-of route. The certified accounting workflow is one known token contract, one account, and one timestamp; portfolio-wide historical holdings stay outside this certification.

The Starkscan RPC provider at POST /api/v1/{chain}/rpc is separate from the certified REST launch set. The route and auth shape exist, but it is not a customer migration target until a dedicated mainnet RPC upstream passes provider-readiness proof. Server clients should use X-Starkscan-Api-Key; SDKs/tools that cannot attach headers can use /rpc/v0_10/{chain}/{token} as a compatibility nodeUrl only after that proof. Treat that full URL as a secret.

Indexed lists, holder analytics, privacy-pool routes, markets, and protocol routes stay beta unless the OpenAPI operation and current evidence say otherwise.

How agents should choose

  • Start with REST when you need the exact wire contract.
  • Use Starkscan RPC only after the provider-readiness gate is green; keep existing providers for current JSON-RPC migrations.
  • Use the TypeScript SDK when your app wants typed request construction and response shapes.
  • Use the CLI for shell workflows and local exports.
  • Use MCP only when the caller is already an MCP client.

Correctness is the hard launch gate. If a route is slow but certified, use backoff, caching, or lower concurrency. If a route is fast but still beta, do not put it in unattended production workflows without an explicit client agreement.

Package trust is a separate gate. A package can wrap certified routes while still being experimental if its tokenless publish path, public-source metadata, or external risk signals are incomplete. npm provenance is not available while the canonical source repository is private. See Package trust.

For certified token reads, latest and pending remain live moving-state shortcuts. Agents that need reproducible correctness should pass an explicit block number or block hash as block_tag; the launch gate compares the route and Starknet RPC at that same exact block.