> ## Documentation Index
> Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GetCompanyEnrichment

> GetCompanyEnrichment aggregates a per-company intelligence composite: SEC EDGAR
 identity and recent filings (via authoritative ticker-to-CIK resolution), market
 profile and earnings surprises from Finnhub, and recent news mentions.



## OpenAPI

````yaml /api/IntelligenceService.openapi.yaml get /api/intelligence/v1/get-company-enrichment
openapi: 3.1.0
info:
  title: IntelligenceService API
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/intelligence/v1/get-company-enrichment:
    get:
      tags:
        - IntelligenceService
      summary: GetCompanyEnrichment
      description: >-
        GetCompanyEnrichment aggregates a per-company intelligence composite:
        SEC EDGAR
         identity and recent filings (via authoritative ticker-to-CIK resolution), market
         profile and earnings surprises from Finnhub, and recent news mentions.
      operationId: GetCompanyEnrichment
      parameters:
        - name: domain
          deprecated: true
          in: query
          description: >-
            Deprecated compatibility input. Domain attribution remains disabled
            and
             returns the legacy empty stub; use ticker or name for verified CIK lookup.
          required: false
          example: example
          schema:
            type: string
        - name: name
          in: query
          description: Company name, such as "Apple Inc".
          required: false
          example: WorldMonitor Analyst
          schema:
            type: string
        - name: ticker
          in: query
          description: Exchange ticker symbol, such as "AAPL". Preferred lookup key.
          required: false
          example: AAPL
          schema:
            type: string
        - name: jmespath
          in: query
          description: >-
            Optional JMESPath expression applied server-side to project or
            reduce the JSON response before it is returned (mirrors the MCP
            jmespath argument). Invalid expressions, expressions larger than
            1024 UTF-8 bytes, or projections that exceed the 256 KB output cap
            return HTTP 400 with a {_jmespath_error, original_keys} envelope.
            Grammar and worked examples:
            https://www.worldmonitor.app/docs/mcp-jmespath.
          required: false
          example: keys(@)
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                company:
                  cik: '0000320193'
                  description: Electronic Computers
                  domain: apple.com
                  founded: 0
                  location: Cupertino, CA
                  name: Apple Inc.
                  ticker: AAPL
                  website: https://www.apple.com
                earningsSurprises:
                  - actualEps: 1.57
                    estimateEps: 1.43
                    period: '2026-06-30'
                    quarter: 3
                    surprise: 0.14
                    surprisePercent: 9.79
                    year: 2026
                enrichedAtMs: 1784908800000
                hackerNewsMentions: []
                market:
                  country: US
                  currency: USD
                  exchange: NASDAQ NMS - GLOBAL MARKET
                  industry: Technology
                  ipoDate: '1980-12-12'
                  logoUrl: >-
                    https://static2.finnhub.io/file/publicdatany/finnhubimage/stock_logo/AAPL.png
                  marketCapMusd: 3200000
                newsMentions:
                  - publishedAtMs: 1784905200000
                    source: example.com
                    title: Apple reports quarterly results
                    url: https://example.com/apple-results
                secFilings:
                  recentFilings:
                    - description: Results of Operations and Financial Condition
                      fileDate: '2026-07-24'
                      form: 8-K
                      items:
                        - '2.02'
                      url: >-
                        https://www.sec.gov/Archives/edgar/data/320193/000032019326000070/0000320193-26-000070-index.htm
                  totalFilings: 120
                sources:
                  - sec_edgar
                  - finnhub
                  - news
                techStack: []
                unavailable: false
              schema:
                $ref: '#/components/schemas/GetCompanyEnrichmentResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/JmespathProjectionError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: >-
            API access requires an active subscription (the API key's
            subscription is inactive or expired).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '429':
          description: Rate limit exceeded.
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Remaining:
              description: Requests remaining in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Reset:
              description: >-
                Unix epoch milliseconds when the active rate-limit window
                resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/RateLimitError'
        default:
          description: Gateway or handler error response.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/GatewayError'
