v1

latestOpenAPI 3.0.32026-07-226744340.8 KB

Entities

Get Entity

Fetch one Entity profile with linked Stories and Events. Admin/internal callers can set include_tone=true to join cached Entity Tone coverage; when no tone score exists, the response returns tone_status=not_available rather than hiding the entity or treating missing tone as neutral.

get/api/v2/entities/{entity_id}

Path parameters

entity_idstring required

Entity ID returned by Search Entities or an entity_refs array. Wikipedia URLs are valid IDs and must be URL-encoded.

Query parameters

date_startstring date

Example:2026-04-11

Inclusive start date in YYYY-MM-DD, matched against the event or story date. Alias start_date is accepted for compatibility. Omit dates for the default recent window; explicit windows may not exceed 30 days.

date_endstring date

Example:2026-04-17

Inclusive end date in YYYY-MM-DD, matched against the event or story date. Alias end_date is accepted for compatibility. Omit dates for the default recent window; explicit windows may not exceed 30 days.

limitinteger

Example:10

Number of linked records to return.

include_imagesboolean

Set false to skip best-effort Wikipedia thumbnail/avatar enrichment.

include_toneboolean

Admin/internal preview: include cached Entity Tone coverage when available. Missing tone returns entity_tone.tone_status = not_available and should not be interpreted as neutral.

include_registryboolean

Overlay the canonical registry sections (SEC filings / energy / screening / China) on the entity profile. Plan-gated (no admin bypass): requires a plan carrying registry access (can_use_filings, can_use_screening, can_use_china, or can_use_exposure), otherwise returns 403 PLAN_REQUIRED. Legacy bundled flag — prefer the per-source sources map, where each section is gated by its own plan flag.

Response

Entity detail

successtrue