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

# Search Entities

> Discover linked people and organizations that connect to Stories and Events. Entity taxonomy filters operate on linked Story/Event evidence.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/entities
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:
    get:
      tags:
        - Entities
      summary: Search Entities
      description: >-
        Discover linked people and organizations that connect to Stories and
        Events. Entity taxonomy filters operate on linked Story/Event evidence.
      operationId: search-entities-v2
      parameters:
        - name: search
          in: query
          description: >-
            Entity name or phrase to search for. Aliases `q`, `query`,
            `keyword`, and `name` are accepted (first non-empty wins); for
            high-recall cross-source discovery see `GET /api/v2/search`.
            Resolved filters are echoed in the response `applied_filters` block,
            with unrecognized params under `applied_filters.ignored`.
          schema:
            type: string
        - name: type
          in: query
          description: >-
            Optional entity type filter. `place` covers geographies (countries,
            cities, regions), typed from Wikidata P31 — before 2026-07-30 these
            were mis-filed under organization and person, so type=organization
            returned countries. Roles and offices are deliberately none of these
            three and are excluded rather than mislabelled.
          schema:
            type: string
            enum:
              - person
              - organization
              - place
        - $ref: '#/components/parameters/dateStart'
        - $ref: '#/components/parameters/dateEnd'
        - $ref: '#/components/parameters/eventFamily'
        - $ref: '#/components/parameters/category'
        - $ref: '#/components/parameters/subcategory'
        - $ref: '#/components/parameters/domain'
        - $ref: '#/components/parameters/hasFatalities'
        - $ref: '#/components/parameters/civilianTargeting'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: Entity cards
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponse'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/EntityCard'
              examples:
                entities:
                  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: []
                    pagination:
                      limit: 25
                      cursor: null
                      next_cursor: eyJvZmZzZXQiOjI1fQ==
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl "https://gdeltcloud.com/api/v2/entities" \
              -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'
    eventFamily:
      name: event_family
      in: query
      deprecated: true
      description: >-
        Deprecated legacy filter. Prefer `category`, which implies Conflict vs
        CAMEO+. Still accepted for backwards compatibility.
      schema:
        $ref: '#/components/schemas/EventFamily'
    category:
      name: category
      in: query
      description: >-
        Stable linked Event product category. Use a Conflict event type such as
        `Battles`, `Protests`, or `Explosions/Remote violence`, or one CAMEO+
        domain such as `POLITICAL`, `INFRASTRUCTURE`, or `CRIME`; values may be
        single or comma-separated. On Story endpoints this filters linked Event
        evidence. Use `story_category` only for legacy Story-cluster categories
        such as `conflict_security`. Full list: [Taxonomy &
        Codes](/api-reference/taxonomy).
      schema:
        type: string
        example: Battles
      example: Battles
    subcategory:
      name: subcategory
      in: query
      description: >-
        More specific linked Event subtype, CAMEO+ event description, or CAMEO+
        code. Requires parent `category` and must belong to at least one
        selected category. For Conflict categories, use sub-event types such as
        `Armed clash`, `Peaceful protest`, or `Air/drone strike`. Validation
        errors include accepted_values, nearest_values when practical, and a
        corrected example. Full list: [Taxonomy &
        Codes](/api-reference/taxonomy).
      schema:
        type: string
        example: Armed clash
      example: Armed clash
    domain:
      name: domain
      in: query
      description: >-
        Deprecated legacy CAMEO+ domain enum. Prefer `category`/`categories` for
        new integrations; retained for backwards compatibility. Full list:
        [Taxonomy & Codes](/api-reference/taxonomy).
      schema:
        $ref: '#/components/schemas/Domain'
      deprecated: true
    hasFatalities:
      name: has_fatalities
      in: query
      description: >-
        Set `true` for fatality monitoring. v2 intentionally exposes only this
        boolean fatality filter.
      schema:
        type: boolean
        example: true
      example: true
    civilianTargeting:
      name: civilian_targeting
      in: query
      description: >-
        Filter Conflict-linked evidence by ACLED civilian_targeting. `true`
        keeps records where civilians are the primary target; `false` excludes
        those records.
      schema:
        type: boolean
    sort:
      name: sort
      in: query
      description: >-
        `significance` is the default analyst ranking. Use `recent` when
        freshness matters more than importance.
      schema:
        $ref: '#/components/schemas/Sort'
        example: significance
      example: significance
    limit:
      name: limit
      in: query
      description: Number of records to return.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
        example: 25
      example: 25
    cursor:
      name: cursor
      in: query
      description: Pagination cursor from `pagination.next_cursor`.
      schema:
        type: string
  schemas:
    PaginatedResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        pagination:
          $ref: '#/components/schemas/Pagination'
    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
    EventFamily:
      type: string
      enum:
        - conflict
        - cameoplus
    Domain:
      type: string
      enum:
        - POLITICAL
        - ECONOMIC
        - CORPORATE
        - TECHNOLOGY
        - INFRASTRUCTURE
        - HEALTH
        - DEMOGRAPHIC
        - INFORMATION
        - ENVIRONMENT
        - CRIME
    Sort:
      type: string
      enum:
        - significance
        - recent
      default: significance
    Pagination:
      type: object
      properties:
        limit:
          type: integer
        cursor:
          type: string
          nullable: true
        next_cursor:
          type: string
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````