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

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

Aliases

Both spellings are accepted and mean exactly the same thing. The canonical name is what appears in applied_filters, whichever you sent.

Deliberately rejected parameters

These return 400 rather than being silently ignored. A filter that looks accepted and does nothing is worse than one that fails loudly — it produces a confident, wrong answer.

Deprecated parameters

Still accepted, still returning the same rows — and no longer the way to express the filter. A code string we published is a contract, so these are added-and-superseded rather than renamed; nothing you have built will break. New code should use the replacement. These are the only place a deprecated parameter is listed: it no longer appears in the per-endpoint tables above, in the OpenAPI spec, or in the MCP tool schemas, so a new integration cannot pick one up by accident. See API stability for the notice period that applies before any of them stops working.

Per-endpoint parameters

GET /api/v2/activity

12 accepted parameters — 10 core, 2 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

15 accepted parameters.

GET /api/v2/countries/{iso3}

5 accepted parameters.

GET /api/v2/events

52 accepted parameters — 24 core, 28 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 — 25 core, 10 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

44 accepted parameters — 19 core, 25 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

28 accepted parameters — 20 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/facilities

19 accepted parameters.

GET /api/v2/facilities/{facility_id}

Takes no query parameters.

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

Takes no query parameters.

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

5 accepted parameters.

GET /api/v2/intelligence/gpr

15 accepted parameters.

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

17 accepted parameters.

GET /api/v2/share-of-voice

19 accepted parameters.

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

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

12 accepted parameters.

GET /api/v2/situations

15 accepted parameters.

GET /api/v2/situations/{story_id}

7 accepted parameters.

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

6 accepted parameters.

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

5 accepted parameters.

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

5 accepted parameters.

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

5 accepted parameters.

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/entities

23 accepted parameters — 18 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/entities/{entity_id}/dossier

2 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

2 accepted parameters.

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

Takes no query parameters.

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/briefs/{id}

Takes no query parameters.

GET /api/v2/briefs

Takes no query parameters.

POST /api/v2/briefs

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

GET /api/v2/bulk/files/{file_id}/url

Takes no query parameters.

GET /api/v2/bulk/files

Takes no query parameters.

GET /api/v2/china/projects

Takes no query parameters.

GET /api/v2/china/projects/summary

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/energy/assets/map

Takes no query parameters.

GET /api/v2/energy/assets

Takes no query parameters.

GET /api/v2/energy/assets/summary

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/energy/owners

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/entities/{entity_id}

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/entity-tone

Takes no query parameters.

GET /api/v2/entity-tone/runs/{run_id}

Takes no query parameters.

GET /api/v2/entity-tone/runs

Takes no query parameters.

POST /api/v2/entity-tone/runs

Takes no query parameters.

GET /api/v2/epoch/{...unknown}

Takes no query parameters.

POST /api/v2/epoch/{...unknown}

Takes no query parameters.

PUT /api/v2/epoch/{...unknown}

Takes no query parameters.

PATCH /api/v2/epoch/{...unknown}

Takes no query parameters.

DELETE /api/v2/epoch/{...unknown}

Takes no query parameters.

GET /api/v2/epoch/chip-sales

Takes no query parameters.

GET /api/v2/epoch/companies

Takes no query parameters.

GET /api/v2/epoch/data-centers

Takes no query parameters.

GET /api/v2/epoch/hardware

Takes no query parameters.

GET /api/v2/epoch/models

Takes no query parameters.

GET /api/v2/events/{event_id}

Takes no query parameters.

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

Takes no query parameters.

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

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/filings/{cik}

Takes no query parameters.

GET /api/v2/filings/events

Takes no query parameters.

GET /api/v2/filings

Takes no query parameters.

GET /api/v2/filings/summary

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/gleif/entities

Takes no query parameters.

GET /api/v2/gleif/isin

Takes no query parameters.

GET /api/v2/gleif/relationships

Takes no query parameters.

GET /api/v2/gov/awards

Takes no query parameters.

GET /api/v2/gov/enforcement

Takes no query parameters.

GET /api/v2/gov/fara

Takes no query parameters.

GET /api/v2/macro/observations

Takes no query parameters.

GET /api/v2/macro/releases

Takes no query parameters.

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

Takes no query parameters.

GET /api/v2/macro/series

Takes no query parameters.

GET /api/v2/maritime/activity

Takes no query parameters.

GET /api/v2/maritime/carriers/{imo}

Takes no query parameters.

GET /api/v2/maritime/chokepoint-watch

Takes no query parameters.

GET /api/v2/maritime/density

Takes no query parameters.

GET /api/v2/maritime/dwell

Takes no query parameters.

GET /api/v2/maritime/gaps

Takes no query parameters.

GET /api/v2/maritime/port-pulse

Takes no query parameters.

GET /api/v2/maritime/ports

Takes no query parameters.

GET /api/v2/maritime/tracks

Takes no query parameters.

GET /api/v2/maritime/transits

Takes no query parameters.

GET /api/v2/maritime/vessels/{imo}/track

Takes no query parameters.

GET /api/v2/maritime/vessels

Takes no query parameters.

GET /api/v2/markets

Takes no query parameters.

GET /api/v2/social

Takes no query parameters.

GET /api/v2/stories/{story_id}

Takes no query parameters.

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 15 endpoints.

entity_id

On 8 endpoints. On 3 endpoints.

facility_id

On 3 endpoints.

gem_id

On 2 endpoints.

imo

On 2 endpoints.

isin

On 1 endpoint.

lei

On 4 endpoints.

near_gem_id

On 6 endpoints.

owner_entity_id

On 3 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.