§ API · PUBLIC DATA ACCESS · CC-BY 4.0

API Documentation

Access BHI structural lock-in data programmatically. All endpoints are public, rate-limited, and licensed under CC-BY 4.0.

GET /api/bhi

Returns all scored platforms with B-index, capture, escape, zone, and 11 individual parameter scores.

Parameters

Name	Type	Description
`sector`	string	Filter by sector ID (e.g. `ai`, `tech`, `banks`)
`format`	string	`json` (default) or `csv`

Example

# All platforms (JSON)
curl https://blackholeindex.com/api/bhi

# AI sector only (CSV)
curl "https://blackholeindex.com/api/bhi?sector=ai&format=csv"

# Specific sector
curl "https://blackholeindex.com/api/bhi?sector=banks"

Response (JSON)

{
  "release": "Q1-2026",
  "model": "V3.1",
  "license": "CC-BY-4.0",
  "count": 100,
  "platforms": [
    {
      "name": "WeChat",
      "category": "social",
      "b_score": 17.03,
      "capture": 2.86,
      "escape": 0.17,
      "zone": "Black Hole",
      "scores": {
        "d": 9, "m": 9, "a": 9,
        "p": 10, "n": 9, "c": 10,
        "x": 1, "s": 1, "h": 1,
        "o": 9, "t": 5
      }
    },
    ...
  ]
}

GET /api/diff

Returns quarterly comparison data — delta, zone migrations, and per-platform movement between the two most recent quarters.

curl https://blackholeindex.com/api/diff

GET /api/platform/[id]/history

Returns quarterly B-score trajectory for a specific platform.

curl https://blackholeindex.com/api/platform/nvidia/history

# Response
{
  "history": [
    { "quarter": "Q4-2025",
      "b": 7.25,
      "capture": 1.918,
      "escape": 0.265 },
    { "quarter": "Q1-2026",
      "b": 8.29,
      "capture": 2.190,
      "escape": 0.260 }
  ]
}

GET /api/badge/[id]

Returns embeddable HTML badge widget. See /embed for the code generator.

<iframe
  src="https://blackholeindex.com/api/badge/tsmc"
  width="320" height="80"
  style="border:none"
  title="BHI Badge">
</iframe>

Rate Limits & Licensing

Rate limit	60 req/min	per IP
Cache	1 hour	max-age=3600
License	CC-BY 4.0	free for research
Attribution	Required	Source: BHI
Updates	Quarterly	Next: Q2-2026

RSS Feed

Subscribe to quarterly releases via RSS.

https://blackholeindex.com/feed.xml