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

# Chokepoint dwell episodes

> Dwell episodes — completed arrival→departure stays at maritime chokepoints, derived from terrestrial AIS. Each row is one vessel's stay with its dwell duration. Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above.

Forward-accruing: episodes begin accruing at launch (June 2026) — no historical backfill. Derived-only: no raw position track. Terrestrial AIS only (no satellite). Filtered by departure time; date windows are capped at 30 days and default to the trailing 7 days.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/maritime/dwell
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/dwell:
    get:
      tags:
        - Maritime
      summary: Chokepoint dwell episodes
      description: >-
        Dwell episodes — completed arrival→departure stays at maritime
        chokepoints, derived from terrestrial AIS. Each row is one vessel's stay
        with its dwell duration. Requires a plan with Maritime intelligence
        access (`can_use_maritime`) — the Corporate & Supply Chain plan and
        above.


        Forward-accruing: episodes begin accruing at launch (June 2026) — no
        historical backfill. Derived-only: no raw position track. Terrestrial
        AIS only (no satellite). Filtered by departure time; date windows are
        capped at 30 days and default to the trailing 7 days.
      operationId: list-maritime-dwell-v2
      parameters:
        - name: chokepoint
          in: query
          required: false
          schema:
            type: string
            enum:
              - hormuz
              - bab_el_mandeb
              - malacca
              - suez
              - panama
              - bosphorus
              - gibraltar
              - dover
              - kerch
              - taiwan
              - danish_straits
          description: Restrict to one chokepoint. Omit for all.
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - ongoing
              - completed
          description: >-
            `ongoing` = the vessel is still inside the chokepoint at the rollup
            edge (its `dwell_hours` is elapsed-so-far and `departure` is an
            as-of timestamp, not final); `completed` = the vessel has departed.
            Omit for both. An unknown value returns 400 INVALID_ENUM.
        - name: date_start
          in: query
          required: false
          schema:
            type: string
          description: Departure-window start YYYY-MM-DD (≤30-day window).
        - name: date_end
          in: query
          required: false
          schema:
            type: string
          description: Departure-window end YYYY-MM-DD.
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 30
          description: Trailing N-day window (1–30). Defaults to 7.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
          description: Rows per page (1–500).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor (offset) from a prior response's next_cursor.
      responses:
        '200':
          description: >-
            A page of dwell episodes, by departure time (most recent first).
            Each row: imo, mmsi, chokepoint, arrival, departure, dwell_hours.
            Standard envelope: { success, data, pagination, applied_filters }.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        imo:
                          type: string
                        mmsi:
                          type: integer
                        chokepoint:
                          type: string
                        arrival:
                          type: string
                        departure:
                          type: string
                        dwell_hours:
                          type: number
                        status:
                          type: string
                          description: >-
                            `ongoing` (still inside the chokepoint at the rollup
                            edge; `departure`/`dwell_hours` are as-of) or
                            `completed` (the vessel has departed).
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor: {}
                      next_cursor: {}
                  applied_filters:
                    type: object
                    properties:
                      date_start:
                        type: string
                      date_end:
                        type: string
                      chokepoint:
                        type: string
                      status:
                        type: string
                      ignored:
                        type: object
                        properties: {}
              examples:
                example:
                  summary: GET /api/v2/maritime/dwell — example response
                  value:
                    success: true
                    data:
                      - imo: '9006681'
                        mmsi: 636019825
                        chokepoint: hormuz
                        arrival: '2026-06-11 22:18:40'
                        departure: '2026-06-13 06:51:09'
                        dwell_hours: 32.5
                      - imo: '9388893'
                        mmsi: 538008914
                        chokepoint: hormuz
                        arrival: '2026-06-12 14:02:33'
                        departure: '2026-06-12 19:47:55'
                        dwell_hours: 5.8
                    pagination:
                      limit: 100
                      cursor: null
                      next_cursor: null
                    applied_filters:
                      date_start: '2026-06-08'
                      date_end: '2026-06-14'
                      chokepoint: hormuz
                      ignored: {}
        '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_...`.'

````