Build

Choose the right Starkscan integration surface for code and automation.

In this guide

Loading documentation content…

Choose the Starkscan surface by job.

Surface map

If you need...	Use...
exact HTTP contract, auth, retries, pagination	REST API
typed application code	TypeScript SDK
shell workflows or local exports	Agent CLI
tool-calling access for an agent	MCP

export MEZCAL_BASE_URL="https://<your-mezcal-host>/api"
export MEZCAL_API_KEY="mzk_live_your_key_here"
export MEZCAL_CHAIN="SN_MAIN"

All build surfaces use the same hosted contract underneath.

always send X-Starkscan-Api-Key; X-Mezcal-Api-Key remains accepted as a legacy alias
treat 401 as missing or invalid credentials
treat 403 as a real scope or route-tier mismatch
treat 429 as a route-class budget hit and honor Retry-After
honor Retry-After on 503
log X-Request-Id
do not assume hidden /v1/* app routes are external

High-cardinality routes are cursor-based.

Expect:

bounded limit parameters
items arrays
nextCursor when another page exists
repeated query parameters where documented, for example multiple address= filters on token transfers

Representative routes:

Treat the hosted /api lane as a bounded external service:

For multi-wallet monitoring, use Monitor 10 wallets.