Skip to main content
The per-endpoint tables below cover the endpoints whose parameters are governed by the contract registry — the descriptors the server imports at request time, so a parameter listed there is one the server actually parses and a parameter absent from it is one that endpoint ignores. The remaining operations publish their parameters in the API reference; the identifier section below is derived from the whole published surface.

Shared parameters

81 parameter names appear on more than one endpoint. When bounds or defaults differ, use the per-endpoint tables below.

Older names

The API still accepts older spellings of some parameters. Older parameter names lists each one with the name to send instead.

Per-endpoint parameters

GET /api/v2/saved-queries

Takes no query parameters.

POST /api/v2/saved-queries

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

GET /api/v2/saved-queries/{id}

Takes no query parameters.

PATCH /api/v2/saved-queries/{id}

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

DELETE /api/v2/saved-queries/{id}

Takes no query parameters.

GET /api/v2/facility-examples/{slug}

Takes no query parameters.

GET /api/v2/resources/statistics

15 accepted parameters.

GET /api/v2/facilities/{facility_id}/relationships

4 accepted parameters.

GET /api/v2/facilities/{facility_id}/observations

5 accepted parameters.

GET /api/v2/activity

15 accepted parameters — 7 core, 8 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/countries

17 accepted parameters — 11 core, 6 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/countries/{iso3}

5 accepted parameters.

GET /api/v2/events

52 accepted parameters — 12 core, 40 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/stories

35 accepted parameters — 11 core, 24 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/events/summary

47 accepted parameters — 11 core, 36 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/stories/summary

31 accepted parameters — 10 core, 21 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/facilities

26 accepted parameters — 7 core, 19 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/facilities/{facility_id}

Takes no query parameters.

GET /api/v2/facilities/{facility_id}/context

6 accepted parameters.

GET /api/v2/intelligence/gpr

13 accepted parameters — 7 core, 6 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/intelligence/posture

8 accepted parameters.

GET /api/v2/intelligence/coverage

4 accepted parameters.

GET /api/v2/filings/resolve

5 accepted parameters.

GET /api/v2/screening/match

8 accepted parameters.

GET /api/v2/exposure

16 accepted parameters.

GET /api/v2/share-of-voice

16 accepted parameters — 7 core, 9 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/stories/{story_id}/articles

8 accepted parameters.

GET /api/v2/filings/relations

10 accepted parameters.

GET /api/v2/lists

4 accepted parameters.

GET /api/v2/lists/entries

14 accepted parameters.

GET /api/v2/lists/changes

9 accepted parameters.

GET /api/v2/meta/enums

Takes no query parameters.

GET /api/v2/meta/endpoints

1 accepted parameter.

GET /api/v2/meta/query-units

Takes no query parameters.

GET /api/v2/search

13 accepted parameters — 6 core, 7 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations

16 accepted parameters — 10 core, 6 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations/{story_id}

9 accepted parameters — 2 core, 7 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations/{story_id}/entities

8 accepted parameters — 3 core, 5 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations/{story_id}/stories

8 accepted parameters — 2 core, 6 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations/{story_id}/events

8 accepted parameters — 2 core, 6 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/situations/{story_id}/connections

7 accepted parameters — 2 core, 5 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

POST /api/v2/situations

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

GET /api/v2/situations/{story_id}/brief

3 accepted parameters.

GET /api/v2/situations/{story_id}/editions

2 accepted parameters.

GET /api/v2/entities

24 accepted parameters — 11 core, 13 advanced. Advanced. Fully supported and applied exactly like the parameters above. They are separated because they answer specialist questions — a second time axis, directional actor geography, family-scoped metric bounds, and resolution modifiers whose defaults are what most callers want.

GET /api/v2/entities/{entity_id}/dossier

2 accepted parameters.

GET /api/v2/entities/{entity_id}/interactions

5 accepted parameters.

GET /api/v2/offices

11 accepted parameters.

GET /api/v2/offices/{office_id}

1 accepted parameter.

GET /api/v2/offices/{office_id}/holders

4 accepted parameters.

GET /api/v2/entities/{entity_id}/offices

3 accepted parameters.

GET /api/v2/geo/admin1

5 accepted parameters.

GET /api/v2/monitors

Takes no query parameters.

POST /api/v2/monitors

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

GET /api/v2/monitors/{id}

Takes no query parameters.

PATCH /api/v2/monitors/{id}

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

DELETE /api/v2/monitors/{id}

Takes no query parameters.

POST /api/v2/monitors/preview

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

POST /api/v2/monitors/demo-webhook

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

POST /api/v2/monitors/batch

