> ## 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. # Port disruption pulse > Port-level disruption intelligence — geo-fuses the WPI ports reference with GDELT events near each port (within `event_radius_km` over the last `days`): relevant-event volume, conflict signal, a 7d-vs-baseline anomaly ratio, recent headlines, nearby flagged-energy-asset exposure, and AIS-coverage context. Scope by country, terminal type, name, or proximity; with no scope it defaults to strategic ports (LNG/oil terminals + large harbors). Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above. Each row scores a `pulse_level` (critical / elevated / active / quiet) and rows are risk-ranked. Envelope: `{ success, data, summary, applied_filters }`. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/maritime/port-pulse 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/port-pulse: get: tags: - Maritime summary: Port disruption pulse description: >- Port-level disruption intelligence — geo-fuses the WPI ports reference with GDELT events near each port (within `event_radius_km` over the last `days`): relevant-event volume, conflict signal, a 7d-vs-baseline anomaly ratio, recent headlines, nearby flagged-energy-asset exposure, and AIS-coverage context. Scope by country, terminal type, name, or proximity; with no scope it defaults to strategic ports (LNG/oil terminals + large harbors). Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above. Each row scores a `pulse_level` (critical / elevated / active / quiet) and rows are risk-ranked. Envelope: `{ success, data, summary, applied_filters }`. operationId: list-maritime-port-pulse-v2 parameters: - name: country in: query required: false schema: type: string description: >- Country filter on port-pulse. Accepts a country name, ISO-2, or ISO-3 (e.g. `Ukraine`, `UA`, `UKR`) via the shared `resolveCountryInput` layer; an unresolvable value returns `400 INVALID_COUNTRY`. - name: search in: query required: false schema: type: string description: Case-insensitive match on port name, alternate name, or UN/LOCODE. - name: lng_terminal in: query required: false schema: type: boolean description: true → only ports with an LNG terminal. - name: oil_terminal in: query required: false schema: type: boolean description: true → only ports with an oil terminal. - name: near in: query required: false schema: type: string description: >- Point 'lat,lon' for a radius search; combine with radius_km (default 200). - name: near_gem_id in: query required: false schema: type: string description: >- GEM energy-asset gem_id — scope to ports within radius_km of that asset (cross-source join). - name: radius_km in: query required: false schema: type: number description: Radius in km for near / near_gem_id. Default 200; clamped 1–2000. - name: days in: query required: false schema: type: integer minimum: 1 maximum: 30 default: 14 description: GDELT event window in days (1–30). Defaults to 14. - name: event_radius_km in: query required: false schema: type: number minimum: 5 maximum: 500 default: 50 description: >- How close an event must be to a port to count it (5–500 km). Defaults to 50. - name: limit in: query required: false schema: type: integer default: 20 minimum: 1 maximum: 50 description: Number of ports to score (1–50). Defaults to 20. responses: '200': description: >- Risk-ranked ports with their pulse. Each row: port_id, name, unlocode, country, lat, lon, harbor_size, lng_terminal / oil_terminal, relevant_events, conflict_events, events_last_7d, anomaly_ratio, energy_exposure, pulse_level, ais_coverage, and up to 3 recent_events. A summary block totals the window. content: application/json: schema: type: object properties: success: type: boolean data: type: array items: type: object properties: port_id: type: string name: type: string unlocode: type: string nullable: true country: type: string country_name: type: string lat: type: number lon: type: number harbor_size: type: string lng_terminal: type: boolean oil_terminal: type: boolean relevant_events: type: integer conflict_events: type: integer events_last_7d: type: integer anomaly_ratio: type: number nullable: true description: >- Last-7d event volume vs the windowed weekly baseline; null when there is no baseline. energy_exposure: type: object properties: assets_nearby: type: integer state_owned: type: integer sanctions: type: integer china: type: integer pulse_level: type: string enum: - critical - elevated - active - quiet ais_coverage: type: string recent_events: type: array items: type: object properties: headline: type: string family: type: string event_date: type: string distance_km: type: integer cluster_id: type: string cluster_date: type: string summary: type: object properties: ports: type: integer window_days: type: integer event_radius_km: type: number ports_with_conflict: type: integer ports_active: type: integer applied_filters: type: object properties: country: type: string days: type: integer event_radius_km: type: number ignored: type: object properties: {} examples: example: summary: >- GET /api/v2/maritime/port-pulse?country=UKR — example response value: success: true data: - port_id: UAODS name: Odesa unlocode: UAODS country: UKR country_name: Ukraine lat: 46.49 lon: 30.74 harbor_size: Medium lng_terminal: false oil_terminal: true relevant_events: 37 conflict_events: 12 events_last_7d: 9 anomaly_ratio: 1.35 energy_exposure: assets_nearby: 2 state_owned: 1 sanctions: 0 china: 0 pulse_level: critical ais_coverage: no_ais recent_events: - headline: Port infrastructure struck in overnight attack family: conflict event_date: '2026-06-13' distance_km: 4 cluster_id: c_abc123 cluster_date: '2026-06-13' summary: ports: 6 window_days: 14 event_radius_km: 60 ports_with_conflict: 4 ports_active: 5 applied_filters: country: UKR days: 14 event_radius_km: 60 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_...`.' ````