starkscan.co

# Docs

- Getting started
  - [Quickstart](/docs/getting-started): Get connected to Starkscan quickly with a public host, a bounded API key, and no repo setup.
  - [Get your first API key](/docs/getting-started/get-an-api-key): Create a Starkscan API key and make your first authenticated call in under five minutes.
  - [Your first error](/docs/getting-started/your-first-error): The handful of responses you hit on a first Starkscan call — what each means and the exact fix.
  - [Concepts](/docs/getting-started/concepts): Terms you will see across Starkscan docs—URLs, auth, pagination, and API tiers.
  - [Authentication](/docs/getting-started/authentication): Send X-Starkscan-Api-Key on every request, and how to read 401, 403, and 429 responses.
  - [Base URLs and chains](/docs/getting-started/base-urls-and-chains): Use https://api.starkscan.co/v1/{chain}/... for hosted integrations, and discover the chain from the API instead of assuming one.
  - [Pagination and cursors](/docs/getting-started/pagination-and-cursors): Treat cursors as opaque and follow nextCursor — never build or parse a cursor by hand.
  - [Read a transaction](/docs/getting-started/read-a-transaction): Fetch a transaction's full detail and its execution trace over REST or the TypeScript SDK.
  - [Monitor 10 Wallets](/docs/getting-started/monitor-10-wallets): Canonical HTTP, SDK, and CLI starter for monitoring a fixed wallet set with block-pinned wallet state.
- Rpc
  - [Starkscan RPC](/docs/rpc): An authenticated Starknet JSON-RPC beta — connection forms, capability discovery, supported methods, and failure handling.
  - [Method reference](/docs/rpc/methods): The current Starknet JSON-RPC HTTP allowlist — parameters, representative result or error shapes, and rate-limit classes.
  - [RPC errors](/docs/rpc/errors): The JSON-RPC and HTTP error contract for Starkscan RPC — codes, envelopes, backoff, and fail-closed classes.
- API
  - [API](/docs/api): How to call Starkscan REST—base URL, auth, lists, errors. Paths live in the API reference.
  - [Classify Addresses In Bulk](/docs/api/address-intelligence): Use address summaries and address intelligence for ordered, indexed wallet and contract classification.
  - [Advanced Utilities](/docs/api/advanced-utilities): External helper routes that are published, supported, and narrower than the main public lane.
  - [Agent HTTP quickstart](/docs/api/agent-quickstart): Give an agent a bounded Starkscan HTTP contract without making it guess base paths, auth, or route scope.
  - [Class directory and coverage](/docs/api/classes): Read class origins, observed instances, labels, and classification coverage without mistaking a window for a census.
  - [API discovery](/docs/api/discovery): Configure a Starkscan client from the REST capabilities contract, OpenRPC discovery, and the API catalog.
  - [Event decoding](/docs/api/event-decoding-certification): Canonical event payloads, decoding statuses, provenance, and honest coverage claims.
  - [Migration skills](/docs/api/migration-skills): Download source-backed SKILL.md artifacts for Voyager migration and accounting point-in-time balances.
  - [Privacy Pool metrics and note evidence](/docs/api/privacy-pool-activity): Integrate public activity counters, prepared series, events, commitments, and nullifiers without inferring private state.
  - [Privacy Pool data API](/docs/api/privacy-pool): Read finalized public-flow amounts without inferring private ownership.
  - [Rate limits](/docs/api/rate-limits): Understand Starkscan route-class budgets, headers, and the correct retry behavior for external API keys.
  - [Retryable API errors](/docs/api/retry): How to handle Starkscan 503 responses and Retry-After without hiding stale or incomplete data.
  - [Route Certification](/docs/api/route-certification): How Starkscan publishes client-facing route certification states.
  - [Route examples](/docs/api/route-examples): Exact examples for Starkscan routes that agents most often misread: block reads, search, trace, contract reads, previews, discovery, and wallet state.
  - [RPC WebSocket beta](/docs/api/rpc-websocket-beta): Use the Starkscan JSON-RPC WebSocket route only after your key and workload are explicitly enrolled.
  - [Self-serve account routes](/docs/api/self-serve): Session-authenticated routes for the signed-in user's personal Starkscan workspace and self-serve API keys.
  - [Prepared staking API](/docs/api/staking): Finalized staking summaries, validators, delegators, activity, coverage, and SDK usage.
  - [STRK20 prover relay](/docs/api/strk20-prover): Submit STRK20 transaction proofs through Starkscan as asynchronous jobs, with per-key budgets and an explicit delivery-safety contract.
  - [Token holders and whale screening](/docs/api/token-holders): Choose bounded Top-N screening or a complete immutable holder walk without overstating coverage.
  - [Migrate To Wallet State](/docs/api/wallet-state-migration): Replace retired indexed token holdings with separate discovery and block-pinned wallet-state calls.
- SDK
  - [SDK](/docs/sdk): First-party Starkscan SDK guidance and typed client entry points.
  - [TypeScript SDK](/docs/sdk/typescript): Use the first-party Starkscan TypeScript client when you want typed explorer reads in application code.
- Agents
  - [Agents](/docs/ai): Use Starkscan with coding agents through the CLI and hosted MCP transport.
  - [Agent CLI](/docs/ai/agent-cli): Use the Starkscan CLI for shell workflows, release validation, and local-first exports.
  - [Build an agent](/docs/ai/build-an-agent): A worked example — connect the Starkscan MCP server, then explore Starknet with a safe read-first workflow.
  - [Connect your agent](/docs/ai/connect-your-agent): Add the hosted Starkscan MCP server to Claude, Cursor, Claude Desktop, Cline, or Codex.
  - [MCP Quickstart](/docs/ai/mcp-quickstart): Connect Starkscan to Codex, Claude Code, and similar MCP clients without losing the app and API context.
  - [MCP tools reference](/docs/ai/mcp-tools-reference): The full Starkscan MCP tool catalog, including block-pinned wallet state.
- Wallets
  - [Wallets](/docs/wallets): The calls a consumer wallet, paymaster, or portfolio client needs, mapped to the screens that use them.
- Build
  - [Build](/docs/build): Choose the right Starkscan integration surface for code and automation.
  - [Launch Matrix](/docs/build/launch-matrix): Production-readiness status for Starkscan REST, RPC, SDK, CLI, and MCP surfaces.
  - [Package Trust](/docs/build/package-trust): Public trust source for Starkscan npm SDK, CLI, and MCP packages.
  - [Public Client 1.0 Contract](/docs/build/public-client-1-0-contract): Semver, deprecation, and conformance policy for Starkscan SDK, CLI, and MCP packages.
- Reference Hub
  - [Reference Hub](/docs/reference): Choose the right Starkscan reference surface and use the API reference as the canonical HTTP contract.