Mezcal ExplorerMezcalDocs
Open explorer

Mezcal 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 protocol reference when you need extension routes.

Browse all endpointsQuickstartBuildOpen explorer

First request

Validate this deployment

Run status against this host, confirm your key, and decide whether the next step belongs in Build, Agents, the API reference, or the live explorer.

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

curl \
  -H "X-Mezcal-Api-Key: $MEZCAL_API_KEY" \
  "$MEZCAL_BASE_URL/v1/$MEZCAL_CHAIN/status"
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. For protocol routes, use the protocol reference.

Open interactive referenceDownload OpenAPIREST integration guide

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 Mezcal

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; move into protocol routes and deeper catalogs only when needed.

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.

Start here

REST API

HTTP API

Interactive try-it reference generated from the Mezcal OpenAPI contract, with live request execution and auth support.

  • Live request execution
  • Best for application and pipeline integrations
Open
Local-first

CLI

Command Line

Shell-first workflows for token reads, transfer exports, hosted API validation, and privacy-sensitive local analysis.

  • Local-first execution
  • Best for exports and operational workflows
Open
Agent-ready

Agents

Agents and MCP

Claude Code, Codex, and hosted HTTP MCP transport docs with setup, auth, tool reference, and rollout guidance.

  • Hosted MCP and stdio setup
  • Best for agent workflows and tool calling
Open
Typed

SDK

TypeScript SDK

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

  • Typed TypeScript client
  • Best for app teams building on the public contract
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 Mezcal 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 deeper catalogs only when you need implementation context.

  • Live requests and OpenAPI download
  • Protocol routes and 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.