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

# Filers that name a company

> Relations extracted from SEC filings, read from the counterparty's side: which filers name a company as a supplier, customer, partner or counterparty, with the filer CIK and name, the accession, the verbatim evidence and the extraction confidence. Each row says how its object was tied to the entity in `resolution_source`: `ingest` (the registry id stored at extraction), `serve_consensus` (the table's own majority id for that exact object name, as `/filings/{cik}/relations` reports it) or, only with `match=name`, `name_match`. `meta.coverage` counts each source, reports what the name match checked and withheld, and gives the share of stored relations bound to a registry id by relation kind. Without `entity`, the counterparty's country or the commodity selects relations across the 500 filers that filed matching relations most recently; `meta.truncation` says when that cap applied.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/filings/relations
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: Situations
    description: >-
      One real-world occurrence as the Stories and coded Events that belong to
      it — stored, adjudicated membership (`meta.situation_source: curated`) or
      a walked neighbourhood around a Story. Discovery, detail, four
      independently paged member lists, and the only write on the core surface
      (5 QU with an Idempotency-Key).
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone. Also the publication activity journal
      (/api/v2/activity): observed evidence of what was published about
      identities and records — committed batches only, cursor-paged, never
      source intake.
  - name: Unified Search
    description: >-
      One fuzzy lookup across every id-space — start here with a name, take the
      entity id, then reuse it on every other surface. This is the resolver the
      rest of the API assumes you called first.
  - name: Media Intelligence
    description: >-
      Press-coverage tone over time and share of voice against a peer set.
      Requires the `can_use_tone` / `can_use_share_of_voice` entitlement; social
      signal is an admin-only preview.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets, World Port Index
      ports and Epoch AI data centers on one keyed surface, resolved to spine
      owners. Requires the `can_use_facilities` entitlement.
  - name: Monitors
    description: >-
      Organization-shared scheduled checks over the Core API, with email and
      signed-webhook delivery. Monitor execution does not consume query units.
  - name: Saved Queries
    description: >-
      Reusable validated query recipes with private or explicit workspace
      sharing.
  - name: Geography
    description: >-
      Country context and admin-1 geography: /api/v2/countries (publication
      activity, reporting counts, dated economic and resource fundamentals,
      facility and office inventories, directory mode over every registered
      country) and admin-1 lookups.
  - name: Government
    description: >-
      US federal awards (USAspending) and foreign-influence registrations (DOJ
      NSD FARA), resolved onto the entity spine. Requires the `can_use_gov`
      entitlement.
  - name: Political Offices
    description: >-
      Public political offices and who holds them — legislatures, cabinets,
      heads of state, courts and IGO posts, with the office start/end dates the
      publisher states (valid time), resolved onto the entity spine. Actor
      context for geopolitical analysis; NOT a PEP or sanctions-screening tool.
      Requires the `can_use_offices` entitlement.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and relations extracted from filing
      text. Requires the `can_use_filings` entitlement.
  - name: Reference Data
    description: >-
      The GLEIF Global LEI Index — legal-entity reference data, consolidation
      relationships, and LEI↔ISIN mappings. Requires the `can_use_gleif`
      entitlement.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: AI Compute
    description: >-
      Epoch AI datasets — models, hardware, data centers, companies and chip
      sales. Requires the `can_use_epoch_ai` entitlement.
  - name: Macro Finance
    description: >-
      FRED economic time series — catalog, point-in-time observations and
      releases. Requires the `can_use_macro` entitlement.
  - name: Screening and Reference
    description: >-
      Restricted-party lists, name screening and ownership-chain exposure.
      Requires the `can_use_screening` / `can_use_exposure` entitlement.
      Analytical coverage, not an audit-grade compliance control.
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Requires the
      `can_use_china` entitlement.
  - name: Maritime
    description: >-
      AIS-derived vessel flow — chokepoint transits, last-known vessel
      positions, carriers, dwell and AIS-dark gaps. Terrestrial AIS only, so
      coverage thins in open ocean. Requires the `can_use_maritime` entitlement.
  - name: Atlas Intelligence
    description: >-
      Geopolitical-risk and posture indices computed from GDELT Cloud’s own
      coded events, normalized to each place’s own frozen baseline.
  - name: Natural Resources
    description: >-
      USGS mineral production, reserves and qualified country statistics,
      composed with the physical Facilities inventory.
  - name: Briefs
    description: Source-backed monitoring briefs.
  - name: Meta
    description: >-
      Machine-readable discovery: the value vocabularies, the endpoint
      contracts, and the query-unit cost model. Unmetered, so a client can check
      before it spends.
