Quickstart

This guide will get you set up to call the Arcane API and make your first request. The API powers the dashboard by returning signal snapshots, per-symbol state, state history, and validation artifacts.

Choose your access mode

Option A: Dashboard proxy (recommended)

Use the dashboard base URL and call the proxy path. No API key is required because the dashboard signs requests server-side.

Option B: Direct backend (partners/customers)

Call the backend base URL and include X-API-Key on protected endpoints.

Making your first API request

The simplest “hello world” endpoint is GET /health (no auth), followed by GET /snapshot (auth depends on access mode).

GET
/health
curl "https://YOUR_DASHBOARD_DOMAIN/api/proxy/health"
GET
/snapshot
curl "https://YOUR_DASHBOARD_DOMAIN/api/proxy/snapshot"

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Arcane Analytics API: