Starkscan

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, and CLI
  • 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 — coding-agent setup
  • Wallets — the calls a wallet, paymaster, or portfolio client needs, by screen
  • API reference — exact HTTP operations and live try-it execution

Current public labels

Use one Starkscan API key across RPC, REST, SDK, and CLI. The labels below are the public onboarding labels; route-level certification still lives on each OpenAPI operation.

SurfacePublic labelCurrent state
REST core APIcertifiedStatus, block detail, timestamp-to-block, transaction detail, token total supply, and token balance-of on /v1/{chain}/*.
Starkscan RPCauthenticated HTTP betaUse 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 SDKstable@starkscan/sdk availability is registry-authoritative. Require live registry and post-publish proof for the 0.4.1 release target.
Agent CLIstable@starkscan/cli availability is registry-authoritative. Require the 0.5.6 dist-tag, four native artifacts, custom-CA/TLS-cause proof, and hosted verification smoke before relying on worker-parity validation, locked Git dependency normalization, and daily-quota recovery guidance.

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 repository links or package metadata alone.

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.

GoalLink
Create or rotate a keyAPI keys
RPC node URLStarkscan RPC
First request & keysQuickstart
Terms (base URL, tiers, cursors)Concepts
Pick REST vs SDK vs CLIBuild
Codex, Claude Code, CursorAgents
Build a wallet, paymaster, or portfolio viewWallets
Package trust and npm channel statePackage trust
RPC/REST/SDK/CLI launch stateLaunch matrix
Classify addresses in bulkAddress intelligence
Batch address intelligence and event searchAdvanced utilities
OpenAPI + downloadsReference
Every path, try-it clientAPI reference
Workflows beyond the specREST guide

Machine-readable entrypoints

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 Wallets when you are rendering one user's balances, activity, and transactions.
  • 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

  1. API reference when you need every path, method, and parameter in one UI.
  2. Starkscan RPC for the copyable mainnet node URL and JSON-RPC setup.
  3. Quickstart for the first successful request and API-key setup.
  4. REST guide for integration semantics beyond the raw spec.
  5. Classify addresses in bulk for wallet/paymaster address intelligence.
  6. Advanced utilities for batch helpers and indexed event search.
  7. Monitor 10 wallets for the canonical multi-wallet starter across REST, SDK, and CLI.
  8. Build for the main implementation lane overview.
  9. TypeScript SDK for app integrations.
  10. Connect your agent for Codex, Claude Code, and similar agents.

On this page