> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gdeltcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/entities/{entity_id}
openapi: 3.0.3
info:
  title: GDELT Cloud API v2
  version: 2.0.0
  description: >-
    Clean v2 REST API for generated GDELT Cloud structured Events, clustered
    Stories, linked Entities, summaries, admin1 discovery, significance ranking,
    and paginated article evidence.


    Event significance is a family-scoped weighted blend, renormalized so every
    event family spans a true 0-1: each event's raw total is divided by the
    maximum its own family can reach (Conflict 1.00, CAMEO+ POLITICAL 0.90,
    other CAMEO+ domains 0.65). All events: Goldstein severity 0.25, article
    evidence 0.05, confidence 0.05. Conflict only: fatalities 0.55 (log-scaled
    by body count) and civilian targeting 0.10. CAMEO+ only: magnitude 0.20,
    systemic importance 0.15, propagation potential 0.10, market sensitivity
    0.10. When magnitude is unmeasured its term AND its 0.20 weight are both
    dropped. The four CAMEO+ metrics are rubric scores produced by published
    formulas - ordinal ranking signals, not measurements, probabilities, or
    predicted price moves. goldstein_scale is one canonical public metric,
    populated for Conflict Events and CAMEO+ POLITICAL Events where meaningful.
    Story linked_event_count is a Story-to-Event link aggregate, not a distinct
    Event total.
servers:
  - url: https://gdeltcloud.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: Events
    description: Coded CAMEO+ / conflict events — search, fetch, and summarize.
  - name: Stories
    description: Clustered narratives (stories) and their articles.
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone.
  - name: Geography
    description: Admin-1 geography lookups.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets + World Port Index
      ports + Epoch AI data centers on one keyed surface, resolved to spine
      owners. Plan-gated (Analyst plan and up).
  - name: Screening and Reference
    description: >-
      Restricted-party lists, screening, and ownership-chain exposure.
      Plan-gated (`can_use_screening` / `can_use_exposure`).
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Plan-gated
      (`can_use_china`).
  - name: Media Intelligence
    description: >-
      Entity tone (`can_use_tone`) and Share of Voice (`can_use_share_of_voice`)
      are plan-gated. Social signal remains an admin-only preview.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and AI-extracted relations. Requires a
      plan with SEC filings access (`can_use_filings`) — the Corporate & Supply
      Chain plan and above.
  - name: Macro Finance
    description: >-
      FRED economic time series (catalog, point-in-time observations, releases).
      Plan-gated (`can_use_macro`).
  - name: Maritime
    description: >-
      AIS-derived vessel-flow signals across maritime chokepoints — chokepoint
      transits, last-known vessel positions, carriers, dwell, and AIS-dark gaps.
      Plan-gated (`can_use_maritime`).
  - name: Briefs
    description: Source-backed monitoring briefs.
paths:
  /api/v2/entities/{entity_id}:
    get:
      tags:
        - Entities
      summary: Get Entity
      description: >-
        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.
      operationId: get-entity-v2
      parameters:
        - name: entity_id
          in: path
          required: true
          description: >-
            Entity ID returned by Search Entities or an entity_refs array.
            Wikipedia URLs are valid IDs and must be URL-encoded.
          schema:
            type: string
        - $ref: '#/components/parameters/dateStart'
        - $ref: '#/components/parameters/dateEnd'
        - $ref: '#/components/parameters/limitDetail'
        - name: include_images
          in: query
          required: false
          description: Set false to skip best-effort Wikipedia thumbnail/avatar enrichment.
          schema:
            type: boolean
            default: true
        - name: include_tone
          in: query
          required: false
          description: >-
            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.
          schema:
            type: boolean
            default: false
        - name: include_registry
          in: query
          required: false
          description: >-
            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.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Entity detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/EntityCard'
              examples:
                entity:
                  value:
                    success: true
                    data:
                      id: https://en.wikipedia.org/wiki/United_Nations
                      url: >-
                        https://gdeltcloud.com/entity-geg/organization/United%20Nations
                      name: United Nations
                      type: organization
                      wikipedia_url: https://en.wikipedia.org/wiki/United_Nations
                      story_refs: []
                      event_refs: []
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl
            "https://gdeltcloud.com/api/v2/entities/https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FExample"
            \
              -H "Authorization: Bearer $GDELT_CLOUD_API_KEY"
