Renamed
| Older name | Send instead | Endpoints |
|---|---|---|
categories | category | /api/v2/entities, /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
counterparty | entity_search | /api/v2/exposure |
country_iso3 | country | /api/v2/entities, /api/v2/events, /api/v2/events/summary, /api/v2/filings/relations, /api/v2/lists/entries, /api/v2/offices, /api/v2/stories, /api/v2/stories/summary |
date_from | date_start | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
date_to | date_end | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
decompose | component | /api/v2/intelligence/gpr |
end | date_end | /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
end_date | date_end | /api/v2/entities, /api/v2/entities/{entity_id}/interactions, /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/facilities/{facility_id}/context, /api/v2/geo/admin1, /api/v2/lists/changes, /api/v2/share-of-voice, /api/v2/stories, /api/v2/stories/summary, /api/v2/stories/{story_id}/articles |
end_datetime | date_end | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
enddatetime | date_end | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
entities | entity | /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/share-of-voice, /api/v2/stories, /api/v2/stories/summary |
entity_id | entity | /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/exposure, /api/v2/filings, /api/v2/filings/events, /api/v2/filings/relations, /api/v2/lists/entries, /api/v2/share-of-voice, /api/v2/stories, /api/v2/stories/summary |
entity_query | entity | /api/v2/entity-tone, /api/v2/share-of-voice |
entity_search | entity | /api/v2/entity-tone, /api/v2/share-of-voice |
entity_terms | entity | /api/v2/entity-tone, /api/v2/share-of-voice |
entity_type | type | /api/v2/entities |
event_type | category | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
from_date | date_start | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
geo | country | /api/v2/macro/series |
id | geo | /api/v2/intelligence/gpr, /api/v2/intelligence/posture |
keyword | q | /api/v2/entities |
keyword | search | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
knowledge_date | as_of | /api/v2/entities/{entity_id}/dossier |
language | languages | /api/v2/entities, /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary, /api/v2/stories/{story_id}/articles |
lens | variant | /api/v2/intelligence/gpr |
max_records | limit | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
maxrecords | limit | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
name | q | /api/v2/entities, /api/v2/filings/resolve, /api/v2/screening/match |
name | search | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
numerator | entity | /api/v2/entity-tone, /api/v2/share-of-voice |
offset | cursor | /api/v2/entities, /api/v2/events, /api/v2/facilities, /api/v2/facilities/{facility_id}/observations, /api/v2/facilities/{facility_id}/relationships, /api/v2/filings/relations, /api/v2/offices, /api/v2/offices/{office_id}/holders, /api/v2/resources/statistics, /api/v2/stories |
org | organization | /api/v2/offices |
organization_entity_id | organization | /api/v2/offices |
owner | entity | /api/v2/facilities |
owner_entity_id | entity | /api/v2/facilities |
publisher_country | publisher_country_iso3 | /api/v2/stories/{story_id}/articles |
q | entity_search | /api/v2/exposure |
q | search | Every endpoint that takes search |
query | q | /api/v2/entities |
query | search | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
realtime_start | as_of | /api/v2/entities/{entity_id}/dossier, /api/v2/intelligence/gpr |
search | q | /api/v2/energy/owners, /api/v2/entities, /api/v2/facilities, /api/v2/filings/resolve, /api/v2/lists/entries, /api/v2/offices |
source | list | Every endpoint that takes list |
start | date_start | /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
start_date | date_start | /api/v2/entities, /api/v2/entities/{entity_id}/interactions, /api/v2/entity-tone, /api/v2/events, /api/v2/events/summary, /api/v2/facilities/{facility_id}/context, /api/v2/geo/admin1, /api/v2/lists/changes, /api/v2/share-of-voice, /api/v2/stories, /api/v2/stories/summary, /api/v2/stories/{story_id}/articles |
start_datetime | date_start | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
startdatetime | date_start | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
threshold | min_match_confidence | /api/v2/screening/match |
timespan | days | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
to_date | date_end | /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
topic | branch | /api/v2/offices |
vintage | as_of | /api/v2/entities/{entity_id}/dossier, /api/v2/intelligence/gpr |
window | days | Every endpoint that takes days |
Replaced
| Older parameter | Send instead | Since | Endpoints |
|---|---|---|---|
domain | category | 2026-05 | /api/v2/entities, /api/v2/events, /api/v2/events/summary, /api/v2/stories, /api/v2/stories/summary |
event_family | category | 2026-05 | /api/v2/entities, /api/v2/events, /api/v2/events/summary, /api/v2/stories |
No longer applied
Accepted, and they change nothing. Send the replacement where there is one; otherwise remove the parameter.| Parameter | Send instead | Since | Endpoints |
|---|---|---|---|
canonical_cluster_date_end | — | 2026-08-15 | Every endpoint |
canonical_cluster_date_start | — | 2026-08-15 | Every endpoint |
confidence_profile | — | 2026-08-15 | Every endpoint |
date_end | — | 2026-09-07 | /api/v2/intelligence/posture |
date_start | — | 2026-09-07 | /api/v2/intelligence/posture |
goldstein_max | goldstein_scale_max | 2026-08-15 | Every endpoint |
goldstein_min | goldstein_scale_min | 2026-08-15 | Every endpoint |
goldstein_severity_max | — | 2026-08-15 | Every endpoint |
goldstein_severity_min | — | 2026-08-15 | Every endpoint |
lat | — | 2026-09-02 | /api/v2/stories, /api/v2/stories/summary |
limit | — | 2026-09-07 | /api/v2/intelligence/posture |
lng | — | 2026-09-02 | /api/v2/stories, /api/v2/stories/summary |
lon | — | 2026-09-02 | /api/v2/stories, /api/v2/stories/summary |
max_confidence | confidence_max | 2026-08-15 | Every endpoint |
max_geo_precision | geo_precision_max | 2026-08-15 | Every endpoint |
max_goldstein | goldstein_scale_max | 2026-08-15 | Every endpoint |
max_goldstein_scale | goldstein_scale_max | 2026-08-15 | Every endpoint |
max_goldstein_severity | — | 2026-08-15 | Every endpoint |
max_magnitude | magnitude_max | 2026-08-15 | Every endpoint |
max_market_sensitivity | market_sensitivity_max | 2026-08-15 | Every endpoint |
max_propagation_potential | propagation_potential_max | 2026-08-15 | Every endpoint |
max_significance | significance_max | 2026-08-15 | Every endpoint |
max_systemic_importance | systemic_importance_max | 2026-08-15 | Every endpoint |
min_confidence | confidence_min | 2026-08-15 | Every endpoint |
min_geo_precision | geo_precision_min | 2026-08-15 | Every endpoint |
min_goldstein | goldstein_scale_min | 2026-08-15 | Every endpoint |
min_goldstein_scale | goldstein_scale_min | 2026-08-15 | Every endpoint |
min_goldstein_severity | — | 2026-08-15 | Every endpoint |
min_magnitude | magnitude_min | 2026-08-15 | Every endpoint |
min_market_sensitivity | market_sensitivity_min | 2026-08-15 | Every endpoint |
min_propagation_potential | propagation_potential_min | 2026-08-15 | Every endpoint |
min_significance | significance_min | 2026-08-15 | Every endpoint |
min_systemic_importance | systemic_importance_min | 2026-08-15 | Every endpoint |
near | — | 2026-09-02 | /api/v2/stories, /api/v2/stories/summary |
radius_km | — | 2026-09-02 | /api/v2/stories, /api/v2/stories/summary |
Older list keys
Somelist keys have newer replacements. GET /api/v2/lists names each key’s replacement in superseded_by. Once the replacement is available, a request that sends the older key is answered from it and applied_filters.deprecations[] names both keys. A replacement can be a consolidated list that is wider than the older key; narrow it with program on /api/v2/lists/entries.