components:
  schemas:
    GetCompanyEnrichmentResponse:
      type: object
      properties:
        company:
          $ref: '#/components/schemas/EnrichedCompany'
        github:
          $ref: '#/components/schemas/EnrichedGithub'
          deprecated: true
        techStack:
          deprecated: true
          type: array
          items:
            $ref: '#/components/schemas/TechStackItem'
        secFilings:
          $ref: '#/components/schemas/SecFilings'
        hackerNewsMentions:
          deprecated: true
          type: array
          items:
            $ref: '#/components/schemas/HNMention'
        enrichedAtMs:
          type: integer
          format: int64
          description: >-
            Unix timestamp in milliseconds when this data was fetched.. Warning:
            Values > 2^53 may lose precision in JavaScript
        sources:
          type: array
          items:
            type: string
            description: >-
              List of sources successfully reached (e.g. "sec_edgar", "finnhub",
              "news").
        market:
          $ref: '#/components/schemas/CompanyMarketProfile'
        earningsSurprises:
          type: array
          items:
            $ref: '#/components/schemas/EarningsSurprise'
        newsMentions:
          type: array
          items:
            $ref: '#/components/schemas/CompanyNewsMention'
        unavailable:
          type: boolean
          description: >-
            True when identity could not be resolved because the SEC registry
            was
             unreadable, or when a resolved company's enrichment sources all failed.
             Responses with this set are never cached.
      description: >-
        Company enrichment composite aggregated from SEC EDGAR (identity +
        filings),
         Finnhub (market profile + earnings surprises), and the news corpus (mentions).
    ValidationError:
      type: object
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/FieldViolation'
          description: List of validation violations
      required:
        - violations
      description: >-
        ValidationError is returned when request validation fails. It contains a
        list of field violations describing what went wrong.
    JmespathProjectionError:
      description: >-
        Returned when a REST jmespath projection is invalid or exceeds the
        expression/output byte limits.
      properties:
        _jmespath_error:
          description: Projection error discriminator and details.
          type: string
        original_keys:
          description: Top-level keys or shape of the unprojected response.
          items:
            type: string
          type: array
      required:
        - _jmespath_error
        - original_keys
      type: object
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
      description: >-
        Returned when the API key is missing, malformed, or lacks current API
        access.
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable entitlement failure reason.
        requiredTier:
          type: integer
          format: int32
          description: Minimum entitlement tier required for this endpoint.
        currentTier:
          type: integer
          format: int32
          description: Caller entitlement tier when known.
        planKey:
          type: string
          description: Caller plan key when known.
      required:
        - error
      description: >-
        Returned when a PRO-gated endpoint denies access because the caller has
        no resolved authenticated user, entitlements cannot be verified, or the
        caller lacks the required entitlement tier.
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message (e.g., 'user not found', 'database connection failed')
      description: >-
        Error is returned when a handler encounters an error. It contains a
        simple error message that the developer can customize.
    RateLimitError:
      type: object
      description: Returned when a gateway or handler rate limit rejects the request.
      properties:
        error:
          type: string
          description: Human-readable rate-limit failure reason.
      required:
        - error
    GatewayError:
      type: object
      description: >-
        Returned by gateway infrastructure errors before an RPC handler runs,
        such as origin, routing, method, authentication, or quota checks.
      properties:
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: Gateway error reason or structured gateway failure details.
      required:
        - error
    EnrichedCompany:
      type: object
      properties:
        name:
          type: string
        domain:
          type: string
        description:
          type: string
          description: Industry classification (SEC SIC description).
        location:
          type: string
          description: Business location, such as "Cupertino, CA".
        website:
          type: string
        founded:
          deprecated: true
          type: integer
          format: int32
          description: >-
            Deprecated compatibility field; always 0 because no authoritative
            source
             in this composite provides founding year.
        cik:
          type: string
          description: >-
            SEC Central Index Key (zero-padded 10 digits), empty when no EDGAR
            match.
        ticker:
          type: string
          description: Resolved primary ticker symbol.
    EnrichedGithub:
      type: object
      properties:
        publicRepos:
          type: integer
          format: int32
        followers:
          type: integer
          format: int32
        avatarUrl:
          type: string
    TechStackItem:
      type: object
      properties:
        name:
          type: string
        category:
          type: string
        confidence:
          type: number
          format: float
    SecFilings:
      type: object
      properties:
        totalFilings:
          type: integer
          format: int32
          description: >-
            Total filings known for this CIK in the recent EDGAR submissions
            window.
        recentFilings:
          type: array
          items:
            $ref: '#/components/schemas/SecFiling'
    HNMention:
      type: object
      properties:
        title:
          type: string
        url:
          type: string
        points:
          type: integer
          format: int32
        comments:
          type: integer
          format: int32
        createdAtMs:
          type: integer
          format: int64
          description: 'Warning: Values > 2^53 may lose precision in JavaScript'
    CompanyMarketProfile:
      type: object
      properties:
        exchange:
          type: string
        industry:
          type: string
          description: Industry classification from Finnhub.
        marketCapMusd:
          type: number
          format: double
          description: Market capitalization in millions of USD.
        ipoDate:
          type: string
          description: IPO date (YYYY-MM-DD), empty when unknown.
        logoUrl:
          type: string
        country:
          type: string
          description: Company headquarters country code.
        currency:
          type: string
    EarningsSurprise:
      type: object
      properties:
        period:
          type: string
          description: Fiscal period end date (YYYY-MM-DD).
        actualEps:
          type: number
          format: double
        estimateEps:
          type: number
          format: double
        surprise:
          type: number
          format: double
          description: actual minus estimate.
        surprisePercent:
          type: number
          format: double
        year:
          type: integer
          format: int32
        quarter:
          type: integer
          format: int32
    CompanyNewsMention:
      type: object
      properties:
        title:
          type: string
        url:
          type: string
        source:
          type: string
        publishedAtMs:
          type: integer
          format: int64
          description: >-
            Unix timestamp in milliseconds when the story was published (0 when
            unknown).. Warning: Values > 2^53 may lose precision in JavaScript
    FieldViolation:
      type: object
      properties:
        field:
          type: string
          description: >-
            The field path that failed validation (e.g., 'user.email' for nested
            fields). For header validation, this will be the header name (e.g.,
            'X-API-Key')
        description:
          type: string
          description: >-
            Human-readable description of the validation violation (e.g., 'must
            be a valid email address', 'required field missing')
      required:
        - field
        - description
      description: FieldViolation describes a single validation error for a specific field.
    SecFiling:
      type: object
      properties:
        form:
          type: string
        fileDate:
          type: string
        description:
          type: string
        url:
          type: string
          description: Link to the filing index on sec.gov.
        items:
          type: array
          items:
            type: string
            description: >-
              8-K item codes disclosed in this filing (e.g. "2.02"), empty for
              other forms.
  securitySchemes:
    WorldMonitorKey:
      type: apiKey
      in: header
      name: X-WorldMonitor-Key
      description: User-issued WorldMonitor API key.
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key).

````