> ## 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. # Ports reference > The open-data ports reference (NGA World Port Index) — ~3,800 ports with coordinates, UN/LOCODE, harbor size/type/use, max vessel draft, channel depth, and container / oil / LNG terminal facilities. Filter by country, harbor size, terminal type, name, or proximity to a point / GEM energy asset. This is reference data (no date window). Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above. When a proximity center is set (`near`, `near_gem_id`), each row carries `distance_km` and results sort nearest-first. Standard envelope: `{ success, data, pagination, applied_filters }`. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/maritime/ports 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/ports: get: tags: - Maritime summary: Ports reference description: >- The open-data ports reference (NGA World Port Index) — ~3,800 ports with coordinates, UN/LOCODE, harbor size/type/use, max vessel draft, channel depth, and container / oil / LNG terminal facilities. Filter by country, harbor size, terminal type, name, or proximity to a point / GEM energy asset. This is reference data (no date window). Requires a plan with Maritime intelligence access (`can_use_maritime`) — the Corporate & Supply Chain plan and above. When a proximity center is set (`near`, `near_gem_id`), each row carries `distance_km` and results sort nearest-first. Standard envelope: `{ success, data, pagination, applied_filters }`. operationId: list-maritime-ports-v2 parameters: - name: search in: query required: false schema: type: string description: Case-insensitive match on port name, alternate name, or UN/LOCODE. - name: country in: query required: false schema: type: string description: >- Country filter on ports. Accepts a country name, ISO-2, or ISO-3 (e.g. `Netherlands`, `NL`, `NLD`) via the shared `resolveCountryInput` layer; an unresolvable value returns `400 INVALID_COUNTRY`. - name: min_harbor_size in: query required: false schema: type: string enum: - very_small - small - medium - large description: Minimum harbor size (inclusive of larger sizes). - 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 100). Results carry distance_km, sorted nearest-first. - name: near_gem_id in: query required: false schema: type: string description: >- GEM energy-asset gem_id — returns ports within radius_km of that LNG terminal / platform / port (cross-source join). - name: radius_km in: query required: false schema: type: number description: Radius in km for near / near_gem_id. Default 100; clamped 1–2000. - name: bbox in: query required: false schema: type: string description: >- Bounding box filter: minLon,minLat,maxLon,maxLat (lon-first, e.g. -6,35,5,44). - 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 ports. Each row: port_id, name, alt_name, unlocode, country (ISO-3), country_name, region, water_body, lat, lon, harbor_size, harbor_type, harbor_use, max_vessel_draft_m, channel_depth_m, lng_terminal / oil_terminal / container booleans, and distance_km (only when a proximity center is set). content: application/json: schema: type: object properties: success: type: boolean data: type: array items: type: object properties: port_id: type: string name: type: string alt_name: type: string nullable: true unlocode: type: string nullable: true country: type: string nullable: true country_name: type: string region: type: string water_body: type: string lat: type: number lon: type: number harbor_size: type: string harbor_type: type: string harbor_use: type: string max_vessel_draft_m: type: number channel_depth_m: type: number lng_terminal: type: boolean oil_terminal: type: boolean container: type: boolean distance_km: type: number pagination: type: object properties: limit: type: integer cursor: {} next_cursor: {} applied_filters: type: object properties: search: type: string country: type: string min_harbor_size: type: string ignored: type: object properties: {} examples: example: summary: >- GET /api/v2/maritime/ports?lng_terminal=true — example response value: success: true data: - port_id: NLRTM name: Rotterdam alt_name: Rotterdam unlocode: NLRTM country: NLD country_name: Netherlands region: Western Europe water_body: North Sea lat: 51.95 lon: 4.14 harbor_size: Large harbor_type: Coastal Natural harbor_use: Commercial max_vessel_draft_m: 24.4 channel_depth_m: 24.4 lng_terminal: true oil_terminal: true container: true pagination: limit: 100 cursor: null next_cursor: null applied_filters: 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_...`.' ````