Takes no query parameters. See the linked operation schema in the API reference for its JSON request body.

GET /api/v2/monitors/{id}/runs

3 accepted parameters.

GET /api/v2/monitors/{id}/runs/{runId}

1 accepted parameter.

GET /api/v2/monitors/{id}/runs/{runId}/matches

2 accepted parameters.

GET /api/v2/monitors/{id}/runs/{runId}/matches.csv

Takes no query parameters.

POST /api/v2/monitors/{id}/run-now

Takes no query parameters.

POST /api/v2/monitors/{id}/test-delivery

Takes no query parameters.

GET /api/v2/energy/assets/{tracker}/{gem_id}

Its parameters are listed on its API reference page.

GET /api/v2/energy/assets

Its parameters are listed on its API reference page.

GET /api/v2/energy/assets/summary

Its parameters are listed on its API reference page.

GET /api/v2/energy/owners/{entity_id}

Its parameters are listed on its API reference page.

GET /api/v2/energy/owners

Its parameters are listed on its API reference page.

GET /api/v2/entities/{entity_id}/hierarchy

Its parameters are listed on its API reference page.

GET /api/v2/entities/{entity_id}

Its parameters are listed on its API reference page.

GET /api/v2/entity-tone

Its parameters are listed on its API reference page.

GET /api/v2/events/{event_id}

Its parameters are listed on its API reference page.

GET /api/v2/events/{event_id}/stories

Its parameters are listed on its API reference page.

GET /api/v2/filings/{cik}/facts

Its parameters are listed on its API reference page.

GET /api/v2/filings/{cik}/relations

Its parameters are listed on its API reference page.

GET /api/v2/filings/{cik}

Its parameters are listed on its API reference page.

GET /api/v2/filings/events

Its parameters are listed on its API reference page.

GET /api/v2/filings

Its parameters are listed on its API reference page.

GET /api/v2/filings/summary

Its parameters are listed on its API reference page.

GET /api/v2/gleif/entities/{lei}

Its parameters are listed on its API reference page.

GET /api/v2/gleif/entities

Its parameters are listed on its API reference page.

GET /api/v2/gleif/isin

Its parameters are listed on its API reference page.

GET /api/v2/gleif/relationships

Its parameters are listed on its API reference page.

GET /api/v2/gov/awards

Its parameters are listed on its API reference page.

GET /api/v2/gov/fara

Its parameters are listed on its API reference page.

GET /api/v2/macro/observations

Its parameters are listed on its API reference page.

GET /api/v2/macro/releases

Its parameters are listed on its API reference page.

GET /api/v2/macro/series/{series_id}

Its parameters are listed on its API reference page.

GET /api/v2/macro/series

Its parameters are listed on its API reference page.

GET /api/v2/maritime/chokepoint-watch

Its parameters are listed on its API reference page.

GET /api/v2/maritime/dwell

Its parameters are listed on its API reference page.

GET /api/v2/maritime/gaps

Its parameters are listed on its API reference page.

GET /api/v2/maritime/port-pulse

Its parameters are listed on its API reference page.

GET /api/v2/maritime/ports

Its parameters are listed on its API reference page.

GET /api/v2/maritime/transits

Its parameters are listed on its API reference page.

GET /api/v2/maritime/vessels

Its parameters are listed on its API reference page.

GET /api/v2/stories/{story_id}

Its parameters are listed on its API reference page.

Identifier parameters

Identifiers are keys with a format, not vocabularies — resolve one with GET /api/v2/search rather than constructing it. Several identifier spaces coexist, and the set an endpoint accepts differs by endpoint. Passing an id from the wrong space generally returns an empty 200 rather than a 400, so read the row for the endpoint you are about to call before you chain it to another one. This table is generated from the published spec and prints each parameter’s own description, unsummarised, so a difference between two endpoints is visible rather than averaged away.

cik

On 6 endpoints.

entity

On 18 endpoints.

entity_id

On 7 endpoints. On 1 endpoint.

facility_id

On 4 endpoints.

gem_id

On 2 endpoints.

isin

On 1 endpoint.

lei

On 4 endpoints.

near_gem_id

On 3 endpoints.

owner_entity_id

On 2 endpoints. On 3 endpoints.

ticker

On 1 endpoint.

uei

On 1 endpoint.

Unknown parameters never become silent filters

Descriptor-backed endpoints reject an undeclared query parameter with 400 UNKNOWN_PARAM; details.did_you_mean and details.accepted_params make typos actionable. Endpoints still being migrated to that contract may return a successful response and place the parameter under applied_filters.ignored. On any successful response, treat a non-empty ignored object as a client error: those parameters did not affect the rows.