API reference

Read-only, unauthenticated JSON over HTTPS. All endpoints are static files on a static host — stable URLs, versioned under /api/v1/. The machine-readable description is openapi.json.

Conventions

  • Base URL: https://heliovulcan.com.au
  • All endpoints are GET; responses are UTF-8 application/json;
  • every response carries canonical_url (human page), methodology_url, version and updated_at;
  • dates are YYYY-MM-DD (or YYYY-MM where only the month is known);
  • dollar values are indicative AUD screening-model outputs — see each claim's claim_type, confidence and limitations.

GET /api/v1/projects/remote-mining-asset.json

Project entity: identity, location, technology, data coverage, registry stats and all related links.

{
  "id": "project_remote_mining_asset",
  "canonical_url": "https://heliovulcan.com.au/projects/remote-mining-asset/",
  "name": "Remote Mining Asset — Hybrid Energy Pre-DD",
  "entity_type": "hybrid_energy_project_screen",
  "location": { "country": "Australia", "state_or_territory": "Northern Territory" },
  "technology": ["solar_pv", "battery_energy_storage", "diesel_generation"],
  "version": "1.0",
  "updated_at": "2026-07-23",
  "stats": { "claims_total": 14, "public_sources": 4, "...": "..." },
  "api": {
    "claims_url": "https://heliovulcan.com.au/api/v1/projects/remote-mining-asset/claims.json",
    "evidence_url": "https://heliovulcan.com.au/api/v1/projects/remote-mining-asset/evidence.json"
  }
}

GET /api/v1/projects/remote-mining-asset/claims.json

The claim registry. Each claim:

{
  "claim_id": "FH-LOAD-001",
  "statement": "Indicative annual electricity demand ... approximately 30 GWh per year.",
  "value": 30,
  "unit": "GWh/year",
  "claim_type": "derived",
  "confidence": "medium",
  "method_id": "METHOD-LOAD-RECONSTRUCTION-01",
  "evidence_ids": ["EVID-FH-EIS-MAIN-01"],
  "last_verified": "2026-07-23",
  "status": "published",
  "limitations": "..."
}

claim_type enum: reported · public_source · calculated · derived · interpreted · assumption · unresolved · owner_confirmation_required. confidence enum: high · medium · low. Definitions: methodology.

GET /api/v1/projects/remote-mining-asset/evidence.json

The evidence registry. Each object:

{
  "evidence_id": "EVID-FH-EIS-MAIN-01",
  "source_title": "Draft EIS, main report — Northern Territory gold project",
  "publisher": "Project proponent (published via the NT EPA assessment register)",
  "source_url": "https://ntepa.nt.gov.au/...",
  "document_date": "2021-05",
  "accessed_at": "2026-07-23",
  "page_or_section": "Section 3.8.1.1 (p. 3-46) and Table 3.19",
  "supports_claims": ["FH-LOAD-001", "FH-LOAD-002", "FH-FUEL-001"],
  "evidence_type": "primary_public_document",
  "evidence_quality": "high"
}

A source_url of null always co-occurs with "status": "unresolved" — missing sources are published as gaps, never invented.

Errors

The API is served as static files: an unknown path returns the host's standard HTTP 404 with an HTML body (not JSON). There are no auth errors (no auth) and no server-side query parameters — any query string is ignored.

Versioning & stability

  • /api/v1/ URLs are stable; breaking changes would ship under /api/v2/;
  • additive fields may appear within v1 — consume tolerantly;
  • registry content changes bump the version / updated_at fields inside the payloads;
  • source data and JSON are generated from one structured source with schema validation (claims schema, evidence schema, project schema).