paths:
  /api/v2/filings/relations:
    get:
      tags:
        - Filings
      summary: Filers that name a company
      description: >-
        Relations extracted from SEC filings, read from the counterparty's side:
        which filers name a company as a supplier, customer, partner or
        counterparty, with the filer CIK and name, the accession, the verbatim
        evidence and the extraction confidence. Each row says how its object was
        tied to the entity in `resolution_source`: `ingest` (the registry id
        stored at extraction), `serve_consensus` (the table's own majority id
        for that exact object name, as `/filings/{cik}/relations` reports it)
        or, only with `match=name`, `name_match`. `meta.coverage` counts each
        source, reports what the name match checked and withheld, and gives the
        share of stored relations bound to a registry id by relation kind.
        Without `entity`, the counterparty's country or the commodity selects
        relations across the 500 filers that filed matching relations most
        recently; `meta.truncation` says when that cap applied.
      operationId: list-filings-relations-by-counterparty-v2
      parameters:
        - name: entity
          in: query
          required: false
          schema:
            type: string
            pattern: >-
              ^(?:e_[A-Fa-f0-9]{8,64}|wiki:[A-Fa-f0-9]{8,64}|llm:[A-Fa-f0-9]{8,64})$
          description: >-
            The named company: a registry `e_` id, or a news `wiki:`/`llm:` id
            bridged to the registry. Rows stored under any id that has since
            merged into it are included. A bare name is refused
            (INVALID_ENTITY_ID); resolve it first with
            `/api/v2/filings/resolve?q=` (its `entity_id`) or
            `/api/v2/entities?q=`. Also accepts: `entity_id`.
          example: e_ba0a64d8155fd63b
          x-aliases:
            - entity_id
        - name: rel_type
          in: query
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subsidiary
                - supplier
                - customer
                - counterparty
                - partner
                - jurisdiction_exposure
                - risk_factor
          description: >-
            Relation kinds to read, comma-separated. Omitted:
            `supplier,customer,partner,counterparty`. `subsidiary` reads the
            filers whose Exhibit 21 lists the company. Full value list:
            https://docs.gdeltcloud.com/reference/enums#filings_rel_type
          example: supplier
        - name: match
          in: query
          required: false
          schema:
            type: string
            enum:
              - resolved
              - name
            default: resolved
          description: >-
            `resolved` admits relations tied to the entity by a stored registry
            id or by the table's name consensus. `name` also admits relations
            whose unresolved object name equals one of the entity's registry
            names (after dropping corporate suffixes and a trailing acronym in
            parentheses) and no other registry entity's. Those rows carry
            `resolution_source: name_match` and `matched_name`; an exact name is
            evidence, not proof, so read the quote. With `match=name`: requires
            `entity`. a name match needs the entity whose registry names it
            compares Full value list:
            https://docs.gdeltcloud.com/reference/enums#filings_relation_match
          example: name
          x-dependencies:
            - when:
                - name
              requires:
                entity: true
              code: INCOMPATIBLE_PARAMETERS
        - name: group_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - relation
              - filer
            default: relation
          description: >-
            `relation`: one row per stored relation (a filer can name a company
            in several filings and sections). `filer`: one row per filer and
            relation kind, carrying its most recent, most confident relation
            plus `relation_count`, `filing_count`, `first_file_date` and
            `last_file_date`. Full value list:
            https://docs.gdeltcloud.com/reference/enums#filings_relation_group_by
          example: filer
        - name: country
          in: query
          required: false
          schema:
            type: string
          description: >-
            Counterparty (object) country, comma-separated: a name, ISO-2 or
            ISO-3 code. Matches the country the extraction recorded for the
            named company, not the filer's country. Also accepts:
            `country_iso3`. Note: validation is owned by the endpoint service
            because it depends on composed or cross-parameter state; the
            published error semantics above still apply.
          example: TWN
          x-aliases:
            - country_iso3
        - name: region
          in: query
          required: false
          schema:
            type: string
            enum:
              - Middle East
              - Northern Africa
              - Western Africa
              - Eastern Africa
              - Middle Africa
              - Southern Africa
              - Eastern Europe
              - South Asia
              - Southeast Asia
              - East Asia
              - Central Asia
              - Northern America
              - Central America
              - Caribbean
          description: >-
            Counterparty region, expanded to its countries and applied like
            `country`. Matched case-insensitively. Full value list:
            https://docs.gdeltcloud.com/reference/enums#region
          example: East Asia
        - name: continent
          in: query
          required: false
          schema:
            type: string
            enum:
              - Africa
              - Asia
              - Europe
              - North America
              - South America
              - Oceania
          description: >-
            Counterparty continent, expanded to its countries and applied like
            `country`. Matched case-insensitively. Full value list:
            https://docs.gdeltcloud.com/reference/enums#continent
          example: Asia
        - name: commodity
          in: query
          required: false
          schema:
            type: string
            pattern: ^.{3,}$
          description: >-
            What is supplied, as the extraction recorded it (`wafers`, `memory`,
            `crude oil` …): a case-insensitive substring of `object_commodity`,
            at least 3 characters. Open vocabulary; most customer and partner
            relations carry none.
          example: wafer
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: >-
            Rows per page (relations, or filers with `group_by=filer`); page on
            with `cursor`.
          example: '50'
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Continuation from pagination.next_cursor in the previous response.
            Keep the other filters unchanged; null means no next page. Also
            accepts: `offset`.
          example: '50'
          x-aliases:
            - offset
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
              examples:
                default:
                  summary: Filers that name TSMC as a supplier
                  value:
                    success: true
                    data: []
        '400':
          description: Invalid or unsupported parameter (see `code` and `details`)
        '401':
          description: Missing or invalid API key
        '403':
          description: Plan does not include this surface
        '404':
          description: Not found
        '429':
          description: Quota or rate limit exceeded
        '500':
          description: Server error
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.