GET /api/v1/index.json
API index. What this API is, its license and attribution, the sections it covers, and every endpoint.
Example: https://the-scramble.com/api/v1/index.json
Sample response
{
"api": "The Scramble Data API",
"version": "v1",
"docs": "https://the-scramble.com/api",
"data_as_of": "2026-11-10",
"data_as_of_label": "Nov 10, 2026",
"data_pulled_at": "2026-11-11T00:56:23.757Z",
"generated_at": "2026-11-11T18:39:11.422Z",
"attribution": "Credit The Scramble (the-scramble.com) with a visible link to the page the figure came from; every record carries its page_url.",
"name": "The Scramble Data API",
"description": "Free JSON for every number published on The Scramble (the-scramble.com): national board, New York, cage-free, egg products, inventory, cold storage, HPAI tracker, retail prices, price history, US production. The shell-egg market in one screen.",
"publisher": {
"name": "The Scramble",
"url": "https://the-scramble.com"
},
"auth": "none",
"cors": "*",
"format": "application/json; charset=utf-8",
"license": "Free to use and republish with attribution; no key or sign-up. The underlying figures are public records from the agencies named in each series' provenance; The Scramble collects, checks and publishes them.",
"update_policy": "Static files rebuilt every time the site rebuilds with new data. data_as_of in each response is the newest observation it holds; data_pulled_at is when the site last pulled its sources.",
"counts": {
"series": 11,
"stats": 16
},
"sections": [
{
"key": "national",
"label": "National board",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/national/large-white.json"
},
{
"key": "region",
"label": "New York",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/region/new-york.json"
},
{
"key": "cagefree",
"label": "Cage-free",
"series": 2,
"example": "https://the-scramble.com/api/v1/series/cagefree/premium.json"
},
{
"key": "products",
"label": "Egg products",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/products/liquid-whole.json"
},
{
"key": "inventory",
"label": "Inventory",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/inventory/national.json"
},
{
"key": "coldstorage",
"label": "Cold storage",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/coldstorage/frozen-total.json"
},
{
"key": "hpai",
"label": "HPAI tracker",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/hpai/layer-flocks.json"
},
{
"key": "retail-egg-prices",
"label": "Retail prices",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/retail-egg-prices/us-average.json"
},
{
"key": "egg-price-history",
"label": "Price history",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/egg-price-history/us.json"
},
{
"key": "us-egg-production",
"label": "US production",
"series": 1,
"example": "https://the-scramble.com/api/v1/series/us-egg-production/us.json"
}
],
"endpoints": [
{
"method": "GET",
"path": "/api/v1/index.json",
"url": "https://the-scramble.com/api/v1/index.json",
"description": "What this API is, its license and attribution, the sections it covers, and every endpoint."
},
{
"method": "GET",
"path": "/api/v1/latest.json",
"url": "https://the-scramble.com/api/v1/latest.json",
"description": "The newest reading of every data page on The Scramble (11 series): the headline value as the site shows it, the newest point of each charted line with its date, whether it is current, and links to its page and full history."
},
{
"method": "GET",
"path": "/api/v1/stats.json",
"url": "https://the-scramble.com/api/v1/stats.json",
"description": "The 16 headline numbers on the the-scramble.com/stats page, each as a quotable sentence with its data date and a ready-made citation."
},
{
"method": "GET",
"path": "/api/v1/series/{section}/{slug}.json",
"url": "https://the-scramble.com/api/v1/series/national/large-white.json",
"description": "Everything behind one data page: every charted point (date + value), the historical band where the page draws one, the page's tables exactly as shown, its source and citation. Find each series_url in latest.json."
},
{
"method": "GET",
"path": "/api/v1/openapi.json",
"url": "https://the-scramble.com/api/v1/openapi.json",
"description": "A machine-readable OpenAPI 3.1 description of these endpoints."
}
]
}