Skip to content

explorer-api

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

explorer-api

README.md

Boundless Explorer API

Clients for the Boundless Indexer API on Base (chain ID: 8453).

Clients

Web App (web/)

Svelte 5 + TypeScript SPA for exploring API endpoints interactively.

cd web && bun install && bun run dev

Open http://localhost:5173

Deployment (Cloudflare Workers + Access)

This repo includes a Workers + Access setup:

  • Worker config: wrangler.toml
  • Worker entry: worker/index.ts
  • Access policy automation: infra/ (Terraform)

Build & deploy the SPA

Set the build-time env vars for Supabase:

  • VITE_SUPABASE_URL
  • VITE_SUPABASE_ANON_KEY (or SUPABASE_API_KEY)
  • VITE_TRACKER_CLIENT_ID (optional)

Then:

npm --prefix web ci
npm --prefix web run build
npx wrangler deploy

If you want a custom domain (recommended for Access), update the route in wrangler.toml to match your hostname.

Apply Cloudflare Access policy via Terraform

In infra/, create a terraform.tfvars (see infra/README.md), then:

terraform init
terraform apply

Ensure app_domain matches the hostname used in wrangler.toml so Access protects the deployed Worker.

CI/CD (optional)

Suggested order:

npm --prefix web ci
npm --prefix web run build
npx wrangler deploy
cd infra && terraform init && terraform apply

API Endpoints

Base URL: https://d2mdvlnmyov1e1.cloudfront.net

Working Endpoints (11)

Endpoint Description
GET /health Service health check
GET /v1/market Current indexing status
GET /v1/market/aggregates Time-series stats (hourly/daily/weekly/monthly)
GET /v1/market/cumulatives All-time market statistics
GET /v1/market/requests Paginated list of proof requests
GET /v1/market/requests/{id} Single request by ID
GET /v1/market/provers/{addr}/requests Prover's fulfilled requests
GET /v1/market/requestors/{addr}/requests Requestor's submissions
GET /v1/market/requestors/{addr}/aggregates Requestor time-series
GET /v1/market/requestors/{addr}/cumulatives Requestor all-time stats

Empty Data Endpoints (16)

These endpoints work but return empty results (not yet enabled):

  • Staking (4): /v1/staking/addresses, /v1/staking/addresses/{addr}, /v1/staking/epochs, /v1/staking/epochs/{epoch}/addresses
  • PoVW (4): /v1/povw/addresses, /v1/povw/addresses/{addr}, /v1/povw/epochs, /v1/povw/epochs/{epoch}/addresses
  • Delegations Rewards (4): /v1/delegations/rewards/...
  • Delegations Votes (4): /v1/delegations/votes/...

Broken Endpoints (4)

Endpoint Error
GET /v1/staking 500
GET /v1/staking/epochs/{epoch} 500
GET /v1/povw 404
GET /v1/povw/epochs/{epoch} 404

Query Parameters

Parameter Default Description
limit 50 Results per page (max: 100)
offset 0 Results to skip
sort desc Order: "asc" or "desc"
sort_by created_at Field: "created_at" or "updated_at"
aggregation - "hourly", "daily", "weekly", "monthly"
before - Unix timestamp upper bound
after - Unix timestamp lower bound

Sample Addresses

  • Prover: 0xf6071162fb00d79f2b62d98a1a3f8a10fdcd094f
  • Requestor: 0xe198c6944cae382902a375b0b8673084270a7f8e

Resources