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

# Corporate hierarchy for a resolved entity

> An entity's corporate hierarchy resolved through our spine: `direct_parent`, `ultimate_parent`, `children` and `child_count`. Accepts the same identifiers as the rest of the API — a name, an `e_` id, a `wiki:` id or a wikipedia_url — and additionally a bare 20-character LEI, so the identifier you searched with works at this hop too.

**Read the `coverage` block before the hierarchy.** `lei_present: false` means the entity carries no LEI in our crosswalk — a coverage gap, NOT evidence the entity has no parent. `reporting_exception` carries the reason a filer gave for not naming a parent (for example NO_KNOWN_PERSON), which is a DECLARED absence and materially different from an unknown one. `child_count` is null, never 0, when the requested direction excluded children.

Corporate hierarchy as reported to the Global LEI System: accounting consolidation under IFRS/US-GAAP, not percentage ownership and not beneficial ownership. Natural persons are out of scope, and reporting is partial — an absent parent usually means the filer declared a reporting exception rather than that none exists.

Gated on the existing `can_use_exposure` entitlement; the LEI itself is ungated. Point-in-time (`as_of`) is not supported for this source.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/entities/{entity_id}/hierarchy
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}/hierarchy:
    get:
      tags:
        - Entities
      summary: Corporate hierarchy for a resolved entity
      description: >-
        An entity's corporate hierarchy resolved through our spine:
        `direct_parent`, `ultimate_parent`, `children` and `child_count`.
        Accepts the same identifiers as the rest of the API — a name, an `e_`
        id, a `wiki:` id or a wikipedia_url — and additionally a bare
        20-character LEI, so the identifier you searched with works at this hop
        too.


        **Read the `coverage` block before the hierarchy.** `lei_present: false`
        means the entity carries no LEI in our crosswalk — a coverage gap, NOT
        evidence the entity has no parent. `reporting_exception` carries the
        reason a filer gave for not naming a parent (for example
        NO_KNOWN_PERSON), which is a DECLARED absence and materially different
        from an unknown one. `child_count` is null, never 0, when the requested
        direction excluded children.


        Corporate hierarchy as reported to the Global LEI System: accounting
        consolidation under IFRS/US-GAAP, not percentage ownership and not
        beneficial ownership. Natural persons are out of scope, and reporting is
        partial — an absent parent usually means the filer declared a reporting
        exception rather than that none exists.


        Gated on the existing `can_use_exposure` entitlement; the LEI itself is
        ungated. Point-in-time (`as_of`) is not supported for this source.
      operationId: get-entity-hierarchy-v2
      parameters:
        - name: entity_id
          in: path
          required: true
          schema:
            type: string
          description: >-
            A name, an `e_` spine id, a `wiki:` news id, a wikipedia_url, or a
            bare 20-character LEI.
          example: Gazprom
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - up
              - down
              - both
            default: both
          description: Which way to walk.
          example: both
        - name: depth
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 5
            default: 1
          description: Ancestor chain depth.
        - name: include_siblings
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Include entities sharing the same direct parent.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 25
          description: Children to return.
      responses:
        '200':
          description: >-
            `entity`, `hierarchy` (or null), `coverage` and `meta` — the latter
            carrying the GLEIF attribution, the consolidation disclaimer
            verbatim, and `time_semantics`.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: >-
            Invalid parameter — `code` is one of INVALID_LEI, INVALID_ENUM,
            INVALID_LIMIT or FILTER_REQUIRED, with `details.accepted_values`
            where an enum was rejected.
        '403':
          description: PLAN_REQUIRED — the caller's plan lacks `can_use_gleif`.
        '404':
          description: >-
            ENTITY_NOT_FOUND — the reference did not resolve, or the LEI is not
            in the index we serve.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````