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

# Social signal

> Social-channel signal (volume / tone) for an entity over a window. Admin-only preview.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/social
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/social:
    get:
      tags:
        - Media Intelligence
      summary: Social signal
      description: >-
        Social-channel signal (volume / tone) for an entity over a window.
        Admin-only preview.
      operationId: social-v2
      parameters:
        - name: entity
          in: query
          required: true
          schema:
            type: string
          description: >-
            Entity name to search — company, person, or topic (Bluesky / AT
            Protocol full-network post search).
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: Deprecated alias for `entity`.
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 30
            default: 7
          description: Trailing N-day window (1–30). Defaults to 7.
      responses:
        '200':
          description: Social signal.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      entity:
                        type: string
                      window_days:
                        type: integer
                      mention_count:
                        type: integer
                      total_engagement:
                        type: integer
                      posts:
                        type: array
                        items:
                          type: object
                          properties:
                            text:
                              type: string
                            handle:
                              type: string
                            created_at:
                              type: string
                            likes:
                              type: integer
                            reposts:
                              type: integer
                            replies:
                              type: integer
                            uri:
                              type: string
                            lang:
                              type: string
                      sentiment:
                        type: object
                        properties:
                          score:
                            type: number
                          label:
                            type: string
                      source:
                        type: string
                  methodology:
                    type: object
                    properties:
                      source:
                        type: string
                      mention_count:
                        type: string
                      sentiment:
                        type: string
                      coverage_note:
                        type: string
              examples:
                example:
                  summary: GET /api/v2/social — example response
                  value:
                    success: true
                    status: available
                    data:
                      entity: Tesla
                      window_days: 7
                      mention_count: 342
                      total_engagement: 18764
                      posts:
                        - text: >-
                            Tesla Q2 deliveries beat expectations again — strong
                            quarter for the bulls. $TSLA
                          handle: evanalyst.bsky.social
                          created_at: '2026-06-27T15:42:11.000Z'
                          likes: 1284
                          reposts: 326
                          replies: 188
                          uri: >-
                            at://did:plc:7q3v2m9x8k1c4b6n0d5f2g8h/app.bsky.feed.post/3kx9a2b7c1d2e
                          lang: en
                        - text: >-
                            New Tesla recall on Autopilot software raises fresh
                            safety questions for regulators.
                          handle: newswire.bsky.social
                          created_at: '2026-06-26T09:18:03.000Z'
                          likes: 642
                          reposts: 410
                          replies: 233
                          uri: >-
                            at://did:plc:1a2b3c4d5e6f7g8h9i0j1k2l/app.bsky.feed.post/3kx7p4q9r2s3t
                          lang: en
                      sentiment:
                        score: -0.118
                        label: neutral
                      source: bluesky
                    methodology:
                      source: >-
                        Bluesky (AT Protocol) full-network post search
                        (app.bsky.feed.searchPosts)
                      mention_count: >-
                        retrieved post count within window — indicative, not
                        exhaustive
                      sentiment: >-
                        naive lexicon scoring — indicative only; not a
                        calibrated tone model
                      coverage_note: >-
                        strong for news/politics/companies/policy; thin for
                        granular physical assets + non-English entities
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Admin-only preview (ADMIN_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_...`.'

````