exascale.build
api ↗Connect

Docs → API reference

Power Fuel Receipts and Costs API v1

Generated from core.contract.describe_power_fuel_cost_v1() and checked fixture-backed examples. Do not hand-edit the example JSON files.

Capability

What It Can Answer

Represented Facts

Data Point Contract

Does not answer:

REST Surface

MCP Surface

Local MCP Setup

Some MCP clients launch servers from the user's home directory or ignore a configured cwd. Use uv run --directory so the server always starts from the repository project.

{
  "command": "uv",
  "args": [
    "run",
    "--directory",
    "/absolute/path/to/OSINT",
    "python",
    "-m",
    "core.mcp_server"
  ]
}

Leave EXASCALE_PARQUET_BASE / EXASCALE_RAW_BASE unset: the one server hosts every data point's tools, and with no override it resolves each block's promoted snapshots and raw archive from the repository layout. Setting either env var points ALL tools at one directory — a per-block path breaks every other block's tools. They exist only for single-source sandboxes and tests.

Request Schema

Filters:

Group by:

Date range parameters:

Controls:

Ranking (how order_by / top_n / order join — order_by ranks groups by a metric, never a group_by dimension; top_n needs both a group_by and an order_by):

{
  "no_ranking": "Omit order_by and top_n to return all groups in group-key order.",
  "order": {
    "default": "desc",
    "valid_values": [
      "desc",
      "asc"
    ]
  },
  "order_by": {
    "accepts": "one of output.metrics",
    "note": "Ranks the groups by a metric (a measure). Not a group_by dimension \u2014 rows already come back grouped by each group_by field.",
    "requires": [
      "group_by"
    ],
    "valid_values": [
      "quantity",
      "delivered_fuel_cost_cents_per_mmbtu",
      "source_record_count",
      "reported_cost_count",
      "withheld_cost_count"
    ]
  },
  "top_n": {
    "note": "Keeps the top N groups by order_by; the rest fold into one (other) remainder (additive metrics sum into it, non-additive ones are nulled) so the result still reconciles to summary.totals.",
    "requires": [
      "group_by",
      "order_by"
    ],
    "type": "positive integer"
  }
}

Output Schema

Aggregate metrics:

Metric groups:

{
  "fuel_receipt": [
    "quantity",
    "delivered_fuel_cost_cents_per_mmbtu"
  ],
  "records": [
    "source_record_count",
    "reported_cost_count",
    "withheld_cost_count"
  ]
}

Response summary fields:

Accepted fact policy:

Metric metadata:

Metric Category Unit Aggregation Additive Across Groups Authoritative Total Definition
quantity fuel_receipt source physical unit single receipt value only false summary.totals.quantity EIA-923 receipt quantity in the physical unit implied by the fuel code.
delivered_fuel_cost_cents_per_mmbtu fuel_receipt cents/MMBtu single receipt value only false summary.totals.delivered_fuel_cost_cents_per_mmbtu EIA-923 delivered fuel cost in cents per MMBtu for one receipt row.
source_record_count records count count source records true summary.totals.source_record_count Count of EIA-923 Page 5 receipt rows in scope.
reported_cost_count records count conditional count true summary.totals.reported_cost_count Count of receipt rows with a numeric FUEL_COST cell.
withheld_cost_count records count conditional count true summary.totals.withheld_cost_count Count of unregulated receipt rows whose FUEL_COST cell is EIA's '.' marker.

Rollup rules:

Detail record fields returned when include_records is true:

Row-level citation fields:

Aggregate citation fields:

Codebooks

Field Coverage Codes Examples Note

The complete machine-readable codebooks are included in capability-schema.json.

Checked Examples

Agent question Request params Checked output
What receipt quantity and delivered fuel cost did plant 26 report? {"data_month": "2026-01-01", "eia_plant_id": 26} plant-fuel-receipt.json
Which January receipt rows are in the Texas ERCOT slice? {"balancing_authority_code": "ERCO", "data_month": "2026-01-01", "state": "TX"} ercot-fuel-receipts.json
Which receipt costs are explicitly withheld? {"is_withheld": true} withheld-fuel-costs.json
Return one fuel receipt with an exact cost-cell citation. {"data_month": "2026-01-01", "eia_plant_id": 26, "limit": 1} fuel-cost-detail-with-citation.json
Verify the raw workbook row behind a returned citation citations[ref].verify (aggregate) or records[0].citation (detail) source-row-evidence.json
Dogfood the tool sequence as an agent list -> describe -> query -> evidence agent-dogfood-transcript.json

The checked schema output is capability-schema.json.

Agent Workflow

  1. Call list_capabilities_v1 and select power.fuel_cost.
  2. Call describe_power_fuel_cost_v1 to inspect valid filters, groupings, metrics, and citation fields.
  3. Call query_power_fuel_cost_v1 with bounded JSON params.
  4. If the answer needs proof, pass a returned row-level citation object to get_source_evidence_v1.
  5. Answer with the resolved as_of and relevant citations. Present returned metrics as authoritative for their declared source, snapshot, grain, and aggregation.
Generated from the tested API contract. Compare with the live capability map ↗