v1

latestOpenAPI 3.0.32026-07-226744340.8 KB
Screening and Reference

Ownership-chain exposure

Precomputed ownership-chain exposure across three lenses (sanctions / china / state_owned) over energy assets (risk-per-MW) or entities, with contributing lists and ownership paths. Requires a plan with Ownership-chain exposure access (can_use_exposure) — the Corporate & Supply Chain plan and above.

get/api/v2/exposure

Query parameters

lens'sanctions' | 'china' | 'state_owned'

sanctions | china | state_owned.

subject'assets' | 'entities'

Exposure subject: assets (risk-per-MW over energy assets, the default) or entities. Auto-selects entities when you pass an entity handle (entity_id, entity, entity_search, counterparty, or q) without an explicit subject and without an asset selector (gem_id/tracker) — so ?entity_id=e_... just works. Pass subject=assets explicitly to force the asset lens; the response surfaces a subject_note when it auto-switches.

countrystring
Example:Indonesia

Country filter(s), comma-separated. Accepts a country name (Indonesia), ISO-2 (ID), or ISO-3 (IDN) via the shared resolveCountryInput layer (combinable with region/continent); an unresolvable value returns 400 INVALID_COUNTRY.

trackerstring

Energy-asset tracker (assets subject). All trackers: Taxonomy & Codes — Energy.

sourcestring

Restrict to a contributing list source_key.

entity_idstring

Filter to one entity_id.

entitystring

Alias of entity_id. Must be a RESOLVED entity id (e_…, wiki:…, or llm:…) — a bare name returns 400 INVALID_ENTITY_ID telling you to resolve it via /api/v2/search (or use counterparty for a fuzzy name match). On subject=assets it filters assets whose contributing owners include the id; on subject=entities it selects that entity's own exposure row.

counterpartystring

Resolve a counterparty by name and filter to it.

min_stake_pctnumber

Minimum ownership stake, in percent (0–100), for an asset row to be returned (exposure_stake_pct >= min_stake_pct). Applies to subject=assets only; out-of-range or non-numeric values return 400 INVALID_NUMBER.

direct_onlyboolean

Only direct (non-via-parent) exposure.

group_by'none' | 'country' | 'tracker'

assets grouping: none | country | tracker.

sort'capacity_desc' | 'stake_desc'

capacity_desc | stake_desc.

limitinteger

Rows per page.

cursorstring

Pagination cursor (opaque offset).

Response

Ownership-chain exposure.

successboolean
lensstring
subjectstring
sortstring