Docs → API reference

Power Retail Sales API v1

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

Capability

• Capability: power.retail_sales
• Primitive: query_power_retail_sales_v1
• Status: available
• Current source: energy.eia.eia861
• Source publisher: U.S. Energy Information Administration
• Snapshot behavior: as_of = latest resolves to an exact snapshot date in every response.

What It Can Answer

• Annual retail electricity sales (billed MWh) by utility, state, and customer sector.
• Annual retail revenue (thousand dollars) and customer counts at the same grain.
• Service-type structure (bundled vs energy-only vs delivery-only) per utility and state.
• State-level Adjustment and Withheld sentinel handling — kept in state totals, excluded from utility-keyed answers.
• Row-level detail records when include_records is true.
• Raw workbook cell evidence (down to the stacked sector/measure cell) for any returned row-level citation.

Represented Facts

• EIA-861 reports annual retail electricity sold to ultimate customers — billed sales (MWh), revenue, and customer counts — by utility, state, and customer sector
• EIA-861 reports the filing part and service type (bundled / energy-only / delivery-only) behind each utility×state row

Data Point Contract

• Data point: power.retail_sales
• Product spec: blocks/power_retail_sales/card.md
• Grain: utility_state_sector_annual
• Source basis: energy.eia.eia861
• Represented fact: EIA-861 reports annual retail electricity sold to ultimate customers — billed sales (MWh), revenue (thousand dollars), and customer counts — by utility, state, customer sector (residential/commercial/industrial/transportation/total), filing part, and service type, as a final annual census. Sales are billed energy over the year, not load: they never reconcile with EIA-930 hourly demand (atom-catalog Rule 1/2).

Does not answer:

• hourly or peak load — sales are billed MWh over a year, not load (EIA-930 is the demand atom)
• facility-level or data-center-specific load
• county-level anything — service territory carries county names only (deferred decision)
• average retail price (cents/kWh) — deferred by explicit ratified choice (prices x national is its own PD)
• net metering / distributed generation, demand response, reliability, meters — deferred family members
• the ~1,700 small short-form (EIA-861S) utilities — measured at build, 0 of 1,687 short-form respondents appear in this workbook (their sales live in Short_Form, a deferred slice)
• monthly freshness — the EIA-861M sample is a deferred fast-follow facet
• generator capacity, plant generation, wholesale prices, transmission
• reconciliation against EIA-930 demand or EIA-923 generation (atom-catalog Rule 2)

REST Surface

• GET /v1/health
• GET /v1/capabilities
• GET /v1/power/retail-sales/schema
• POST /v1/power/retail-sales/query
• POST /v1/evidence/source-row

MCP Surface

• list_capabilities_v1
• describe_power_retail_sales_v1
• query_power_retail_sales_v1
• get_source_evidence_v1

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:

• as_of
• data_year
• state
• sector
• part
• service_type
• ownership
• ba_code
• data_type
• eia_utility_id
• utility_name
• is_adjustment
• is_withheld
• included_in_default_us_metrics

Group by:

• data_year
• state
• sector
• part
• service_type
• ownership
• ba_code
• data_type
• eia_utility_id
• utility_name

Date range parameters:

Controls:

• include_records
• include_evidence
• limit
• order_by
• top_n
• order

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": [
      "sales_mwh",
      "revenue_thousand_dollars",
      "customers_count",
      "distinct_utility_count",
      "source_record_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:

• sales_mwh
• revenue_thousand_dollars
• customers_count
• distinct_utility_count
• source_record_count

Metric groups:

{
  "customers": [
    "customers_count"
  ],
  "entities": [
    "distinct_utility_count"
  ],
  "records": [
    "source_record_count"
  ],
  "revenue": [
    "revenue_thousand_dollars"
  ],
  "sales_mwh": [
    "sales_mwh"
  ]
}

Response summary fields:

• group_count
• totals

Accepted fact policy:

• Query responses contain accepted, gate-passed facts only.
• Gate, monitor, and audit quality signals are internal controls, not agent-facing answer caveats.
• If a source snapshot is not fit to serve, the source must fail closed before it reaches this API.

Metric metadata:

Rollup rules:

• summary.totals.<metric> is the authoritative total for the full matched query.
• Grouped row metrics may be summed only when additive_across_groups is true.
• Do not sum grouped values for these non-additive metrics: distinct_utility_count.

Detail record fields returned when include_records is true:

• source_id
• sheet_name
• source_record_key
• region_scope
• included_in_default_us_metrics
• is_adjustment
• is_withheld
• data_year
• source_row_number
• eia_utility_id
• utility_name
• part
• service_type
• data_type
• state
• ownership
• ba_code
• sector
• measure
• unit
• value
• as_of
• raw_file_sha256
• citation

Row-level citation fields:

• source_id
• source_url
• source_file
• sheet
• source_row
• source_col
• raw_file_sha256
• as_of

Aggregate citation fields:

• source_id
• publisher
• source_url
• source_file
• raw_file_sha256
• as_of
• source_rows_count
• source_rows_sample
• verify
• lineage_filter

Codebooks

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

Checked Examples

The checked schema output is capability-schema.json.

Agent Workflow

1. Call list_capabilities_v1 and select power.retail_sales.
2. Call describe_power_retail_sales_v1 to inspect valid filters, groupings, metrics, and citation fields.
3. Call query_power_retail_sales_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.