components:
  parameters:
    dateStart:
      name: date_start
      in: query
      description: >-
        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.
      schema:
        type: string
        format: date
        example: '2026-04-11'
      example: '2026-04-11'
    dateEnd:
      name: date_end
      in: query
      description: >-
        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.
      schema:
        type: string
        format: date
        example: '2026-04-17'
      example: '2026-04-17'
    limitDetail:
      name: limit
      in: query
      description: Number of linked records to return.
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 10
        example: 10
      example: 10
  schemas:
    EntityCard:
      type: object
      description: >-
        One canonical Entity, deduplicated by Wikipedia URL across raw_name
        variants on the public list surface. Low-quality matches (disambiguation
        pages, common nouns, extraction artifacts) are filtered server-side.
        GDELT-derived per-article metrics (mention_count, avg_salience) are not
        part of the public contract — story_count, article_count, and
        event_count are the canonical activity signals. Entity detail can
        include cached Entity Tone metadata when include_tone=true; missing tone
        is reported as not_available, not neutral.
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
          nullable: true
        name:
          type: string
          description: >-
            Canonical display name — the most-mentioned raw_name variant
            pointing at this Wikipedia URL.
        type:
          type: string
          nullable: true
          enum:
            - person
            - organization
        wikipedia_url:
          type: string
          format: uri
          nullable: true
        latest_date:
          type: string
          format: date
          nullable: true
          description: >-
            Most recent date the Entity appeared in a Story or Event within the
            requested window.
        image_url:
          type: string
          format: uri
          nullable: true
          description: Best-effort Wikipedia thumbnail URL for UI rendering.
        avatar_url:
          type: string
          format: uri
          nullable: true
          description: Best-effort compact avatar URL, usually the same as image_url.
        wikipedia:
          type: object
          nullable: true
          description: >-
            Compact Wikipedia enrichment when available, including
            thumbnail_url, description, page_url, and summary on detail
            responses.
          additionalProperties: true
        metrics:
          type: object
          description: >-
            Aggregated activity counts over the requested window, summed across
            all raw_name variants that map to this Wikipedia URL.
          properties:
            article_count:
              type: integer
              description: >-
                Total articles in matched Stories and Events mentioning the
                entity.
            story_count:
              type: integer
              description: >-
                Distinct GDELT Cloud Stories (cluster_ids) the entity appeared
                in.
            event_count:
              type: integer
              description: Distinct coded Events (Conflict + CAMEO+) linked to the entity.
        story_refs:
          type: array
          items:
            type: object
        event_refs:
          type: array
          items:
            type: object
        entity_tone:
          type: object
          nullable: true
          description: >-
            Present on Entity detail when include_tone=true and the caller is
            allowed to access preview tone metadata. tone_status may be scored,
            reviewable, partial, or not_available.
          properties:
            tone_status:
              type: string
              enum:
                - scored
                - reviewable
                - partial
                - not_available
            coverage:
              type: object
              additionalProperties: true
            latest_series:
              type: array
              items:
                type: object
            by_language:
              type: array
              description: >-
                Per-language tone breakdown over ALL scored Stories in the
                window. Embedded on Entity detail (include_tone=true); on the
                tone endpoints it appears when the request passes
                group_by=language. Each item: language (ISO code), mean_tone,
                mean_risk, confidence, scored_story_count (scored Stories
                covered in that language), article_count (TOTAL articles in that
                language — real coverage volume, not the bounded evidence
                sample), and a daily series. Lets you compare how an entity is
                covered across languages (e.g. markedly more negative in one
                language than another). Mean tone is computed over every scored
                Story, not a sample.
              items:
                type: object
                properties:
                  language:
                    type: string
                  mean_tone:
                    type: number
                    nullable: true
                  mean_risk:
                    type: number
                    nullable: true
                  confidence:
                    type: number
                    nullable: true
                  scored_story_count:
                    type: integer
                  article_count:
                    type: integer
                  series:
                    type: array
                    items:
                      type: object
            analytics_url:
              type: string
              nullable: true
            methodology:
              type: object
              additionalProperties: true
        cooccurrences:
          type: array
          description: >-
            Co-occurring entities — people/organizations that appear in the same
            Stories as this entity within the window, ranked by shared-Story
            count. Returned on Entity detail. Each item: name, type
            (person|organization), wikipedia_url, story_count (shared Stories),
            source ('news'), url (entity page).
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                nullable: true
                enum:
                  - person
                  - organization
              wikipedia_url:
                type: string
                nullable: true
              story_count:
                type: integer
              source:
                type: string
              url:
                type: string
                nullable: true
        timeline:
          type: array
          description: >-
            Per-day activity for the entity over the window (Entity detail).
            Each item: date, article_count, mention_count.
          items:
            type: object
        source_mix:
          type: array
          description: >-
            Top news domains covering the entity over the window (Entity
            detail). Each item: domain, article_count, story_count.
          items:
            type: object
        map_pins:
          type: array
          description: >-
            Geo-located Events linked to the entity (Entity detail), for map
            rendering. Each item: event_uid, event_family, event_date, title,
            country, category, latitude, longitude.
          items:
            type: object
        sources:
          type: object
          nullable: true
          description: >-
            Per-source entitlement control-plane on Entity detail: for each data
            source (news, events, tone, gem, sec, sanctions, china, epoch_ai,
            facilities, gov, share_of_voice) whether the caller's plan is
            entitled, plus availability for entitled sources. Non-entitled
            sources report a uniform locked state and omit availability (no
            availability leak). The corresponding section objects (news, events,
            tone, sec, ...) appear at the top level only for entitled sources.
          additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        code:
          type: string
        details:
          type: object
          description: >-
            Recoverable validation context when available, such as param,
            invalid_value, accepted_values, nearest_values, and a corrected
            example.
          additionalProperties: true
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````