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

# Spatial density grid

> Spatial density grid (heatmap) of position and vessel counts per lat/lon cell within an area. Shows where traffic concentrates. AREA REQUIRED — pass bbox, near, or near_gem_id. Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above.

Historical / baseline surface: reads raw AIS positions directly. Forward-accruing: positions begin at launch (June 2026) — no historical backfill. Terrestrial AIS only (no satellite). Date windows are capped at 7 days; defaults to the trailing 1 day.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/maritime/density
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/maritime/density:
    get:
      tags:
        - Maritime
      summary: Spatial density grid
      description: >-
        Spatial density grid (heatmap) of position and vessel counts per lat/lon
        cell within an area. Shows where traffic concentrates. AREA REQUIRED —
        pass bbox, near, or near_gem_id. Requires a plan with Maritime
        intelligence access (`can_use_maritime`) — the Corporate & Supply Chain
        plan and above.


        Historical / baseline surface: reads raw AIS positions directly.
        Forward-accruing: positions begin at launch (June 2026) — no historical
        backfill. Terrestrial AIS only (no satellite). Date windows are capped
        at 7 days; defaults to the trailing 1 day.
      operationId: list-maritime-density-v2
      parameters:
        - name: bbox
          in: query
          required: false
          schema:
            type: string
          description: >-
            Bounding box filter: minLon,minLat,maxLon,maxLat (lon-first axis
            order). One of bbox / near / near_gem_id is required.
        - name: near
          in: query
          required: false
          schema:
            type: string
          description: >-
            Point 'lat,lon' for a radius area; combine with radius_km (default
            50 km). One of bbox / near / near_gem_id is required.
        - name: near_gem_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            GEM energy-asset gem_id center — concentration of traffic within
            radius_km of that asset (default 25 km). One of bbox / near /
            near_gem_id is required.
        - name: radius_km
          in: query
          required: false
          schema:
            type: number
          description: >-
            Radius in km for near / near_gem_id. Default 50 (near) or 25
            (near_gem_id); clamped 1–2000.
        - name: cell_deg
          in: query
          required: false
          schema:
            type: number
            minimum: 0.01
            maximum: 1
            default: 0.05
          description: >-
            Grid cell size in degrees (0.01–1). Smaller = finer heatmap.
            Defaults to 0.05.
        - name: date_start
          in: query
          required: false
          schema:
            type: string
          description: Window start YYYY-MM-DD (≤7-day window).
        - name: date_end
          in: query
          required: false
          schema:
            type: string
          description: Window end YYYY-MM-DD.
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 7
          description: Trailing N-day window (1–7). Defaults to 1.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 500
            minimum: 1
            maximum: 5000
          description: Grid cells per page (1–5000), densest first.
      responses:
        '200':
          description: >-
            Density grid, densest cells first. Envelope: { success, cell_deg,
            data, pagination, applied_filters }. Each data row: cell_lat,
            cell_lon (cell SW/lower corner, degrees), positions (AIS message
            count), vessels (distinct mmsi).
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  cell_deg:
                    type: number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        cell_lat:
                          type: number
                        cell_lon:
                          type: number
                        positions:
                          type: integer
                        vessels:
                          type: integer
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor: {}
                      next_cursor: {}
                  applied_filters:
                    type: object
                    properties:
                      date_start:
                        type: string
                      date_end:
                        type: string
                      cell_deg:
                        type: number
                      bbox:
                        type: string
                      ignored:
                        type: object
                        properties: {}
              examples:
                example:
                  summary: GET /api/v2/maritime/density — example response
                  value:
                    success: true
                    cell_deg: 0.05
                    data:
                      - cell_lat: 26.55
                        cell_lon: 56.25
                        positions: 4821
                        vessels: 73
                      - cell_lat: 26.6
                        cell_lon: 56.3
                        positions: 3947
                        vessels: 61
                    pagination:
                      limit: 500
                      cursor: null
                      next_cursor: null
                    applied_filters:
                      date_start: '2026-06-13'
                      date_end: '2026-06-14'
                      cell_deg: 0.05
                      bbox: 54.0,25.5,57.5,27.5
                      ignored: {}
        '400':
          description: >-
            Area required or invalid parameter (AREA_REQUIRED, INVALID_BBOX,
            INVALID_NEAR, INVALID_RADIUS)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Plan required (PLAN_REQUIRED) — the caller's plan does not carry the
            required source entitlement.
          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_...`.'

````