API documentation

API Docs

Start with public reference endpoints, run one Analyst Kit join, then integrate authenticated artifact delivery and historical access when the workflow is proven.

Getting started History access Schema reference Public sample pack Common workflows Analyst Kit

Published reference data

Published revision 2026-08-30.110942

Methodology v1

Public provenance is anchored in date, updated_through, methodology_version, published revision, and regime.determinism_hash.

Product boundary: no price data, no forecasts, and no investment advice. API outputs are descriptive on-chain reference data only.

Start here

The API surface has three entry points. Public endpoints help you inspect the published state. Analyst Kit gives a no-pipeline route to CSV and notebooks. Authenticated files are the subscriber delivery path for production ingestion.

Check validation

Step 1

Inspect public context

Start with status, landing, summary, Analyst Kit CSV and feature schema. No key required.

Open status JSON

Step 2

Run one public join

Open one Analyst Kit CSV, join one daily metric on date + chain, then summarize the metric by regime.

Open Analyst Kit

Step 3

Integrate subscriber files

Use X-API-Key for entitled Gold, Derived, Meta and Briefs artifacts once the workflow is proven.

Open dashboard

First integration check

These calls require no key. Use them to confirm that public status is readable and that a regime-calendar CSV can load directly into a notebook or scheduled data job.

curl https://www.urdatlas.com/api/v1/status

python - <<'PY'
import pandas as pd
url = "https://www.urdatlas.com/api/v1/analyst-kit/ethereum/regime-calendar"
df = pd.read_csv(url)
print(df.tail())
PY

Before you buy

1. Run one public join

Use Analyst Kit to join one chain calendar to one metric you already trust.

2. Inspect sample artifacts

Use the public sample pack, reference, and provenance page.

3. Check subscriber history

History access documents the 90-day Basic entitlement and Pro full archive before you subscribe.

Authentication model

Public endpoints require no key. Authenticated file delivery uses X-API-Key. Keys are created from the dashboard after purchase. Checkout starts a subscription purchase, and the customer portal manages an existing subscription.

curl -H "X-API-Key: ta_live_xxxxxxxxx" https://www.urdatlas.com/api/v1/files/meta/bitcoin/90d/latest.json

Subscriber file path

The authenticated file route supports regular bundle windows for simple scheduled ingestion. Pro can additionally use the manifest and original day-file paths for the complete published archive.

Bundle template: /api/v1/files/[genre]/[chain]/[window]/latest.json

Basic example: /api/v1/files/meta/ethereum/90d/latest.json

Pro archive manifest: /api/v1/files/meta/ethereum/manifest.json

Pro day file: /api/v1/files/meta/ethereum/YYYY-MM-DD.json

Chains: bitcoin, ethereum, arbitrum, base

meta

Regime, confidence, status, scorecard, drivers and methodology context.

gold

Daily canonical metric rows for subscribed chains and windows.

derived

Derived windows and moving summaries built from published data.

briefs

Narrative brief artifacts generated from the published state layer.

Public product endpoints

Method	Path	Purpose
GET	`/api/v1/status`	Per-chain freshness, lag, and publication context.
GET	`/api/v1/landing`	Landing snapshot across supported chains.
GET	`/api/v1/summary/[chain]`	Chain summary with regime, scorecard, confidence, freshness and drivers.
GET	`/api/v1/glossary`	Public glossary payload.
GET	`/api/v1/thresholds/defaults`	Canonical default threshold values.
GET	`/api/v1/methodology/versions`	Published methodology version history.

Analyst Kit endpoints

Analyst Kit is public and optimized for evaluation: CSV, text summary, schema and notebook artifacts that work before the customer has an internal pipeline.

Method	Path	Purpose
GET	`/api/v1/analyst-kit/[chain]/regime-calendar`	CSV calendar for one chain with one row per observation date.
GET	`/api/v1/analyst-kit/[chain]/weekly-summary`	Plain-text network-state summary for reports and review notes.
GET	`/api/v1/analyst-kit/feature-schema`	Machine-readable schema for the Analyst Kit feature table.
GET	`/api/v1/analyst-kit/starter-notebook`	Runnable notebook that loads Urd Atlas and builds an example join.

Authenticated endpoints

Method	Path	Purpose
GET	`/api/v1/files/[genre]/[chain]/[window]/latest.json`	Authenticated delivery for subscriber bundle windows.
GET	`/api/v1/files/[genre]/[chain]/manifest.json`	Pro: discover the complete published archive for Gold, Derived and Meta.
GET	`/api/v1/files/[genre]/[chain]/YYYY-MM-DD.json`	Pro: fetch an original published day file from the full archive.
POST	`/api/v1/keys`	Create a new API key from the dashboard.
DELETE	`/api/v1/keys`	Revoke an API key.
POST	`/api/v1/checkout`	Checkout endpoint for starting a subscription purchase.
POST	`/api/v1/checkout/portal`	Customer portal endpoint for managing an existing subscription.