Starkscan ExplorerStarkscanDocs
Open explorer

Starkscan docs

Start with Quickstart, then move into Build, Agents, or the live API reference without losing the explorer context.

The same REST contract powers the dashboard you see on this host, the SDK, and the CLI. MCP is the separate tool surface for coding agents. Pick a path below or open the core HTTP catalog first, then use the reference pages when you need deeper context.

Get API keyBrowse all endpointsQuickstartBuildOpen explorer

First request

Validate this deployment

Paste this into requests.http, confirm the host and key, then decide whether the next step belongs in Build, Agents, the API reference, or the live explorer.

bash
@starkscan = https://<your-starkscan-host>/api
@chain = SN_MAIN
@apiKey = mzk_live_your_key_here

GET {{starkscan}}/v1/{{chain}}/status
X-Starkscan-Api-Key: {{apiKey}}
Open quickstart

Choose a path

By job

Integrate, automate, or explore—use the surface that matches the work.

Quickstart for wiring and keys. Build when you are choosing REST vs SDK vs CLI. Agents for MCP and tool-calling clients. API reference when you need exact HTTP operations, the OpenAPI file, or try-it requests. Deeper reference catalogs stay available, but they should not compete with the primary HTTP path.

QuickstartBuildAgentsAPI referenceReference catalogsLive product

HTTP contract

Core explorer API in one place

API reference is generated from the same OpenAPI artifact as the TypeScript SDK and CLI. Use it for paths and parameters; use the REST guide for workflows, auth expectations, and common pitfalls.

Get API keyOpen interactive referenceDownload OpenAPIREST integration guide

Current public labels

One API key, four surfaces, explicit launch state.

Use one Starkscan API key across REST, SDK, CLI, and hosted MCP. REST core routes are certified; SDK and CLI packages are alpha; hosted MCP is beta while the npm launcher remains alpha.

REST · certified

HTTP API

Certified core reads from the Starkscan OpenAPI contract, with live request execution and auth support.

CLI · alpha

Command Line

Alpha package for shell-first workflows, hosted API validation, and local JSON exports.

MCP · beta hosted / alpha launcher

Agents and MCP

Hosted HTTP MCP beta plus the alpha npm launcher for Codex, Claude Code, Cursor, and similar clients.

SDK · alpha

TypeScript SDK

Alpha TypeScript client for application code built against the same public contract used by the explorer UI.

Docs structure

Four lanes, one product.

Quickstart is the default first stop. Build, Agents, and the API reference exist as clear follow-on lanes instead of competing top-level transports.

Quickstart

First request

Start here for the first successful request, host validation, and the safest external onboarding path.

Build

Build with Starkscan

Compare REST, SDK, and CLI from one lane before you commit to implementation details.

Agents

Agents and MCP

Connect Codex, Claude Code, Cursor, and other tool-calling clients through the dedicated agent lane.

Reference

Open API reference

Open the live API reference first for exact HTTP operations, try-it requests, and OpenAPI downloads; deeper catalogs stay behind the main reference lanes.

Build

Pick HTTP, CLI, SDK, or agents—then stay on the same contract.

All application paths compile against the public OpenAPI surface. Start with HTTP when you want zero install; move to the SDK for typed clients or the CLI for shell automation.

Certified

REST API

HTTP API

Certified core reads from the Starkscan OpenAPI contract, with live request execution and auth support.

  • Certified status, block, tx, supply, and balance routes
  • Best for direct service integrations
Open
Alpha

CLI

Command Line

Alpha package for shell-first workflows, hosted API validation, and local JSON exports.

  • Uses the same Starkscan API key
  • Best for exports and operational workflows
Open
Beta hosted / alpha launcher

Agents

Agents and MCP

Hosted HTTP MCP beta plus the alpha npm launcher for Codex, Claude Code, Cursor, and similar clients.

  • Hosted MCP beta at /api/mcp
  • 18 tools listed: bootstrap + 17 route tools
Open
Alpha

SDK

TypeScript SDK

Alpha TypeScript client for application code built against the same public contract used by the explorer UI.

  • Uses the same Starkscan API key
  • Best for app teams that want typed responses
Open

Recommended paths

Shortcuts to a working integration.

Quickstart, Build, and the API reference should behave like deliberate routes through the product, not like unrelated documentation buckets.

Quickstart

Start from a successful first request

Get a public Starkscan key connected, verify curl, install the CLI, and move into a known-good request path.

  • API key auth and curl verification
  • CLI install and first request
Follow this path

Build

Choose the right build surface

Compare the REST API, TypeScript SDK, and CLI from one lane before you commit to an implementation surface.

  • REST, SDK, and CLI entry points
  • Auth expectations and integration tradeoffs
Follow this path

Reference

Keep exact reference close at hand

Start with the live API reference for exact HTTP shapes, try-it requests, and OpenAPI downloads; move into the deeper reference lanes only when you need implementation context.

  • Live requests and OpenAPI download
  • Deeper catalogs
Follow this path

Live product

Same data as the API—rendered in the explorer.

Open these in a new context on this host when you want to compare JSON payloads to what users see in the UI.

Live product

Open dashboard

Chain health, latest activity, and the fastest entry point into the live explorer.

Product surface

Browse transactions

Inspect compact transaction rows, intent labeling, and detail pages from the live product surface.

Product surface

Browse contracts

Review contracts, deployment metadata, holders, and activity from the same UI users actually rely on.

Product surface

Open watchlist

Track saved addresses and revisit high-signal entities without rebuilding searches from scratch.