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

# Filer profile

> A filer's identity, ticker, resolved entity_id, recent filings, and XBRL financial highlights. Requires a plan with SEC filings access (`can_use_filings`) — the Corporate & Supply Chain plan and above.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/filings/{cik}
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/filings/{cik}:
    get:
      tags:
        - Filings
      summary: Filer profile
      description: >-
        A filer's identity, ticker, resolved entity_id, recent filings, and XBRL
        financial highlights. Requires a plan with SEC filings access
        (`can_use_filings`) — the Corporate & Supply Chain plan and above.
      operationId: get-filer-v2
      parameters:
        - name: cik
          in: path
          required: true
          schema:
            type: integer
          description: SEC CIK number.
      responses:
        '200':
          description: >-
            Filer profile for the CIK. Envelope: { success, cik, company_name,
            ticker (or null), entity_id (entity-spine id, or null),
            recent_filings (up to 25 recent rows: accession_no, company_name,
            form_type, file_date, is_amendment, primary_doc_url), risk_factors
            (disclosed Item-1A risk themes), xbrl_highlights (headline concepts:
            concept, unit, value, period_end) }.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  cik:
                    type: integer
                  company_name:
                    type: string
                  ticker:
                    type: string
                  entity_id:
                    type: string
                  recent_filings:
                    type: array
                    items:
                      type: object
                      properties:
                        accession_no:
                          type: string
                        cik:
                          type: integer
                        company_name:
                          type: string
                        form_type:
                          type: string
                        file_date:
                          type: string
                        is_amendment:
                          type: boolean
                        primary_doc_url:
                          type: string
                  risk_factors:
                    type: array
                    items:
                      type: string
                  business:
                    type: object
                    properties:
                      description:
                        type: string
                      segments:
                        type: array
                        items:
                          type: string
                      products_services:
                        type: array
                        items:
                          type: string
                  xbrl_highlights:
                    type: array
                    items:
                      type: object
                      properties:
                        concept:
                          type: string
                        unit:
                          type: string
                        value:
                          type: integer
                        period_end:
                          type: string
              examples:
                example:
                  summary: GET /api/v2/filings/{cik} — example response
                  value:
                    success: true
                    cik: 65270
                    company_name: METHODE ELECTRONICS INC
                    ticker: MEI
                    entity_id: ent_8f2c1a7d9b4e
                    recent_filings:
                      - accession_no: 0000065270-26-000058
                        cik: 65270
                        company_name: METHODE ELECTRONICS INC
                        form_type: 8-K
                        file_date: '2026-06-18'
                        is_amendment: false
                        primary_doc_url: >-
                          https://www.sec.gov/Archives/edgar/data/65270/000006527026000058/mei-20260618.htm
                      - accession_no: 0000065270-26-000041
                        cik: 65270
                        company_name: METHODE ELECTRONICS INC
                        form_type: 10-K
                        file_date: '2026-06-12'
                        is_amendment: false
                        primary_doc_url: >-
                          https://www.sec.gov/Archives/edgar/data/65270/000006527026000041/mei-20260501.htm
                    risk_factors:
                      - supply_concentration
                      - geopolitical
                    business:
                      description: >-
                        Methode Electronics is a global developer of
                        custom-engineered and application-specific products and
                        solutions utilizing electrical, radio remote control,
                        electronic, wireless and sensing technologies, serving
                        automotive, industrial, and commercial vehicle markets.
                      segments:
                        - Automotive
                        - Industrial
                        - Interface
                        - Medical
                      products_services:
                        - user interface assemblies
                        - LED lighting
                        - power distribution units
                        - sensors
                    xbrl_highlights:
                      - concept: Revenue
                        unit: USD
                        value: 1049800000
                        period_end: '2026-05-02'
                      - concept: Assets
                        unit: USD
                        value: 1387500000
                        period_end: '2026-05-02'
                      - concept: NetIncomeLoss
                        unit: USD
                        value: -28400000
                        period_end: '2026-05-02'
                      - concept: StockholdersEquity
                        unit: USD
                        value: 612300000
                        period_end: '2026-05-02'
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Plan required (PLAN_REQUIRED)
          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_...`.'

````