> ## 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 list entries

> Search restricted-party list ENTRIES (institution-only) — programmes, aliases, country, ids, with bitemporal as-of selection. Requires a plan with Restricted-party screening access (`can_use_screening`) — the Corporate & Supply Chain plan and above.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/lists/entries
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/lists/entries:
    get:
      tags:
        - Screening and Reference
      summary: Search list entries
      description: >-
        Search restricted-party list ENTRIES (institution-only) — programmes,
        aliases, country, ids, with bitemporal as-of selection. Requires a plan
        with Restricted-party screening access (`can_use_screening`) — the
        Corporate & Supply Chain plan and above.
      operationId: lists-entries-v2
      parameters:
        - name: source
          in: query
          required: false
          schema:
            type: string
          description: Restrict to one source_key.
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Name search.
        - name: country
          in: query
          required: false
          schema:
            type: string
          description: >-
            Country filter on list entries. Accepts a country name, ISO-2, or
            ISO-3 via the shared `resolveCountryInput` layer (matched against
            the entry's `country_iso3`); an unresolvable value returns `400
            INVALID_COUNTRY`.
        - name: program
          in: query
          required: false
          schema:
            type: string
          description: Sanctions programme filter.
        - name: entity_id
          in: query
          required: false
          schema:
            type: string
          description: Entries resolved to this entity_id.
        - name: active_on
          in: query
          required: false
          schema:
            type: string
          description: As-of date (YYYY-MM-DD) for bitemporal selection.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 25
          description: Rows per page.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor (opaque offset).
        - name: sort
          in: query
          required: false
          description: Sort order for list entries.
          schema:
            type: string
            enum:
              - name
              - recent
            default: name
      responses:
        '200':
          description: Search list entries.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        entry_uid:
                          type: string
                        source_key:
                          type: string
                        name:
                          type: string
                        aliases:
                          type: array
                          items:
                            type: string
                        entity_kind:
                          type: string
                        country_iso3:
                          type: string
                        programs:
                          type: array
                          items:
                            type: string
                        legal_basis:
                          type: string
                        source_url:
                          type: string
                        ids:
                          type: object
                          properties:
                            csl_id:
                              type: string
                            lei:
                              type: string
                        first_seen_date:
                          type: string
                        last_seen_date:
                          type: string
                        active:
                          type: boolean
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor: {}
                      next_cursor: {}
                  sort:
                    type: string
                  applied_filters:
                    type: object
                    properties:
                      country:
                        type: string
                      q:
                        type: string
              examples:
                example:
                  summary: GET /api/v2/lists/entries — example response
                  value:
                    success: true
                    data:
                      - entry_uid: '26156'
                        source_key: csl_bis_entity
                        name: Huawei Technologies Co., Ltd.
                        aliases:
                          - Huawei Technologies
                          - 华为技术有限公司
                          - Huawei
                        entity_kind: entity
                        country_iso3: CHN
                        programs:
                          - EAR Entity List
                        legal_basis: Supplement No. 4 to 15 CFR Part 744
                        source_url: >-
                          https://www.bis.doc.gov/index.php/policy-guidance/lists-of-parties-of-concern/entity-list
                        ids:
                          csl_id: '26156'
                          lei: 529900PH9YTJ9N5BH261
                        first_seen_date: '2019-05-16'
                        last_seen_date: '2026-06-29'
                        active: true
                      - entry_uid: 1260h-2026-041
                        source_key: dod_1260h
                        name: Hikvision Digital Technology Co., Ltd.
                        aliases:
                          - Hangzhou Hikvision Digital Technology
                          - 杭州海康威视数字技术股份有限公司
                          - Hikvision
                        entity_kind: entity
                        country_iso3: CHN
                        programs:
                          - Section 1260H
                        legal_basis: Section 1260H, NDAA FY2021
                        source_url: https://www.defense.gov/News/Releases/
                        ids:
                          ticker: 002415.SZ
                        first_seen_date: '2022-10-05'
                        last_seen_date: '2026-06-29'
                        active: true
                    pagination:
                      limit: 25
                      cursor: null
                      next_cursor: null
                    sort: name
                    applied_filters:
                      country: CHN
                      q: huawei
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Plan required (PLAN_REQUIRED) — the caller's plan does not carry the
            required source entitlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    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
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````