openapi: 3.0.2
info:
title: MarineTraffic AIS Data API
description: Complete MarineTraffic AIS Data API covering vessel positions, events, vessels data, voyage information, ports
information, routing, reverse geocoding, and power-user fleet/balance services. Backed by 13,000+ AIS receivers operated
by Kpler / MarineTraffic.
version: 1.0.0
license:
name: Property of Kpler
url: https://www.kpler.com/product/maritime/data-services
x-logo:
url: https://www.marinetraffic.com/img/logos/Logo.png
altText: MarineTraffic logo
href: https://www.marinetraffic.com/en/ais/home/centerx:-12.0/centery:25.0/zoom:4
contact:
name: MarineTraffic
url: https://www.marinetraffic.com/
servers:
- url: https://services.marinetraffic.com/api
tags:
- name: Containers API
description: 'MarineTraffic Containers API is your way to access state-of-the-art real-time visibility
for container logistics.
Container Intelligence API
Insights on near real-time terminal congestion, container vessels scheduled and actual calls.
- Vessel schedules / actual calls: Waiting time, stay time, arrival and departure details.
- Terminal Live Congestion: Vessels currently waiting, currently at berth and congestion index.
- Terminal Performance Metrics: 7d average waiting and stay times, performance index.
- Carrier / Services Information: List of carriers operating at the terminal and their services.
Container Tracking API
Keep track of your shipments / containers from a bill of lading, booking number or container number.
For more info visit related documentation
pages.
'
x-trailTag: true
- name: MT Inbox
description: "This solution allows you to use MTInbox api to : Notes\n
- Upload attachment
\n\
\ - Get information of the current user
\n - Compose and send email
\n - Get accessible lines\
\ information
\n - Get Address book contact details
\nFor more info visit related documentation pages.\n"
x-trailTag: true
paths:
/exportvesseltrack/{api_key}:
get:
tags:
- Vessel Historical Track
summary: Single Vessel Historical Positions
description: "Get all historical positions of a single vessel for a specific period of time. Notes\
\ \n - Default resolution for returned positions is up to 2 minutes. Use \"period\" parameter to limit the\
\ frequency of positions
\n - Weather data is returned once within each hour's results
\n - Information\
\ about AIS-transmitted data
\n - **SPEED** speed over ground returned in (knots x10)
\n - **TIMESTAMP**\
\ UTC second when the report was generated (0-59)
\n - Historical positions are available since January 2015
\n\
\ - **Hourly** and **daily** records are the first records received during the hour or the day respectively
\n\
\ - When the **period** is **hourly**, the data field **HEADING** is not available for positions older than 2017-11-17
\n\
\ - **Hourly** records are available for dates after 2014-08-28
\n - Weather data for **winds** are\
\ available for dates after 2015-05-27
\n - Weather data for **waves**, **swells** and **currents** are available\
\ for dates after 2021-01-21
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvesseltrack
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS01'
- $ref: '#/components/parameters/shipid_PS01'
- $ref: '#/components/parameters/mmsi_PS01'
- $ref: '#/components/parameters/imo_PS01'
- $ref: '#/components/parameters/days_PS01'
- $ref: '#/components/parameters/fromdate_PS01'
- $ref: '#/components/parameters/todate_PS01'
- $ref: '#/components/parameters/period_PS01'
- $ref: '#/components/parameters/msgtype_PS01'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps01_default'
- $ref: '#/components/schemas/200_ps01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps01_default'
- $ref: '#/components/schemas/200_ps01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n \n"
Extended:
summary: Extended
value: "\n\n \n\
\ \n \n \n \n \n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ps01_days_out_of_limit'
- $ref: '#/components/schemas/400_ps01_missing_ship_identifier'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ps01_days_out_of_limit'
- $ref: '#/components/schemas/400_ps01_missing_ship_identifier'
examples:
Days out of limit:
summary: Days out of limit
value: "\n\n \n \n \n"
Missing ship identifier:
summary: Missing ship identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportvesseltrack/{api_key} ':
get:
tags:
- Vessel Historical Track
summary: Vessel Historical Positions in an Area
description: "Get vessel historical positions for a single or for all vessels inside an area of your preference for\
\ a specific period of time.\n \nNotes \n - Default resolution for returned positions\
\ is up to 2 minutes. Use \"period\" parameter to limit the frequency of positions
\n - Weather data is returned\
\ once within each hour's results
\n - Information about AIS-transmitted data
\n - **SPEED** speed over ground returned in (knots x10)
\n - **TIMESTAMP**\
\ UTC second when the report was generated (0-59)
\n - Historical positions are available since January 2015
\n\
\ - **Hourly** and **daily** records are the first records received during the hour or the day respectively
\n\
\ - When the **period** is **hourly**, the data field **HEADING** is not available for positions older than 2017-11-17
\n\
\ - **Hourly** records are available for dates after 2014-08-28
\n - Weather data for **winds** are\
\ available for dates after 2015-05-27
\n - Weather data for **waves**, **swells** and **currents** are available\
\ for dates after 2021-01-21
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvesseltrack_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS01'
- $ref: '#/components/parameters/days_PS01'
- $ref: '#/components/parameters/fromdate_PS01'
- $ref: '#/components/parameters/todate_PS01'
- $ref: '#/components/parameters/MINLAT_PS01'
- $ref: '#/components/parameters/MAXLAT_PS01'
- $ref: '#/components/parameters/MINLON_PS01'
- $ref: '#/components/parameters/MAXLON_PS01'
- $ref: '#/components/parameters/shipid_PS01_2'
- $ref: '#/components/parameters/mmsi_PS01'
- $ref: '#/components/parameters/imo_PS01'
- $ref: '#/components/parameters/period_PS01'
- $ref: '#/components/parameters/msgtype_PS01'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps01_default'
- $ref: '#/components/schemas/200_ps01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps01_default'
- $ref: '#/components/schemas/200_ps01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n \n\
\ \n \n \n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_ps01_area_out_of_bound'
application/xml:
schema:
$ref: '#/components/schemas/400_ps01_area_out_of_bound'
examples:
Area out of bound:
summary: Area out of bound
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportvessels/{api_key}:
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions of a Static Fleet
description: "Keep a close eye on the vessel or group of vessels of your interest. Notes \n \
\ - Information about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS02'
- $ref: '#/components/parameters/timespan_PS02'
- $ref: '#/components/parameters/shiptype_PS02'
- $ref: '#/components/parameters/msgtype_PS02'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps02_default'
- $ref: '#/components/schemas/200_ps02_extended'
- $ref: '#/components/schemas/200_ps02_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps02_default'
- $ref: '#/components/schemas/200_ps02_extended'
- $ref: '#/components/schemas/200_ps02_full'
examples:
Default:
summary: Simple
value: "\n\n \n \
\
\n
"
Extended:
summary: Extended
value: "\n\n \n \n
"
Full:
summary: Full
value: "\n\n
\n \n
"
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/403_ps02_infinite_timespan'
application/xml:
schema:
$ref: '#/components/schemas/403_ps02_infinite_timespan'
examples:
Infinite timespan:
summary: Infinite timespan
value: "\n\n \n \
\ \n \n"
'/exportvessels/{api_key} ':
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions of a Dynamic Fleet
description: "Monitor vessel activity for your MarineTraffic fleet(s). Notes \n - Information\
\ about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels__
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS03'
- $ref: '#/components/parameters/timespan_PS03'
- $ref: '#/components/parameters/shiptype_PS03'
- $ref: '#/components/parameters/msgtype_PS03'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps03_default'
- $ref: '#/components/schemas/200_ps03_extended'
- $ref: '#/components/schemas/200_ps03_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps03_default'
- $ref: '#/components/schemas/200_ps03_extended'
- $ref: '#/components/schemas/200_ps03_full'
examples:
Default:
summary: Simple
value: "\n\n \n \
\
\n \n
"
Extended:
summary: Extended
value: "\n\n \n \n
"
Full:
summary: Full
value: "\n\n
\n \n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportvessels/{api_key} ':
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions Within a Port
description: "Monitor vessel activity in one or more ports of your interest. Notes \n - Information\
\ about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels___
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS04'
- $ref: '#/components/parameters/timespan_PS04'
- $ref: '#/components/parameters/shiptype_PS04'
- $ref: '#/components/parameters/msgtype_PS04'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps04_default'
- $ref: '#/components/schemas/200_ps04_extended'
- $ref: '#/components/schemas/200_ps04_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps04_default'
- $ref: '#/components/schemas/200_ps04_extended'
- $ref: '#/components/schemas/200_ps04_full'
examples:
Default:
summary: Simple
value: "\n\n \n \n \
\
\n
\n
\n
"
Extended:
summary: Extended
value: "\n\n \n \n
\n
\n \n
"
Full:
summary: Full
value: "\n\n \n
\n \n \n
\n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportvessels/{api_key} ':
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions in a Predefined Bounding Box
description: "Monitor vessel activity in an area of your interest. Notes \n - Information\
\ about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels____
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS05'
- $ref: '#/components/parameters/timespan_PS05'
- $ref: '#/components/parameters/shiptype_PS05'
- $ref: '#/components/parameters/msgtype_PS05'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps05_default'
- $ref: '#/components/schemas/200_ps05_extended'
- $ref: '#/components/schemas/200_ps05_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps05_default'
- $ref: '#/components/schemas/200_ps05_extended'
- $ref: '#/components/schemas/200_ps05_full'
examples:
Default:
summary: Simple
value: "\n\n \n \n \
\
\n \n \n
"
Extended:
summary: Extended
value: "\n\n \n
\n \n \n \n
"
Full:
summary: Full
value: "\n\n \n
\n \n
\n \n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportvessels/{api_key} ':
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions in a Dynamic Bounding Box
description: "Retrieve positions for vessels sailing in an area that you define each time you call the service. \
\ Notes \n - Information about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels_____
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS06'
- $ref: '#/components/parameters/timespan_PS06'
- $ref: '#/components/parameters/shiptype_PS06'
- $ref: '#/components/parameters/MAXLAT_PS06'
- $ref: '#/components/parameters/MINLON_PS06'
- $ref: '#/components/parameters/MAXLON_PS06'
- $ref: '#/components/parameters/MINLAT_PS06'
- $ref: '#/components/parameters/protocol'
- $ref: '#/components/parameters/msgtype_PS06'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps06_default'
- $ref: '#/components/schemas/200_ps06_extended'
- $ref: '#/components/schemas/200_ps06_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps06_default'
- $ref: '#/components/schemas/200_ps06_extended'
- $ref: '#/components/schemas/200_ps06_full'
examples:
Default:
summary: Simple
value: "\n\n \n \n\
\
\n \n \n
"
Extended:
summary: Extended
value: "\n\n \n \n \n
\n
\n
"
Full:
summary: Full
value: "\n\n
\n \n \n
\n \n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportvessel/{api_key}:
get:
tags:
- Vessel Positions (Legacy API)
summary: Single Vessel Positions
description: "Get the latest available position and voyage information for a particular vessel. Notes\
\ \n - Information about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and TIMESTAMP in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessel
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS07'
- $ref: '#/components/parameters/shipid_PS07'
- $ref: '#/components/parameters/imo_PS07'
- $ref: '#/components/parameters/mmsi_PS07'
- $ref: '#/components/parameters/timespan_PS07'
- $ref: '#/components/parameters/msgtype_PS07'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps07_default'
- $ref: '#/components/schemas/200_ps07_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps07_default'
- $ref: '#/components/schemas/200_ps07_extended'
examples:
Default:
summary: Simple
value: "\n\n \n
"
Extended:
summary: Extended
value: "\n\n \n\
"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_ps07__missing_ship_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_ps07__missing_ship_identifier'
examples:
' Missing ship identifier':
summary: ' Missing ship identifier'
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportvessels-custom-area/{api_key}:
get:
tags:
- Vessel Positions (Legacy API)
summary: Vessel Positions in a Custom Area
description: "Monitor vessel activity in a Custom Area of your interest. Notes \n - Information\
\ about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - **HEADING**\
\ for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **HEADING** values -1 or 511\
\ indicate lack of data
\n - **SPEED** and **COURSE** values for base stations are represented by zero (0)
\n\
\ - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels-custom-area
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PS08'
- $ref: '#/components/parameters/timespan_PS08'
- $ref: '#/components/parameters/shiptype_generic_PS08'
- $ref: '#/components/parameters/shiptype_detailed_PS08'
- $ref: '#/components/parameters/msgtype_PS08'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps08_default'
- $ref: '#/components/schemas/200_ps08_extended'
- $ref: '#/components/schemas/200_ps08_full'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ps08_default'
- $ref: '#/components/schemas/200_ps08_extended'
- $ref: '#/components/schemas/200_ps08_full'
examples:
Default:
summary: Simple
value: "\n\n \n \n \
\
\n \n \n
"
Extended:
summary: Extended
value: "\n\n \n
\n \n \n \n
"
Full:
summary: Full
value: "\n\n \n
\n \n
\n \n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportvessels/{api_key} ':
get:
tags:
- AIS API
summary: Vessel Positions
description: "The latest version of this API endpoint, including significant improvements, is available here.Please contact your Customer Success Manager to request access to the new endpoint.\n\
Track vessels of interest anywhere in the world.Notes\n - Information about AIS-transmitted data
\n - **SPEED** speed over ground returned in (knots x10)
\n - **SPEED**\
\ and **COURSE** values for base stations are represented by zero (0)
\n - **TIMESTAMP** UTC second when\
\ the report was generated (0-59)
\n - **HEADING** true heading in degrees (0-359) (values -1 or 511 indicate\
\ lack of data)
\n - **HEADING** for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n\
\ - **DSRC** describes whether the transmitted AIS message was received by a terrestrial (TER), satellite (SAT)\
\ or roaming (ROAM) AIS antenna.
\n - The timespan parameter lets you specify how far back in time\
\ the API should look for the latest available vessel positions. Default value is set to 5 minutes and can be adjusted\
\ to a maximum of 1,440 minutes (24 hours).
\n - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels______
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_MTA030AD_1'
- $ref: '#/components/parameters/timespan_MTA030AD'
- $ref: '#/components/parameters/vessel_type'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/protocol_mandatory'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_MTA030AD'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
'/exportvessels-custom-area/{api_key} ':
get:
tags:
- AIS API
summary: Vessel Positions in an Area of Interest
description: "The latest version of this API endpoint, including significant improvements, is available here.Please contact your Customer Success Manager to request access to the new endpoint.\n\
Track Vessels of interest in a predefined area of interest.Notes\n - Information about AIS-transmitted\
\ data
\n - **SPEED** speed over ground returned in (knots x10)
\n - **SPEED** and **COURSE**\
\ values for base stations are represented by zero (0)
\n - **TIMESTAMP** UTC second when the report was\
\ generated (0-59)
\n - **HEADING** true heading in degrees (0-359) (values -1 or 511 indicate lack of data)
\n\
\ - **HEADING** for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n - **DSRC**\
\ describes whether the transmitted AIS message was received by a terrestrial (TER), satellite (SAT) or roaming (ROAM)\
\ AIS antenna.
\n - The timespan parameter lets you specify how far back in time the API should look\
\ for the latest available vessel positions. Default value is set to 5 minutes and can be adjusted to a maximum of\
\ 1,440 minutes (24 hours).
\n - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessels-custom-area_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_MTA030AD_2'
- $ref: '#/components/parameters/timespan_MTA030AD'
- $ref: '#/components/parameters/vessel_type'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/protocol_mandatory'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_MTA030AD'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
'/exportvessel/{api_key} ':
get:
tags:
- AIS API
summary: Single Vessel Positions
description: "The latest version of this API endpoint, including significant improvements, is available here.Please contact your Customer Success Manager to request access to the new endpoint.\n\
Get the latest available position and voyage information for a single vessel.Notes\n - Information\
\ about AIS-transmitted data
\n - **SPEED** speed over ground returned in (knots x10)
\n - **SPEED**\
\ and **COURSE** values for base stations are represented by zero (0)
\n - **TIMESTAMP** UTC second when\
\ the report was generated (0-59)
\n - **HEADING** true heading in degrees (0-359) (values -1 or 511 indicate\
\ lack of data)
\n - **HEADING** for SAR Aircrafts contains the Altitude of the aircraft (“STATUS” = 97)
\n\
\ - **DSRC** describes whether the transmitted AIS message was received by a terrestrial (TER), satellite (SAT)\
\ or roaming (ROAM) AIS antenna.
\n - The timespan parameter lets you specify how far back in time\
\ the API should look for the latest available vessel positions. Default value is set to 5 minutes and can be adjusted\
\ to a maximum of 1,440 minutes (24 hours).
\n - More information about response parameters: STATUS, SHIPTYPE
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: exportvessel_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_MTA030AD_3'
- $ref: '#/components/parameters/shipid_PS07'
- $ref: '#/components/parameters/imo_PS07'
- $ref: '#/components/parameters/mmsi_PS07'
- $ref: '#/components/parameters/timespan_MTA030AD'
- $ref: '#/components/parameters/protocol_mandatory'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_MTA030AD_single'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_ps07__missing_ship_identifier'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
/portcalls/{api_key}:
get:
tags:
- Single Vessel Events
summary: Single Vessel Port Calls
description: "Retrieve arrival and departure information of a vessel for a specific period of time. Notes\
\ \n - Data is available for dates **after** 2015-01-16
\n - Information about AIS-transmitted data
\n - **MOVE_TYPE** values: 1=Departure, 0=Arrival
\n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: portcalls
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_EV01'
- $ref: '#/components/parameters/shipid_EV01'
- $ref: '#/components/parameters/mmsi_EV01'
- $ref: '#/components/parameters/imo_EV01'
- $ref: '#/components/parameters/timespan_EV01'
- $ref: '#/components/parameters/movetype_EV01'
- $ref: '#/components/parameters/exclude_intransit_EV01'
- $ref: '#/components/parameters/fromdate_EV01'
- $ref: '#/components/parameters/todate_EV01'
- $ref: '#/components/parameters/dwt_min_EV01'
- $ref: '#/components/parameters/dwt_max_EV01'
- $ref: '#/components/parameters/gt_min_EV01'
- $ref: '#/components/parameters/gt_max_EV01'
- $ref: '#/components/parameters/market_EV01'
- $ref: '#/components/parameters/msgtype_EV01'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev01_default'
- $ref: '#/components/schemas/200_ev01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev01_default'
- $ref: '#/components/schemas/200_ev01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev01_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev01_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev01_polling_range_out_of_limit'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev01_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev01_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev01_polling_range_out_of_limit'
examples:
Date range out of bounds:
summary: Date range out of bounds
value: "\n\n \n \
\ \n \n"
Missing ship identifier:
summary: Missing ship identifier
value: "\n\n \n \
\ \n \
\ \n"
Polling range out of limit:
summary: Polling range out of limit
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/vesselevents/{api_key}:
get:
tags:
- Single Vessel Events
summary: Single Vessel Events
description: "Get event based intelligence for a vessel. Notes \n - Here is a COMPLETE\
\ LIST OF EVENT TYPES available for this endpoint. You can use these as values for the **event_type** query parameter.\
\
\n - Information about AIS-transmitted data
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
"
operationId: vesselevents
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_EV02'
- $ref: '#/components/parameters/shipid_EV02'
- $ref: '#/components/parameters/mmsi_EV02'
- $ref: '#/components/parameters/imo_EV02'
- $ref: '#/components/parameters/timespan_EV02'
- $ref: '#/components/parameters/fromdate_EV02'
- $ref: '#/components/parameters/todate_EV02'
- $ref: '#/components/parameters/event_type_EV02'
- $ref: '#/components/parameters/limit_events_EV02'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_ev02_default'
application/xml:
schema:
$ref: '#/components/schemas/200_ev02_default'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n\
\ \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev02_invalid_date_range'
- $ref: '#/components/schemas/400_ev02_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev02_polling_range_out_of_limit'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev02_invalid_date_range'
- $ref: '#/components/schemas/400_ev02_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev02_polling_range_out_of_limit'
examples:
Invalid date range:
summary: Invalid date range
value: "\n\n \n \
\ \n \n"
Missing ship identifier:
summary: Missing ship identifier
value: "\n\n \n \
\ \n \
\ \n"
Polling range out of limit:
summary: Polling range out of limit
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/berth-calls/{api_key}:
get:
tags:
- Single Vessel Events
summary: Single Vessel Berth Calls
description: "Get berth arrival and departure information for a specific vessel. Notes \n - Data\
\ is available for dates **after** 2017-07-03
\n - Information about AIS-transmitted data
\n - More information about input parameters: MARKET, SHIPCLASS
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: berth-calls
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_EV03'
- $ref: '#/components/parameters/shipid_EV03'
- $ref: '#/components/parameters/mmsi_EV03'
- $ref: '#/components/parameters/imo_EV03'
- $ref: '#/components/parameters/timespan_EV03'
- $ref: '#/components/parameters/fromdate_EV03'
- $ref: '#/components/parameters/todate_EV03'
- $ref: '#/components/parameters/market_EV03'
- $ref: '#/components/parameters/shipclass_EV03'
- $ref: '#/components/parameters/dwt_min_EV03'
- $ref: '#/components/parameters/dwt_max_EV03'
- $ref: '#/components/parameters/gt_min_EV03'
- $ref: '#/components/parameters/gt_max_EV03'
- $ref: '#/components/parameters/movetype_EV03'
- $ref: '#/components/parameters/protocol_new'
- $ref: '#/components/parameters/msgtype_EV03'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev03_default'
- $ref: '#/components/schemas/200_ev03_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev03_default'
- $ref: '#/components/schemas/200_ev03_extended'
examples:
Default:
summary: Simple
value: "\n\n \n\
"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev03_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev03_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev03_polling_range_out_of_limit'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev03_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev03_missing_ship_identifier'
- $ref: '#/components/schemas/400_ev03_polling_range_out_of_limit'
examples:
Date range out of bounds:
summary: Date range out of bounds
value: "\n\n \n \
\ \n \n"
Missing ship identifier:
summary: Missing ship identifier
value: "\n\n \n \
\ \n \n"
Polling range out of limit:
summary: Polling range out of limit
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/portcalls/{api_key} ':
get:
tags:
- Port Events
summary: Port Calls
description: "Retrieve arrival and departure information at a specific port for a specific period of time. \
\ Notes \n - Data is available for dates **after** 2015-01-16
\n - Information about AIS-transmitted\
\ data
\n - **MOVE_TYPE** values: 1=Departure, 0=Arrival
\n - The frequency of allowed API\
\ calls is specific to your API key and is detailed in your contract as a number of successful calls per time\
\ period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted\
\ to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
\n\
"
operationId: portcalls_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_EV01'
- $ref: '#/components/parameters/portid_EV01'
- $ref: '#/components/parameters/timespan_EV01'
- $ref: '#/components/parameters/movetype_EV01'
- $ref: '#/components/parameters/exclude_intransit_EV01'
- $ref: '#/components/parameters/fromdate_EV01'
- $ref: '#/components/parameters/todate_EV01'
- $ref: '#/components/parameters/dwt_min_EV01'
- $ref: '#/components/parameters/dwt_max_EV01'
- $ref: '#/components/parameters/gt_min_EV01'
- $ref: '#/components/parameters/gt_max_EV01'
- $ref: '#/components/parameters/market_EV01'
- $ref: '#/components/parameters/msgtype_EV01'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev01_default'
- $ref: '#/components/schemas/200_ev01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev01_default'
- $ref: '#/components/schemas/200_ev01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev01_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev01_missing_port_identifier'
- $ref: '#/components/schemas/400_ev01_polling_range_out_of_limit'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev01_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev01_missing_port_identifier'
- $ref: '#/components/schemas/400_ev01_polling_range_out_of_limit'
examples:
Date range out of bounds:
summary: Date range out of bounds
value: "\n\n \n \
\ \n \n"
Missing port identifier:
summary: Missing port identifier
value: "\n\n \n \
\ \n \
\ \n"
Polling range out of limit:
summary: Polling range out of limit
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/berth-calls/{api_key} ':
get:
tags:
- Port Events
summary: Berth Calls
description: "Retrieve arrival and departure information at a specific port, berth or terminal, for a specific period\
\ of time. Notes \n - Data is available for dates **after** 2017-07-03
\n - Information\
\ about AIS-transmitted data
\n - More information about input parameters: MARKET, SHIPCLASS
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: berth-calls_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_EV03'
- $ref: '#/components/parameters/portid_EV03'
- $ref: '#/components/parameters/port_unlocode_EV03'
- $ref: '#/components/parameters/berthid_EV03'
- $ref: '#/components/parameters/terminalid_EV03'
- $ref: '#/components/parameters/timespan_EV03'
- $ref: '#/components/parameters/fromdate_EV03'
- $ref: '#/components/parameters/todate_EV03'
- $ref: '#/components/parameters/market_EV03'
- $ref: '#/components/parameters/shipclass_EV03'
- $ref: '#/components/parameters/dwt_min_EV03'
- $ref: '#/components/parameters/dwt_max_EV03'
- $ref: '#/components/parameters/gt_min_EV03'
- $ref: '#/components/parameters/gt_max_EV03'
- $ref: '#/components/parameters/movetype_EV03'
- $ref: '#/components/parameters/protocol_new'
- $ref: '#/components/parameters/msgtype_EV03'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev03_default'
- $ref: '#/components/schemas/200_ev03_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_ev03_default'
- $ref: '#/components/schemas/200_ev03_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev03_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev03_missing_port_identifier'
- $ref: '#/components/schemas/400_ev03_polling_range_out_of_limit'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_ev03_date_range_out_of_bounds'
- $ref: '#/components/schemas/400_ev03_missing_port_identifier'
- $ref: '#/components/schemas/400_ev03_polling_range_out_of_limit'
examples:
Date range out of bounds:
summary: Date range out of bounds
value: "\n\n \n \
\ \n \n"
Missing port identifier:
summary: Missing port identifier
value: "\n\n \n \
\ \n \n"
Polling range out of limit:
summary: Polling range out of limit
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportvesselphoto/{api_key}:
get:
tags:
- Vessel Information
summary: Vessel Photo
description: "Retrieve the most popular photo of a vessel. Notes \n - The frequency of\
\ allowed API calls is specific to your API key and is detailed in your contract as a number of successful calls\
\ per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: exportvesselphoto
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/vessel_id_VD01'
- $ref: '#/components/parameters/shipid_VD01'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vd01_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vd01_default'
examples:
Default:
summary: Simple
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vd01_missing_or_invalid_ship_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vd01_missing_or_invalid_ship_identifier'
examples:
Missing or invalid ship identifier:
summary: Missing or invalid ship identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/vesselmasterdata/{api_key}:
get:
tags:
- Vessel Information
summary: Vessel Particulars (Legacy API)
description: "⚠️This is a legacy endpoint.\nA new and improved version is now available, offering enhanced\
\ data quality, latest features and better performance. \nWe strongly recommend switching to the latest version, which\
\ you can explore here: Vessel\
\ Particulars & Ownership.\nIf you would like to see the new endpoint in action, feel free to request a demo - our team would be happy to\
\ walk you through it.\nRetrieve particulars for one or more vessels. Notes \n \
\ - Information about AIS-transmitted data
\n - If page parameter is missing, then default page:1 will be used instead
\n\
\ - The results returned from the API call are split into pages of 100 rows
\n - In order to get each\
\ page generated by the call, add the /page:#value/ parameter to the URL. The default value is /page:1/
\n \
\ - The API does not return results for vessels that are not IMO-registered
\n - The API does not return\
\ results for dead vessels
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: vesselmasterdata
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VD02'
- $ref: '#/components/parameters/mmsi_VD02'
- $ref: '#/components/parameters/imo_VD02'
- $ref: '#/components/parameters/shipid_VD02'
- $ref: '#/components/parameters/timespan_VD02'
- $ref: '#/components/parameters/interval_VD02'
- $ref: '#/components/parameters/protocol'
- $ref: '#/components/parameters/page_VD02'
- $ref: '#/components/parameters/msgtype_VD02'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vd02_default'
- $ref: '#/components/schemas/200_vd02_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vd02_default'
- $ref: '#/components/schemas/200_vd02_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vd02_missing_or_invalid_ship_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vd02_missing_or_invalid_ship_identifier'
examples:
Missing or invalid ship identifier:
summary: Missing or invalid ship identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/shipsearch/{api_key}:
get:
tags:
- Search Vessel
summary: Search Vessel by Identifier
description: "Search for a vessel by unique identifier. Notes \n - The frequency of allowed\
\ API calls is specific to your API key and is detailed in your contract as a number of successful calls per time\
\ period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted\
\ to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
\n\
"
operationId: shipsearch
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/shipid_VD03'
- $ref: '#/components/parameters/mmsi_VD03'
- $ref: '#/components/parameters/imo_VD03'
- $ref: '#/components/parameters/shiptype_VD03'
- $ref: '#/components/parameters/type_name_id_VD03'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vd03_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vd03_default'
examples:
Default:
summary: Simple
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vd03_missing_search_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vd03_missing_search_identifier'
examples:
Missing search identifier:
summary: Missing search identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/shipsearch/{api_key} ':
get:
tags:
- Search Vessel
summary: Search Vessel by Name
description: "Search for vessels by vessel name. Notes In case of multiple results:\n \n\
\ - the first 100 matches will be fetched
\n - exact matches are always first on the returned list
\n\
\
\n \n \n - Only active vessels are returned
\n - The frequency of allowed API\
\ calls is specific to your API key and is detailed in your contract as a number of successful calls per time\
\ period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted\
\ to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
\n\
\
"
operationId: shipsearch_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/shipname_VD03'
- $ref: '#/components/parameters/shiptype_VD03'
- $ref: '#/components/parameters/type_name_id_VD03'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vd03_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vd03_default'
examples:
Default:
summary: Simple
value: "\n \n \n \n \
\ \n \n \n \n \n \
\ "
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_vd03_invalid_search_string_length'
- $ref: '#/components/schemas/400_vd03_missing_search_term'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_vd03_invalid_search_string_length'
- $ref: '#/components/schemas/400_vd03_missing_search_term'
examples:
Invalid search string length:
summary: Invalid search string length
value: "\n\n \n \
\ \n \n"
Missing search term:
summary: Missing search term
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/voyageforecast/{api_key} ':
get:
tags:
- Voyage Information
summary: Single Vessel Voyage Forecast
description: "Get voyage information for a single vessel. Notes \n - Information about AIS-transmitted\
\ data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: voyageforecast_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VI01'
- $ref: '#/components/parameters/mmsi_VI01'
- $ref: '#/components/parameters/imo_VI01'
- $ref: '#/components/parameters/shipid_VI01'
- $ref: '#/components/parameters/msgtype_VI01'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi01_default'
- $ref: '#/components/schemas/200_vi01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi01_default'
- $ref: '#/components/schemas/200_vi01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi01_missing_or_invalid_ship_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi01_missing_or_invalid_ship_identifier'
examples:
Missing or invalid ship identifier:
summary: Missing or invalid ship identifier
value: "\n\n \n \
\ \n \
\ \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/voyageforecast/{api_key}:
get:
tags:
- Voyage Information
summary: Fleet Voyage Forecast
description: "Get voyage information for one for your MarineTraffic Fleets. Notes \n - Information\
\ about AIS-transmitted data
\n - **SPEED** returned in (knots x10) and **TIMESTAMP** in UTC
\n - The\
\ frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of\
\ successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API\
\ key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute\
\ to ensure system stability.
\n
"
operationId: voyageforecast
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VI01'
- $ref: '#/components/parameters/fleet_id_VI01'
- $ref: '#/components/parameters/msgtype_VI01'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi01_default'
- $ref: '#/components/schemas/200_vi01_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi01_default'
- $ref: '#/components/schemas/200_vi01_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/404_vi01_invalid_fleet_identifier'
application/xml:
schema:
$ref: '#/components/schemas/404_vi01_invalid_fleet_identifier'
examples:
Invalid fleet identifier:
summary: Invalid fleet identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/predictive-destination-areas/{api_key}:
get:
tags:
- Voyage Information
summary: Single Vessel Predictive Destinations
description: "Receive a prediction of the likely destination of a single vessel. Notes \n - The\
\ frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of\
\ successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API\
\ key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute\
\ to ensure system stability.
\n
"
operationId: predictive-destination-areas
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/mmsi_VI04'
- $ref: '#/components/parameters/imo_VI04'
- $ref: '#/components/parameters/shipid_VI04'
- $ref: '#/components/parameters/fromportid_VI04'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vi04_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vi04_default'
examples:
Default:
summary: Simple
value: "\n\n \
\ \n\
"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi04_missing_or_invalid_ship_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi04_missing_or_invalid_ship_identifier'
examples:
Missing or invalid ship identifier:
summary: Missing or invalid ship identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/predictive-destination-areas/{api_key} ':
get:
tags:
- Voyage Information
summary: Fleet Predictive Destinations
description: "Receive a prediction of the likely destination for one of your MarineTraffic fleets. Notes\
\ \n - The frequency of allowed API calls is specific to your API key and is detailed in your contract\
\ as a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed\
\ limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful)\
\ requests per minute to ensure system stability.
\n
"
operationId: predictive-destination-areas_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/fleet_id_VI04'
- $ref: '#/components/parameters/fromportid_VI04'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vi04_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vi04_default'
examples:
Default:
summary: Simple
value: "\n\n \
\ \n\
"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi04_invalid_fleet_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi04_invalid_fleet_identifier'
examples:
Invalid fleet identifier:
summary: Invalid fleet identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/etatoport/{api_key}:
get:
tags:
- Voyage Information
summary: Vessel ETA to Port
description: "Get ETA and voyage information for a vessel of your choice, to any port you define. Notes\
\ \n - The frequency of allowed API calls is specific to your API key and is detailed in your contract\
\ as a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed\
\ limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful)\
\ requests per minute to ensure system stability.
\n
"
operationId: etatoport
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VI07'
- $ref: '#/components/parameters/portid_VI07'
- $ref: '#/components/parameters/unlocode_VI07'
- $ref: '#/components/parameters/mmsi_VI07'
- $ref: '#/components/parameters/imo_VI07'
- $ref: '#/components/parameters/shipid_VI07'
- $ref: '#/components/parameters/speed_calc_VI07'
- $ref: '#/components/parameters/msgtype_VI07'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi07_default'
- $ref: '#/components/schemas/200_vi07_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi07_default'
- $ref: '#/components/schemas/200_vi07_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_vi07_missing_or_invalid_port_identifier'
- $ref: '#/components/schemas/400_vi07_missing_or_invalid_ship_identifier'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_vi07_missing_or_invalid_port_identifier'
- $ref: '#/components/schemas/400_vi07_missing_or_invalid_ship_identifier'
examples:
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
Missing or invalid ship identifier:
summary: Missing or invalid ship identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/expectedarrivals/{api_key}:
get:
tags:
- Ports Information
summary: Expected Port Arrivals
description: "Get expected arrivals to a specific port. Notes \n - **SPEED** returned in\
\ (knots x10) and **TIMESTAMP** in UTC
\n - Use either **TIMESPAN** or **FROMDATE/TODATE** in order to look\
\ for expected arrivals in a specific date range
\n - Information about AIS-transmitted data
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: expectedarrivals
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VI02'
- $ref: '#/components/parameters/portid_VI02'
- $ref: '#/components/parameters/timespan_VI02'
- $ref: '#/components/parameters/days_last_signal_VI02'
- $ref: '#/components/parameters/fromdate_VI02'
- $ref: '#/components/parameters/todate_VI02'
- $ref: '#/components/parameters/fromportid_VI02'
- $ref: '#/components/parameters/shiptype_VI02'
- $ref: '#/components/parameters/dwt_min_VI02'
- $ref: '#/components/parameters/dwt_max_VI02'
- $ref: '#/components/parameters/gt_min_VI02'
- $ref: '#/components/parameters/gt_max_VI02'
- $ref: '#/components/parameters/msgtype_VI02'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi02_default'
- $ref: '#/components/schemas/200_vi02_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi02_default'
- $ref: '#/components/schemas/200_vi02_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \
\ \n \
\ \n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi02_missing_or_invalid_port_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi02_missing_or_invalid_port_identifier'
examples:
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/expectedarrivals/{api_key} ':
get:
tags:
- Ports Information
summary: Expected Country Arrivals
description: "Get expected arrivals to a specific country. Notes \n - **SPEED** returned\
\ in (knots x10) and **TIMESTAMP** in UTC
\n - Use either **TIMESPAN** or **FROMDATE/TODATE** in order to\
\ look for expected arrivals in a specific date range
\n - Information about AIS-transmitted data
\n - The frequency of allowed API calls is specific to your API key and\
\ is detailed in your contract as a number of successful calls per time period. For example “2 calls per minute”.\
\ Regardless of this agreed limit, each API key is technically restricted to a maximum of 100 total (including\
\ successful and unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: expectedarrivals_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_VI02'
- $ref: '#/components/parameters/country_VI02'
- $ref: '#/components/parameters/timespan_VI02'
- $ref: '#/components/parameters/days_last_signal_VI02'
- $ref: '#/components/parameters/fromdate_VI02'
- $ref: '#/components/parameters/todate_VI02'
- $ref: '#/components/parameters/fromportid_VI02'
- $ref: '#/components/parameters/shiptype_VI02'
- $ref: '#/components/parameters/dwt_min_VI02'
- $ref: '#/components/parameters/dwt_max_VI02'
- $ref: '#/components/parameters/gt_min_VI02'
- $ref: '#/components/parameters/gt_max_VI02'
- $ref: '#/components/parameters/msgtype_VI02'
- $ref: '#/components/parameters/protocol_new'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi02_default'
- $ref: '#/components/schemas/200_vi02_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi02_default'
- $ref: '#/components/schemas/200_vi02_extended'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n \n"
Extended:
summary: Extended
value: "\n\n \n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi02_missing_or_invalid_port_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi02_missing_or_invalid_port_identifier'
examples:
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/predictive-arrivals/{api_key}:
get:
tags:
- Ports Information
summary: Predictive Port Arrivals
description: "Receive a prediction of the vessels likely to arrive to a specific port. Notes \n\
\ - More information about input parameters: MARKET, SHIPCLASS
\n - The frequency of allowed API calls is specific to your API key and is detailed\
\ in your contract as a number of successful calls per time period. For example “2 calls per minute”. Regardless\
\ of this agreed limit, each API key is technically restricted to a maximum of 100 total (including successful and\
\ unsuccessful) requests per minute to ensure system stability.
\n
"
operationId: predictive-arrivals
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/portid_VI05'
- $ref: '#/components/parameters/market_VI05'
- $ref: '#/components/parameters/shipclass_VI05'
- $ref: '#/components/parameters/probability_VI05'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vi05_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vi05_default'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi05_missing_or_invalid_port_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi05_missing_or_invalid_port_identifier'
examples:
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/port-congestion/{api_key}:
get:
tags:
- Ports Information
summary: Port Congestion
description: "Receive the Port Congestion for a specific period of time. Notes \n - More\
\ information about input parameters: MARKET, SHIPCLASS
\n - **NOT ALLOWED** combinations in request
\n \n - agg_market:1 **and**\
\ agg_shipclass:0
\n - agg_market:1 **and** agg_port:1
\n - agg_shipclass:1 **and** agg_port:1
\n\
\ - agg_market:1 **and** shipclass (specific value in shipclass e.g. POST PANAMAX)
\n
\n \
\ - The frequency of allowed API calls is specific to your API key and is detailed in your contract as a\
\ number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit,\
\ each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests\
\ per minute to ensure system stability.
\n
"
operationId: port-congestion
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/portid_VI06'
- $ref: '#/components/parameters/year_VI06'
- $ref: '#/components/parameters/week_VI06'
- $ref: '#/components/parameters/market_VI06'
- $ref: '#/components/parameters/shipclass_VI06'
- $ref: '#/components/parameters/agg_port_VI06'
- $ref: '#/components/parameters/agg_market_VI06'
- $ref: '#/components/parameters/agg_shipclass_VI06'
- $ref: '#/components/parameters/time_anch_VI06'
- $ref: '#/components/parameters/time_port_VI06'
- $ref: '#/components/parameters/vessels_VI06'
- $ref: '#/components/parameters/calls_VI06'
- $ref: '#/components/parameters/time_anch_stdev_VI06'
- $ref: '#/components/parameters/time_anch_diff_VI06'
- $ref: '#/components/parameters/time_anch_diff_perc_VI06'
- $ref: '#/components/parameters/time_port_stdev_VI06'
- $ref: '#/components/parameters/time_port_diff_VI06'
- $ref: '#/components/parameters/time_port_diff_perc_VI06'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_vi06_default'
application/xml:
schema:
$ref: '#/components/schemas/200_vi06_default'
examples:
Default:
summary: Simple
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi06_mandatory_field_missing'
application/xml:
schema:
$ref: '#/components/schemas/400_vi06_mandatory_field_missing'
examples:
Mandatory field missing:
summary: Mandatory field missing
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportroutes/{api_key}:
get:
tags:
- Routing Information
summary: Vessel Route to Port
description: "A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9\n\
Receive a list of available routes and distances from a vessel to a port. Notes \n - The\
\ frequency of allowed API calls is specific to your API key and is detailed in your contract as a number of\
\ successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API\
\ key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute\
\ to ensure system stability.
\n
"
operationId: exportroutes
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/mmsi_VI03'
- $ref: '#/components/parameters/imo_VI03'
- $ref: '#/components/parameters/shipid_VI03'
- $ref: '#/components/parameters/port_target_id_VI03'
- $ref: '#/components/parameters/includealternatives_VI03'
- $ref: '#/components/parameters/includeinland_VI03'
- $ref: '#/components/parameters/msgtype_VI03'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi03_default'
- $ref: '#/components/schemas/200_vi03_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi03_default'
- $ref: '#/components/schemas/200_vi03_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/400_vi03_invalid_ship_identifier'
- $ref: '#/components/schemas/400_vi03_missing_or_invalid_port_identifier'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_vi03_invalid_ship_identifier'
- $ref: '#/components/schemas/400_vi03_missing_or_invalid_port_identifier'
examples:
Invalid ship identifier:
summary: Invalid ship identifier
value: "\n\n \n \
\ \n \n"
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
'/exportroutes/{api_key} ':
get:
tags:
- Routing Information
summary: Distance to Port
description: "A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9\n\
Receive a list of available routes and distances from point or port to a specific port. Notes \n\
\ - The frequency of allowed API calls is specific to your API key and is detailed in your contract as\
\ a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit,\
\ each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests\
\ per minute to ensure system stability.
\n
"
operationId: exportroutes_
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/port_start_id_VI03'
- $ref: '#/components/parameters/LAT_VI03'
- $ref: '#/components/parameters/LON_VI03'
- $ref: '#/components/parameters/port_target_id_VI03'
- $ref: '#/components/parameters/includealternatives_VI03'
- $ref: '#/components/parameters/includeinland_VI03'
- $ref: '#/components/parameters/msgtype_VI03'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi03_default'
- $ref: '#/components/schemas/200_vi03_extended'
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/200_vi03_default'
- $ref: '#/components/schemas/200_vi03_extended'
examples:
Default:
summary: Simple
value: "\n\n \n"
Extended:
summary: Extended
value: "\n\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_vi03_missing_or_invalid_port_identifier'
application/xml:
schema:
$ref: '#/components/schemas/400_vi03_missing_or_invalid_port_identifier'
examples:
Missing or invalid port identifier:
summary: Missing or invalid port identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/reversegeocode/{api_key}:
get:
tags:
- Reverse Geocoding
summary: Reverse Geocoding of a Single Point
description: "Get a list of geometries that a given point of coordinates intersects with. Notes \n\
\ - The frequency of allowed API calls is specific to your API key and is detailed in your contract as\
\ a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed limit,\
\ each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful) requests\
\ per minute to ensure system stability.
\n
"
operationId: reversegeocode
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/coordinates_GI01'
- $ref: '#/components/parameters/radius_GI01'
- $ref: '#/components/parameters/exclude_ports_GI01'
- $ref: '#/components/parameters/exclude_berths_GI01'
- $ref: '#/components/parameters/exclude_terminals_GI01'
- $ref: '#/components/parameters/exclude_standard_areas_GI01'
- $ref: '#/components/parameters/exclude_custom_areas_GI01'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_gi01_default'
application/xml:
schema:
$ref: '#/components/schemas/200_gi01_default'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/setfleet/{api_key}:
get:
tags:
- Fleets
summary: Modify Fleet
description: "Manage your MarineTraffic fleet. To **create a new item** in a fleet, use the active parameter.\
\ If the item already exists, it will **update** item's status. The active parameter can have values of\
\ 0, 1, 2 which corresponds to the three states of the fleet items (inactive, active, sat enabled) The\
\ **delete** parameter must have a value of 1 and it **removes** the entry from the fleet. If MMSI, IMO\
\ and SHIP ID are passed, the MMSI takes precedence and the IMO and SHIP ID will be ignored. When you add\
\ vessels to a Fleet of Interest using the setfleet API endpoint: \n\n - If you provide an IMO or MMSI that\
\ matches multiple vessels in the MarineTraffic database, the system will automatically select the vessel with the\
\ most recent AIS timestamp and add it to your fleet.
\n - If you provide a shipid, the system will add that\
\ exact vessel — no duplicate resolution is performed.
\n - To avoid any ambiguity, we recommend using shipid\
\ when you want precise control over which vessel is added.
\n
\nResponse is always an XML structure indicating\
\ success or failure with failure description message. Notes \n - The frequency of allowed\
\ API calls is specific to your API key and is detailed in your contract as a number of successful calls per time\
\ period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically restricted\
\ to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system stability.
\n\
"
operationId: setfleet
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/mmsi_PU01'
- $ref: '#/components/parameters/imo_PU01'
- $ref: '#/components/parameters/shipid_PU01'
- $ref: '#/components/parameters/fleet_id_PU01'
- $ref: '#/components/parameters/active_PU01'
- $ref: '#/components/parameters/delete_PU01'
responses:
'200':
description: Successful Response
content:
application/xml:
schema:
$ref: '#/components/schemas/200_pu01_update'
examples:
Update fleet:
summary: Update fleet
value: "\n\n \n \
\ \n \n"
'400':
description: Bad Request
content:
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/400_pu01_invalid_ship_identifier'
- $ref: '#/components/schemas/400_pu01_missing_ship_identifier'
examples:
Invalid ship identifier:
summary: Invalid ship identifier
value: "\n\n \n \
\ \n \n"
Missing ship identifier:
summary: Missing ship identifier
value: "\n\n \n \
\ \n \n"
'404':
description: Not Found
content:
application/xml:
schema:
oneOf:
- $ref: '#/components/schemas/404_pu01_invalid_fleet_identifier'
examples:
Invalid fleet identifier:
summary: Invalid fleet identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/getfleet/{api_key}:
get:
tags:
- Fleets
summary: Vessels in Fleet
description: "Get a detailed listing of vessels included in one of your MarineTraffic fleets. Notes\
\ \n - The frequency of allowed API calls is specific to your API key and is detailed in your contract\
\ as a number of successful calls per time period. For example “2 calls per minute”. Regardless of this agreed\
\ limit, each API key is technically restricted to a maximum of 100 total (including successful and unsuccessful)\
\ requests per minute to ensure system stability.
\n
"
operationId: getfleet
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/v_PU02'
- $ref: '#/components/parameters/fleet_id_PU02'
- $ref: '#/components/parameters/page_PU02'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_pu02_default'
application/xml:
schema:
$ref: '#/components/schemas/200_pu02_default'
examples:
Default:
summary: Simple
value: "\n\n \n \n \n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_pu02_empty_fleet'
application/xml:
schema:
$ref: '#/components/schemas/400_pu02_empty_fleet'
examples:
Empty fleet:
summary: Empty fleet
value: "\n \n \n \n"
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/403_pu02_invalid_fleet_identifier'
application/xml:
schema:
$ref: '#/components/schemas/403_pu02_invalid_fleet_identifier'
examples:
Invalid fleet identifier:
summary: Invalid fleet identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/getfleets/{api_key}:
get:
tags:
- Fleets
summary: List Fleets
description: "Get an overview list of all your MarineTraffic fleets. Notes \n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: getfleets
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/protocol'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_pu03_default'
application/xml:
schema:
$ref: '#/components/schemas/200_pu03_default'
examples:
Default:
summary: Default
value: "\n\n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/clearfleet/{api_key}:
get:
tags:
- Fleets
summary: Clear Fleet
description: "Clear your MarineTraffic fleet from all vessels. Notes \n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: clearfleet
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/fleet_id_PU05'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_pu05_default'
application/xml:
schema:
$ref: '#/components/schemas/200_pu05_default'
examples:
Default:
summary: Default
value: "\n\n \n"
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/404_pu05_missing_or_invalid_fleet_identifier'
application/xml:
schema:
$ref: '#/components/schemas/404_pu05_missing_or_invalid_fleet_identifier'
examples:
Missing or invalid fleet identifier:
summary: Missing or invalid fleet identifier
value: "\n\n \n \
\ \n \n"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/exportcredits/{api_key}:
get:
tags:
- Balances
summary: Credits Balance
description: "Get a snapshot of your current credits balance. Notes \n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: exportcredits
parameters:
- $ref: '#/components/parameters/api_key'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_pu04_default'
application/xml:
schema:
$ref: '#/components/schemas/200_pu04_default'
examples:
Default:
summary: Default
value: "\n\n \n
"
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/429_too_many_requests'
application/xml:
schema:
$ref: '#/components/schemas/429_too_many_requests'
examples:
Area out of bound:
summary: Too Many Requests
value: "\n\n \n \
\ \n \n"
/import-passage-plan/{api_key}:
post:
tags:
- Passage Plans
summary: Import Passage Plan
description: "Import a passage plan for one of your managed vessels. Notes \n - Passage plans\
\ can only be imported for vessels that belong to user's managed vessels (see Fleet Operations solution for more info)
\n - Accepted file formats are CSV, RTZ or RT3
\n - Maximum\
\ file size supported is 20MB
\n - File should contain at least 2 waypoints
\n - Imported passage\
\ plans overwrite previously imported ones for the provided api_key and IMO combination
\n - The frequency\
\ of allowed API calls is specific to your API key and is detailed in your contract as a number of successful\
\ calls per time period. For example “2 calls per minute”. Regardless of this agreed limit, each API key is technically\
\ restricted to a maximum of 100 total (including successful and unsuccessful) requests per minute to ensure system\
\ stability.
\n
"
operationId: import-passage-plan
parameters:
- $ref: '#/components/parameters/api_key'
- $ref: '#/components/parameters/content_type_pu06'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pu06_request_body'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/200_pu06_default'
application/xml:
schema:
$ref: '#/components/schemas/200_pu06_default'
examples:
Default:
summary: Simple
value: "\n\n \n \
\ CODE=\"s8\" DESCRIPTION=\"PASSAGE PLAN IMPORTED\"/>\n \n"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/400_pu06_vessel_not_found'
application/xml:
schema:
$ref: '#/components/schemas/400_pu06_vessel_not_found'
examples:
Vessel not found:
summary: Vessel not found
value: "\n\n\n \n \n\
\ \n"
components:
parameters:
api_key:
name: api_key
in: path
description: 'API key: 40-character hexadecimal number'
required: true
schema:
type: string
cursor:
name: cursor
in: query
description: The pagination cursor provided in the metadata section of the previous response
required: false
schema:
type: string
limit:
name: limit
in: query
description: The limit of vessels per page (min=1000, max=5000)
required: false
schema:
type: integer
default: 2000
protocol_mandatory:
name: protocol
in: query
description: "Response type. Use one of the following: \n - jsono
\n - csv
"
required: false
schema:
type: string
default: jsono
protocol_new:
name: protocol
in: query
description: "Response type. Use one of the following: \n - xml
\n - csv
\n - jsono
"
required: false
schema:
type: string
default: xml
v_PS01:
name: v
in: query
description: Version of the service to be executed. Use version 3 to get the latest
schema:
type: integer
default: 1
shipid_PS01:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: true
schema:
type: integer
mmsi_PS01:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track
required: false
schema:
type: integer
imo_PS01:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
days_PS01:
name: days
in: query
description: The number of days, starting from the time of request and going backwards, for which the response should
look for position data Maximum value is 190 (days)
required: true
schema:
type: integer
fromdate_PS01:
name: fromdate
in: query
description: Use with todate instead of days to get data for a date period
required: false
schema:
type: string
format: date-time
todate_PS01:
name: todate
in: query
description: Use with fromdate instead of days to get data for a date period
required: false
schema:
type: string
format: date-time
period_PS01:
name: period
in: query
description: "Limit position per vessel. Omit to get all the available positions Values are: \n - hourly:\
\ get one position per hour
\n - daily: get one position per day
\n
"
required: false
schema:
type: string
msgtype_PS01:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes also weather data"
required: false
schema:
type: string
default: simple
protocol:
name: protocol
in: query
description: "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
required: false
schema:
type: string
default: xml
MINLAT_PS01:
name: MINLAT
in: query
description: Use with MAXLAT, MINLON, MAXLON to define an area for which you wish to either get all the historical vessels'
positions or historical positions for a specific vessel The absolute value of MAXLAT - MINLAT + MAXLON
- MINLON has to be equal to or less than 2 If you do not define a vessel, the maximum period for
which you can look back has a maximum period of one day
required: true
schema:
type: number
MAXLAT_PS01:
name: MAXLAT
in: query
description: Use with MINLAT, MINLON, MAXLON to define an area for which you wish to either get all the historical vessels'
positions or historical positions for a specific vessel The absolute value of MAXLAT - MINLAT + MAXLON
- MINLON has to be equal to or less than 2 If you do not define a vessel, the maximum period for
which you can look back has a maximum period of one day
required: true
schema:
type: number
MINLON_PS01:
name: MINLON
in: query
description: Use with MINLAT, MAXLAT, MAXLON to define an area for which you wish to either get all the historical vessels'
positions or historical positions for a specific vessel The absolute value of MAXLAT - MINLAT + MAXLON
- MINLON has to be equal to or less than 2 If you do not define a vessel, the maximum period for
which you can look back has a maximum period of one day
required: true
schema:
type: number
MAXLON_PS01:
name: MAXLON
in: query
description: Use with MINLAT, MAXLAT, MINLON to define an area for which you wish to either get all the historical vessels'
positions or historical positions for a specific vessel The absolute value of MAXLAT - MINLAT + MAXLON
- MINLON has to be equal to or less than 2 If you do not define a vessel, the maximum period for
which you can look back has a maximum period of one day
required: true
schema:
type: number
shipid_PS01_2:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: false
schema:
type: integer
v_PS02:
name: v
in: query
description: Version of the service to be executed. Use version 8 to get the latest
required: true
schema:
type: integer
default: 1
timespan_PS02:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions. Maximum value for terrestrial coverage
is 60. Maximum value for satellite coverage is 180
required: false
schema:
type: integer
default: 5
shiptype_PS02:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
msgtype_PS02:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS03:
name: v
in: query
description: Version of the service to be executed. Use version 8 to get the latest
required: true
schema:
type: integer
default: 1
vessel_type:
name: vesseltypeid
in: query
description: Filter vessels based on vessel types, comma separated ids supported more
required: false
schema:
type: integer
timespan_PS03:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions Maximum value for terrestrial coverage
is 60. Maximum value for satellite coverage is 180
required: false
schema:
type: integer
default: 5
shiptype_PS03:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
msgtype_PS03:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS04:
name: v
in: query
description: Version of the service to be executed. Use version 8 to get the latest
required: true
schema:
type: integer
default: 1
timespan_PS04:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions Maximum value for terrestrial coverage
is 60. Maximum value for satellite coverage is 180
required: false
schema:
type: integer
default: 5
shiptype_PS04:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
msgtype_PS04:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS05:
name: v
in: query
description: Version of the service to be executed. Use version 8 to get the latest
required: true
schema:
type: integer
default: 1
timespan_PS05:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions Maximum value for terrestrial coverage
is 60. Maximum value for satellite coverage is 180
required: false
schema:
type: integer
default: 5
shiptype_PS05:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
msgtype_PS05:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS06:
name: v
in: query
description: Version of the service to be executed. Use version 8 to get the latest
required: true
schema:
type: integer
default: 1
v_MTA030AD_1:
name: v
in: query
description: Use latest version **9**
required: true
schema:
type: integer
v_MTA030AD_2:
name: v
in: query
description: Use latest version **2**
required: true
schema:
type: integer
v_MTA030AD_3:
name: v
in: query
description: Use latest version **6**
required: true
schema:
type: integer
timespan_PS06:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions. Maximum value is 2880
required: false
schema:
type: integer
default: 5
shiptype_PS06:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
MAXLAT_PS06:
name: MAXLAT
in: query
description: Use with MINLAT, MINLON, MAXLON to define an area and retrieve positional information of vessels sailing
in it
required: true
schema:
type: number
MINLON_PS06:
name: MINLON
in: query
description: Use with MINLAT, MAXLAT, MAXLON to define an area and retrieve positional information of vessels sailing
in it
required: true
schema:
type: number
MAXLON_PS06:
name: MAXLON
in: query
description: Use with MINLAT, MINLON, MAXLAT to define an area and retrieve positional information of vessels sailing
in it
required: true
schema:
type: number
MINLAT_PS06:
name: MINLAT
in: query
description: Use with MAXLAT, MINLON, MAXLON to define an area and retrieve positional information of vessels sailing
in it
required: true
schema:
type: number
msgtype_PS06:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS07:
name: v
in: query
description: Version of the service to be executed. Use version 5 to get the latest
required: true
schema:
type: integer
default: 1
shipid_PS07:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: true
schema:
type: integer
imo_PS07:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
mmsi_PS07:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track
required: false
schema:
type: integer
timespan_PS07:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions. Maximum value is 2880
required: false
schema:
type: integer
default: 2
msgtype_PS07:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes scheduled static and voyage related vessel data report (AIS\
\ Message 5). In this case your request frequency might be limited (depending on your service terms) If\
\ omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
v_PS08:
name: v
in: query
description: Version of the service to be executed. Use version 1 to get the latest
required: true
schema:
type: integer
default: 1
timespan_PS08:
name: timespan
in: query
description: The maximum age, in minutes, of the returned positions. Maximum value is 2880
required: false
schema:
type: integer
default: 5
shiptype_generic_PS08:
name: shiptype_generic
in: query
description: Filter vessels based on generic vessel types, comma separated values supported Vessel type ID
should be used and not vessel type name (2=Fishing / 4=High Speed Craft / 6=Passenger / 7=Cargo / 8=Tanker)
Should not be combined with shiptype_detailed filter
required: false
schema:
type: integer
shiptype_detailed_PS08:
name: shiptype_detailed
in: query
description: Filter vessels based on detailed vessel types, comma separated values supported Vessel type
ID should be used and not vessel type name - more
Should not be combined with shiptype_generic filter
required: false
schema:
type: integer
msgtype_PS08:
name: msgtype
in: query
description: "Resolution of the response. Available values: \n - simple
\n - extended
\n - full
\n\
If used with the value extended or full, the response includes scheduled static and voyage related\
\ vessel data report (AIS Message 5). In this case your request frequency might be limited (depending on your service\
\ terms) If omitted, the returned records include only position reports (AIS Messages 1, 2, 3/ 18, 19)"
required: false
schema:
type: string
default: simple
timespan_MTA030AD:
name: timespan
in: query
description: Overrides the default timespan
required: false
schema:
type: integer
default: 5
v_EV01:
name: v
in: query
description: Version of the service to be executed. Use version 6 to get the latest
required: true
schema:
type: integer
default: 1
shipid_EV01:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: true
schema:
type: integer
mmsi_EV01:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track
required: false
schema:
type: integer
imo_EV01:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
timespan_EV01:
name: timespan
in: query
description: The maximum age, in minutes, of the returned port calls. Maximum value is 2880
required: false
schema:
type: integer
default: 2
movetype_EV01:
name: movetype
in: query
description: Use 0 to only receive arrivals or 1 to only receive departures. If not used, the response will include
both
required: false
schema:
type: integer
exclude_intransit_EV01:
name: exclude_intransit
in: query
description: Use 1 to exclude vessels in transit
required: false
schema:
type: integer
fromdate_EV01:
name: fromdate
in: query
description: 'Portcalls between fromdate and todate. Maximum period requested 190 days Date format: YYYY-MM-DD
HH:MM'
required: false
schema:
type: string
format: date-time
todate_EV01:
name: todate
in: query
description: 'Portcalls between fromdate and todate. Maximum period requested 190 days Date format: YYYY-MM-DD
HH:MM'
required: false
schema:
type: string
format: date-time
dwt_min_EV01:
name: dwt_min
in: query
description: 'Data filter: minimum DWT Applicable to IMO-having vessels'
required: false
schema:
type: integer
dwt_max_EV01:
name: dwt_max
in: query
description: 'Data filter: maximum DWT Applicable to IMO-having vessels'
required: false
schema:
type: integer
gt_min_EV01:
name: gt_min
in: query
description: 'Data filter: minimum GT Applicable to IMO-having vessels'
required: false
schema:
type: integer
gt_max_EV01:
name: gt_max
in: query
description: 'Data filter: maximum GT Applicable to IMO-having vessels'
required: false
schema:
type: integer
market_EV01:
name: market
in: query
description: Define market(s) for which you would like to receive port calls (single or comma separated values) - more
required: false
schema:
type: string
msgtype_EV01:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes voyage related data since the previous port call"
required: false
schema:
type: string
default: simple
v_EV02:
name: v
in: query
description: Version of the service to be executed. Use version 2 to get the latest
required: true
schema:
type: integer
default: 1
shipid_EV02:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: true
schema:
type: integer
mmsi_EV02:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track
required: false
schema:
type: integer
imo_EV02:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
timespan_EV02:
name: timespan
in: query
description: The maximum age, in minutes, of the returned port calls. Maximum value is 2880
required: false
schema:
type: integer
default: 60
fromdate_EV02:
name: fromdate
in: query
description: 'Vessel Events between fromdate and todate Date format: YYYY-MM-DD HH:MM:SS'
required: false
schema:
type: string
format: date-time
todate_EV02:
name: todate
in: query
description: 'Vessel Events between fromdate and todate Date format: YYYY-MM-DD HH:MM:SS'
required: false
schema:
type: string
format: date-time
event_type_EV02:
name: event_type
in: query
description: You may use one or more event ids in comma separated format for the events you wish to receive
required: false
schema:
type: integer
limit_events_EV02:
name: limit_events
in: query
description: Limit the number of results
required: false
schema:
type: integer
v_EV03:
name: v
in: query
description: Version of the service to be executed. Use version 3 to get the latest
required: true
schema:
type: integer
default: 1
shipid_EV03:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo
or mmsi
required: true
schema:
type: integer
mmsi_EV03:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track
required: false
schema:
type: integer
imo_EV03:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
timespan_EV03:
name: timespan
in: query
description: The maximum age, in minutes, of the returned port calls. Maximum value is 2880
required: false
schema:
type: integer
default: 2
fromdate_EV03:
name: fromdate
in: query
description: 'Return Berth Calls where DOCK_TIMESTAMP_UTC is equal to or greater than provided fromdate. Maximum period
requested 15 days Date format: YYYY-MM-DD HH:MM:SS.'
required: false
schema:
type: string
format: date-time
todate_EV03:
name: todate
in: query
description: 'Return Berth Calls where DOCK_TIMESTAMP_UTC is equal to or less than provided todate. Maximum period requested
15 days Date format: YYYY-MM-DD HH:MM:SS'
required: false
schema:
type: string
format: date-time
market_EV03:
name: market
in: query
description: "Define market for which you would like to receive berth calls - more \n - if undefined and ship-class is also undefined, then return all
\n - if undefined and\
\ ship-class is defined, return based on ship-class
\n - if defined and ship-class is undefined, return all\
\ ship-classes of the specific market
\n
"
required: false
schema:
type: string
shipclass_EV03:
name: shipclass
in: query
description: Define ship class of interest - more
required: false
schema:
type: integer
dwt_min_EV03:
name: dwt_min
in: query
description: 'Data filter: minimum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype
= 7,8)'
required: false
schema:
type: integer
dwt_max_EV03:
name: dwt_max
in: query
description: 'Data filter: maximum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype
= 7,8)'
required: false
schema:
type: integer
gt_min_EV03:
name: gt_min
in: query
description: 'Data filter: minimum GT Applicable to IMO-having vessels'
required: false
schema:
type: integer
gt_max_EV03:
name: gt_max
in: query
description: 'Data filter: maximum GT Applicable to IMO-having vessels'
required: false
schema:
type: integer
movetype_EV03:
name: movetype
in: query
description: Use 0 to include both, 1 to only receive dockings or 2 for only undockings within the defined period. If
not used, only dockings are returned Available only from version 2 of the service
required: false
schema:
type: integer
msgtype_EV03:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes voyage related data since the previous port call"
required: false
schema:
type: string
default: simple
portid_EV01:
name: portid
in: query
description: The MarineTraffic ID of the port you wish to monitor (found on the URL of the respective Port page) or
port UN/LOCODE
required: true
schema:
type: integer
portid_EV03:
name: portid
in: query
description: The MarineTraffic ID of the port you wish to monitor (found on the URL of the respective Port page)
You can instead use port_unlocode, berthid or terminalid
required: true
schema:
type: integer
port_unlocode_EV03:
name: port_unlocode
in: query
description: Port UN LOCODE (without gaps or spaces)
required: false
schema:
type: integer
berthid_EV03:
name: berthid
in: query
description: 'The MarineTraffic ID of the berth you wish to monitor (list to be provided upon request) '
required: false
schema:
type: integer
terminalid_EV03:
name: terminalid
in: query
description: The MarineTraffic ID of the terminal you wish to monitor (list to be provided upon request)
required: false
schema:
type: integer
vessel_id_VD01:
name: vessel_id
in: query
description: The Maritime Mobile Service Identity (MMSI) or the IMO number of the vessel You can instead
use shipid
required: true
schema:
type: integer
shipid_VD01:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel
required: false
schema:
type: integer
v_VD02:
name: v
in: query
description: Version of the service to be executed. Use version 5 to get the latest
required: true
schema:
type: integer
default: 1
msgtype_VD02:
name: msgtype
in: query
description: "Resolution of the response. Available values: "
required: false
schema:
type: string
default: simple
mmsi_VD02:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track (single or comma separated
values) You can instead use imo or shipid
required: true
schema:
type: integer
imo_VD02:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track (single or comma separated
values)
required: false
schema:
type: integer
shipid_VD02:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel (single or comma separated values)
required: false
schema:
type: integer
timespan_VD02:
name: timespan
in: query
description: The timespan parameter defines the period of time, during which we want to receive the change in a vessel's
details The maximum value can be either 5 when the interval parameter is set to days or 2880 when the interval
is set to minutes
required: false
schema:
type: integer
interval_VD02:
name: interval
in: query
description: The interval parameter can be either minutes or days
required: false
schema:
type: string
default: minutes
page_VD02:
name: page
in: query
description: Page number of the results to be returned
required: false
schema:
type: integer
default: 1
shipid_VD03:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use mmsi
or imo
required: true
schema:
type: integer
mmsi_VD03:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track NOTE: Using
MMSI may potentially return multiple records as multiple vessels might have transponded the same MMSI
required: false
schema:
type: integer
imo_VD03:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track NOTE:
Using IMO may potentially return multiple records as multiple vessels might have transponded the same IMO
required: false
schema:
type: integer
shiptype_VD03:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
type_name_id_VD03:
name: type_name_id
in: query
description: 'Data filter: AIS Shiptype Find more information here'
required: false
schema:
type: integer
shipname_VD03:
name: shipname
in: query
description: The vessel name. The results will contain all vessels whose name is like the given words
required: true
schema:
type: string
v_VI01:
name: v
in: query
description: Version of the service to be executed. Use version 2 to get the latest
required: true
schema:
type: integer
default: 1
mmsi_VI01:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead
use imo or shipid
required: true
schema:
type: integer
imo_VI01:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
shipid_VI01:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel
required: false
schema:
type: integer
msgtype_VI01:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes voyage related information (eg. distance travelled and to-go,\
\ load condition) and the estimated route to the vessel's destination"
required: false
schema:
type: string
default: simple
fleet_id_VI01:
name: fleet_id
in: query
description: The fleet id you wish to receive voyage forecast for
required: true
schema:
type: integer
mmsi_VI04:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead
use imo or shipid
required: true
schema:
type: integer
imo_VI04:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
shipid_VI04:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel
required: false
schema:
type: integer
fromportid_VI04:
name: fromportid
in: query
description: The MarineTraffic ID of the port you wish to receive a prediction (found on the URL of the respective Port
page)
required: false
schema:
type: integer
fleet_id_VI04:
name: fleet_id
in: query
description: The MarineTraffic ID of the fleet you wish to track
required: true
schema:
type: integer
v_VI07:
name: v
in: query
description: Version of the service to be executed. Use version 2 to get the latest
required: true
schema:
type: integer
default: 1
portid_VI07:
name: portid
in: query
description: The MarineTraffic ID of the port you wish to receive ETA info You can instead use unlocode
required: true
schema:
type: integer
unlocode_VI07:
name: unlocode
in: query
description: The UN LOCODE (without gaps or spaces) of the port you wish to receive ETA info
required: false
schema:
type: string
mmsi_VI07:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead
use imo or shipid
required: true
schema:
type: integer
imo_VI07:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
shipid_VI07:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel
required: false
schema:
type: integer
speed_calc_VI07:
name: speed_calc
in: query
description: "The Speed of the Vessel that MarineTraffic will use to produce the ETA value \n - if not defined\
\ the last average speed of the Vessel will be used
\n - if no average speed exists then a default value of\
\ 12(kn) will be used
\n
"
required: false
schema:
type: integer
msgtype_VI07:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes voyage related data"
required: false
schema:
type: string
default: simple
v_VI02:
name: v
in: query
description: Version of the service to be executed. Use version 4 to get the latest
required: true
schema:
type: integer
default: 1
portid_VI02:
name: portid
in: query
description: The MarineTraffic ID of the port (found on the URL of the respective Port page)
required: true
schema:
type: integer
timespan_VI02:
name: timespan
in: query
description: Number of days in the future to look for expected arrivals, starting from the time the API call is requested
Maximum value is 40 days If neither this nor the fromdate/todate parameters are used, the response
only includes vessels currently in port (or the country’s ports) and the last vessel's signal is received during the
last 2 days
required: false
schema:
type: integer
days_last_signal_VI02:
name: days_last_signal
in: query
description: Include vessels currently in port that have transmitted a position within the last x days (based on their
last signal timestamp). This parameter only works when no other timeframe is defined.
required: false
schema:
type: integer
fromdate_VI02:
name: fromdate
in: query
description: 'Timestamp in the future to start looking for expected arrivals. If used, then you should also define the
todate parameter Date format: YYYY-MM-DD HH:MM:SS'
required: false
schema:
type: string
format: date-time
todate_VI02:
name: todate
in: query
description: 'Timestamp in the future to start looking for expected arrivals. If used, then you should also define the
fromdate parameter Date format: YYYY-MM-DD HH:MM:SS'
required: false
schema:
type: string
format: date-time
fromportid_VI02:
name: fromportid
in: query
description: The MarineTraffic ID of the previous port (found on the URL of the respective Port page) or previous port
UNLOCODE
required: false
schema:
type: integer
shiptype_VI02:
name: shiptype
in: query
description: "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n\
\ - 7: Cargo
\n - 8: Tanker
"
required: false
schema:
type: integer
dwt_min_VI02:
name: dwt_min
in: query
description: 'Data filter: minimum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype
= 7,8). If used, then you should also define the dwt_max parameter'
required: false
schema:
type: integer
dwt_max_VI02:
name: dwt_max
in: query
description: 'Data filter: maximum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype
= 7,8). If used, then you should also define the dwt_min parameter'
required: false
schema:
type: integer
gt_min_VI02:
name: gt_min
in: query
description: 'Data filter: minimum GT Applicable to IMO-having vessels. If used, then you should also define
the gt_max parameter'
required: false
schema:
type: integer
gt_max_VI02:
name: gt_max
in: query
description: 'Data filter: maximum GT Applicable to IMO-having vessels. If used, then you should also define
the gt_min parameter'
required: false
schema:
type: integer
msgtype_VI02:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, apart from the ETA information, the response includes main vessel particulars. If\
\ omitted, the returned records include only position and ETA reports"
required: false
schema:
type: string
default: simple
country_VI02:
name: country
in: query
description: The Country code of interest. Response includes all ports within the Country
required: true
schema:
type: integer
portid_VI05:
name: portid
in: query
description: The MarineTraffic ID of the port you wish to receive probable visits (found on the URL of the respective
Port page)
required: true
schema:
type: integer
market_VI05:
name: market
in: query
description: "Define market for which you would like to receive probable visits - more \n - if undefined and ship-class is also undefined, then return all
\n - if undefined and\
\ ship-class is defined, return based on ship-class
\n - If defined and ship-class is undefined, return all\
\ ship-classes of the specific market
\n
"
required: false
schema:
type: integer
shipclass_VI05:
name: shipclass
in: query
description: Define ship class of interest - more
required: false
schema:
type: integer
probability_VI05:
name: probability
in: query
description: Define probability over which you would like to receive probable visits (accepted > 0.3)
required: false
schema:
type: integer
portid_VI06:
name: portid
in: query
description: The MarineTraffic ID of the port for which you wish to retrieve congestion metrics (found on the URL of
the respective Port page). If you wish to retrieve congestion metrics for all ports, instead of portid
use agg_port=1
required: true
schema:
type: integer
year_VI06:
name: year
in: query
description: Year of interest (data available back to 1 year). Information further back can be requested ad-hoc
required: true
schema:
type: integer
week_VI06:
name: week
in: query
description: Week of Year that is of interest (e.g. for week 18/2018 input 18). For range of weeks use comma e.g. for
weeks 30 to 35 (30,35)
required: true
schema:
type: integer
market_VI06:
name: market
in: query
description: "Define market for which you would like to receive port congestion - more \n - if undefined and ship-class is also undefined, then figures for ALL markets/ship-class
\n\
\ - if undefined and ship-class is defined, returns based on ship-class for ALL applicable to size class markets
\n\
\ - if defined and ship-class is undefined, returns figures for the specific market (no size class breakdown)
\n\
If you wish to retrieve congestion metrics for all markets, instead of market use agg_market\
\ query parameter (=0 or =1)"
required: true
schema:
type: integer
shipclass_VI06:
name: shipclass
in: query
description: Define ship class of interest - more
If you wish to retrieve congestion metrics for all ship classes, instead of shipclass use agg_shipclass
query parameter (=0 or =1)
required: true
schema:
type: integer
agg_port_VI06:
name: agg_port
in: query
description: "**If used, portid should not be in request** \n - when agg_port = 1 is used, aggregation result\
\ of all ports are returned
\n - when agg_port = 1 is used, agg_market cannot be 1
\n
"
required: false
schema:
type: integer
agg_market_VI06:
name: agg_market
in: query
description: "**If used, market should not be in request** \n - if agg_market = 1, aggregation result of all\
\ markets will be returned
\n - if 0, a breakdown of markets will be returned
\n
"
required: false
schema:
type: integer
agg_shipclass_VI06:
name: agg_shipclass
in: query
description: "**If used, shipclass should not be in request** \n - if agg_shipclass = 1, aggregation result of\
\ all classes will be returned
\n - if 0, a breakdown of classes will be returned
\n
"
required: false
schema:
type: integer
time_anch_VI06:
name: time_anch
in: query
description: 'The median number of days spent at anchorage by the selected market/shipclass.
Values indicate in between set to be returned Comma separated float
numbers (one decimal)
Available only if extended version of the API is used'
required: false
schema:
type: string
time_port_VI06:
name: time_port
in: query
description: The median number of days spent at port by the selected market/shipclass. Values indicate in between set
to be returned Comma separated float numbers (one decimal) Available only if extended version
of the API is used
required: false
schema:
type: string
vessels_VI06:
name: vessels
in: query
description: Number of vessels that were used in the median calculations. Value of parameter indicates greater than
relation Available only if extended version of the API is used
required: false
schema:
type: integer
calls_VI06:
name: calls
in: query
description: Number of individual calls that were used in the median calculations (e.g. if the same vessel has called
twice within the same week, it will count twice in calls and once in vessels. Value of parameter indicates greater
than relation Available only if extended version of the API is used
required: false
schema:
type: integer
time_anch_stdev_VI06:
name: time_anch_stdev
in: query
description: The standard deviation of days spent at anchorage the previous week. Values indicate in between set to
be returned (time_anch_stdev:0.5,1.5) Comma separated float numbers (one decimal) Available
only if full version of the API is used
required: false
schema:
type: string
time_anch_diff_VI06:
name: time_anch_diff
in: query
description: The week-to-week difference of number of days spent at anchorage. Values indicate in between set to be
returned Comma separated float numbers (one decimal) Available only if full version of the
API is used
required: false
schema:
type: string
time_anch_diff_perc_VI06:
name: time_anch_diff_perc
in: query
description: The week-to-week difference of number of days spent at anchorage as a percentage. Values indicate in between
set to be returned Comma separated float numbers (one decimal) Available only if full version
of the API is used
required: false
schema:
type: string
time_port_stdev_VI06:
name: time_port_stdev
in: query
description: The standard deviation of days spent at port the previous week. Values indicate in between set to be returned
(time_port_stdev:0.5,1.5) Comma separated float numbers (one decimal) Available only if full
version of the API is used
required: false
schema:
type: string
time_port_diff_VI06:
name: time_port_diff
in: query
description: The week-to-week difference of number of days spent at port. Values indicate in between set to be returned
Comma separated float numbers (one decimal) Available only if full version of the API is used
required: false
schema:
type: string
time_port_diff_perc_VI06:
name: time_port_diff_perc
in: query
description: The week-to-week difference of number of days spent at port as a percentage. Values indicate in between
set to be returned Comma separated float numbers (one decimal) Available only if full version
of the API is used
required: false
schema:
type: string
mmsi_VI03:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead
use imo or shipid
required: true
schema:
type: integer
imo_VI03:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to track
required: false
schema:
type: integer
shipid_VI03:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel
required: false
schema:
type: integer
port_target_id_VI03:
name: port_target_id
in: query
description: The MarineTraffic ID of the port you wish to put as target port (found on the URL of the respective Port
page) or port UN/LOCODE
required: true
schema:
type: integer
includealternatives_VI03:
name: includealternatives
in: query
description: Use 1 to search for all available routes regarding the specific journey or 0 to not include alternative
routes
required: false
schema:
type: integer
includeinland_VI03:
name: includeinland
in: query
description: Use 1 in order to receive routes which include inland waterways or 0 to not include alternative routes
required: false
schema:
type: integer
msgtype_VI03:
name: msgtype
in: query
description: "Resolution of the response. Available values: If used\
\ with the value extended, the response includes also route/waypoints as Linestring Geometry in WKT - Well-Known\
\ Text"
required: false
schema:
type: string
default: simple
port_start_id_VI03:
name: port_start_id
in: query
description: The MarineTraffic ID of the port you wish to put as starting point (found on the URL of the respective
Port page) or port UN/LOCODE
required: true
schema:
type: integer
LAT_VI03:
name: LAT
in: query
description: The latitude of the starting point It can be used together with LON instead of port_start_id
required: false
schema:
type: number
LON_VI03:
name: LON
in: query
description: The longitude of the starting point It can be used together with LAT instead of port_start_id
required: false
schema:
type: integer
coordinates_GI01:
name: coordinates
in: query
description: A latitude/longitude pair that you wish to receive the MarineTraffic areas/assets that intersects with
required: true
schema:
type: string
radius_GI01:
name: radius
in: query
description: Maximum distance (in NM) from the given point that should be searched for nearby areas/assets
Cannot be greater than 10NM
required: false
schema:
type: number
exclude_ports_GI01:
name: exclude_ports
in: query
description: Flag that indicates if Ports information will be excluded from response in case given point intersects
with them (0:no, 1:yes)
required: false
schema:
type: integer
exclude_berths_GI01:
name: exclude_berths
in: query
description: Flag that indicates if Berths information will be excluded from response in case given point intersects
with them (0:no, 1:yes)
required: false
schema:
type: integer
exclude_terminals_GI01:
name: exclude_terminals
in: query
description: Flag that indicates if Terminals information will be excluded from response in case given point intersects
with them (0:no, 1:yes)
required: false
schema:
type: integer
exclude_standard_areas_GI01:
name: exclude_standard_areas
in: query
description: Flag that indicates if Standard Areas information will be excluded from response in case given point intersects
with them (0:no, 1:yes)
required: false
schema:
type: integer
exclude_custom_areas_GI01:
name: exclude_custom_areas
in: query
description: Flag that indicates if Custom Areas information will be excluded from response in case given point intersects
with them (0:no, 1:yes)
required: false
schema:
type: integer
mmsi_PU01:
name: mmsi
in: query
description: The Maritime Mobile Service Identity (MMSI) of the vessel you wish to handle, comma separated values supported
You can instead use imo or shipid
required: true
schema:
type: integer
imo_PU01:
name: imo
in: query
description: The International Maritime Organization (IMO) number of the vessel you wish to handle, comma separated
values supported
required: false
schema:
type: integer
shipid_PU01:
name: shipid
in: query
description: A uniquely assigned ID by MarineTraffic for the subject vessel, comma separated values supported
required: false
schema:
type: integer
fleet_id_PU01:
name: fleet_id
in: query
description: If used, vessel will be added to the specific fleet, otherwise default fleet is used
required: false
schema:
type: integer
active_PU01:
name: active
in: query
description: "Possible values are: \n - 0 to set to inactive
\n - 1 to activate
\n - 2 to enable\
\ satellite coverage
\n
"
required: false
schema:
type: integer
delete_PU01:
name: delete
in: query
description: Set this parameter to 1 to delete a vessel from your fleet
required: false
schema:
type: integer
v_PU02:
name: v
in: query
description: Version of the service to be executed. Use version 2 to get the latest
required: true
schema:
type: integer
default: 1
fleet_id_PU02:
name: fleet_id
in: query
description: If used, will return specific fleet otherwise default fleet is used
required: false
schema:
type: integer
page_PU02:
name: page
in: query
description: Specifies the number of the results page to return. Use this parameter to navigate through paginated results
(with version 2) when the fleet contains more than 100 vessels.
required: false
schema:
type: integer
fleet_id_PU05:
name: fleet_id
in: query
description: The fleet id you wish to clear
required: true
schema:
type: integer
content_type_pu06:
name: Content-Type
in: header
description: Request's Content-Type
required: true
schema:
type: string
default: multipart/form-data
schemas:
429_too_many_requests:
title: Too many requests
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1r
detail: TOO MANY REQUESTS
200_ps01_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
example:
- MMSI: '239982500'
IMO: '8348678'
STATUS: '5'
SPEED: '0'
LON: '23.726880'
LAT: '37.878850'
COURSE: '0'
HEADING: '320'
TIMESTAMP: '2021-02-08T12:57:01.000Z'
SHIP_ID: '4317723'
- MMSI: '249032000'
IMO: '9351098'
STATUS: '15'
SPEED: '2'
LON: '23.548990'
LAT: '37.903030'
COURSE: '160'
HEADING: '160'
TIMESTAMP: '2021-02-08T12:57:05.000Z'
SHIP_ID: '362849'
200_ps01_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
WIND_ANGLE:
type: string
description: The current angle of the wind in the subject area (in degrees, compared to True North)
WIND_SPEED:
type: string
description: The current wind speed in the subject area (in knots)
WIND_TEMP:
type: string
description: The current temperature of the wind in the subject area (in Celsius degrees)
SIGNIFICANT_WAVE_HEIGHT:
type: string
description: The significant wave height in the subject area (in meters x10)
WIND_WAVE_HEIGHT:
type: string
description: The height of the wind waves in the subjects area (in meters x10)
WIND_WAVE_PERIOD:
type: string
description: The period of the wind waves in the subject area (in seconds)
WIND_WAVE_DIRECTION:
type: string
description: The direction of the wind waves in the subject area (in degrees, compared to True North)
SWELL_HEIGHT:
type: string
description: The height of the swells in the subject area (in meters x10)
SWELL_PERIOD:
type: string
description: The period of the swells in the subject area (in seconds)
SWELL_DIRECTION:
type: string
description: The direction of the swells in the subject area (in degrees, compared to True North)
CURRENTS_ANGLE:
type: string
description: The angle of the currents in the subject area (in degrees, compared to True North)
CURRENTS_SPEED:
type: string
description: The speed of the currents in the subject area (in knots x100)
example:
- MMSI: '239982500'
IMO: '8348678'
STATUS: '5'
SPEED: '0'
LON: '23.726880'
LAT: '37.878850'
COURSE: '0'
HEADING: '320'
TIMESTAMP: '2021-02-08T12:57:01.000Z'
SHIP_ID: '4317723'
WIND_ANGLE: '326'
WIND_SPEED: '10'
WIND_TEMP: '23'
SIGNIFICANT_WAVE_HEIGHT: '2'
WIND_WAVE_DIRECTION: '314'
WIND_WAVE_HEIGHT: '1'
WIND_WAVE_PERIOD: '16'
SWELL_HEIGHT: '1'
SWELL_PERIOD: '26'
CURRENTS_ANGLE: '308'
CURRENTS_SPEED: '20'
SWELL_DIRECTION: '317'
- MMSI: '249032000'
IMO: '9351098'
STATUS: '15'
SPEED: '2'
LON: '23.548990'
LAT: '37.903030'
COURSE: '160'
HEADING: '160'
TIMESTAMP: '2021-02-08T12:57:05.000Z'
SHIP_ID: '362849'
WIND_ANGLE: '333'
WIND_SPEED: '12'
WIND_TEMP: '23'
SIGNIFICANT_WAVE_HEIGHT: '3'
WIND_WAVE_DIRECTION: '320'
WIND_WAVE_HEIGHT: '3'
WIND_WAVE_PERIOD: '24'
SWELL_HEIGHT: '0'
SWELL_PERIOD: '31'
CURRENTS_ANGLE: '21'
CURRENTS_SPEED: '20'
SWELL_DIRECTION: '303'
400_ps01_days_out_of_limit:
title: Days out of limit
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 9c
detail: DAYS ABOVE ALLOWED LIMIT
400_ps01_missing_ship_identifier:
title: Missing ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
400_ps01_area_out_of_bound:
title: Area out of bound
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1k
detail: BOX OUT OF BOUNDS
200_ps02_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.512420'
LON: '24.913050'
SPEED: '229'
HEADING: '294'
COURSE: '295'
STATUS: '0'
TIMESTAMP: '2020-10-13T07:49:57.000Z'
DSRC: TER
UTC_SECONDS: '55'
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
LAT: '50.510430'
LON: '-3.453147'
SPEED: '4'
HEADING: '276'
COURSE: '236'
STATUS: '1'
TIMESTAMP: '2020-10-13T07:48:16.000Z'
DSRC: TER
UTC_SECONDS: '16'
200_ps02_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.659450'
LON: '26.497440'
SPEED: '222'
HEADING: '205'
COURSE: '208'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:47:03.000Z'
DSRC: TER
UTC_SECONDS: '0'
SHIPNAME: BLUE STAR MYCONOS
SHIPTYPE: '60'
CALLSIGN: SYJZ
FLAG: GR
LENGTH: '141'
WIDTH: '21'
GRT: '8129'
DWT: '2651'
DRAUGHT: '52'
YEAR_BUILT: '2005'
ROT: '0'
TYPE_NAME: Ro-Ro/Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: S-T-M-E-K-V
ETA: '2020-10-15T11:35:00.000Z'
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
LAT: '50.495310'
LON: '-3.182992'
SPEED: '111'
HEADING: '280'
COURSE: '274'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:47:17.000Z'
DSRC: TER
UTC_SECONDS: '16'
SHIPNAME: QUEEN MARY 2
SHIPTYPE: '60'
CALLSIGN: ZCEF6
FLAG: BM
LENGTH: '345.03'
WIDTH: '48.7'
GRT: '149215'
DWT: '19189'
DRAUGHT: '101'
YEAR_BUILT: '2003'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: TORQUAY
ETA: '2020-10-14T13:00:00.000Z'
200_ps02_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port.
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.646880'
LON: '26.488940'
SPEED: '223'
HEADING: '205'
COURSE: '208'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:49:22.000Z'
DSRC: TER
UTC_SECONDS: '18'
SHIPNAME: BLUE STAR MYCONOS
SHIPTYPE: '60'
CALLSIGN: SYJZ
FLAG: GR
LENGTH: '141'
WIDTH: '21'
GRT: '8129'
DWT: '2651'
DRAUGHT: '52'
YEAR_BUILT: '2005'
ROT: '0'
TYPE_NAME: Ro-Ro/Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: S-T-M-E-K-V
ETA: '2020-10-15T11:35:00.000Z'
CURRENT_PORT: ''
LAST_PORT: KARLOVASI
LAST_PORT_TIME: '2020-10-15T11:14:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '44'
LAST_PORT_UNLOCODE: GRKAR
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: '17305'
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: FOURNI
NEXT_PORT_COUNTRY: GR
ETA_CALC: '2020-10-15T12:04:00.000Z'
ETA_UPDATED: '2020-10-15T11:42:00.000Z'
DISTANCE_TO_GO: '7'
DISTANCE_TRAVELLED: '11'
AVG_SPEED: '22.6'
MAX_SPEED: '23.1'
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
LAT: '50.495970'
LON: '-3.195012'
SPEED: '110'
HEADING: '280'
COURSE: '275'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:49:48.000Z'
DSRC: TER
UTC_SECONDS: '47'
SHIPNAME: QUEEN MARY 2
SHIPTYPE: '60'
CALLSIGN: ZCEF6
FLAG: BM
LENGTH: '345.03'
WIDTH: '48.7'
GRT: '149215'
DWT: '19189'
DRAUGHT: '101'
YEAR_BUILT: '2003'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: TORQUAY
ETA: '2020-10-14T13:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: SOUTHAMPTON
LAST_PORT_TIME: '2020-10-14T17:00:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '106'
LAST_PORT_UNLOCODE: GBSOU
LAST_PORT_COUNTRY: GB
NEXT_PORT_ID: '10379'
NEXT_PORT_UNLOCODE: GBTOR
NEXT_PORT_NAME: TORQUAY
NEXT_PORT_COUNTRY: GB
ETA_CALC: '2020-10-15T13:10:00.000Z'
ETA_UPDATED: '2020-10-15T10:48:00.000Z'
DISTANCE_TO_GO: '17'
DISTANCE_TRAVELLED: '190'
AVG_SPEED: '10.6'
MAX_SPEED: '15.4'
403_ps02_infinite_timespan:
title: Infinite timespan
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1d
detail: TIME-UNLIMITED POLLING NOT ALLOWED
200_ps03_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.515440'
LON: '24.904090'
SPEED: '229'
HEADING: '290'
COURSE: '292'
STATUS: '0'
TIMESTAMP: '2020-10-13T07:51:09.000Z'
DSRC: TER
UTC_SECONDS: '7'
- MMSI: '241159000'
IMO: '9565041'
SHIP_ID: '214617'
LAT: '37.941010'
LON: '23.624440'
SPEED: '1'
HEADING: '154'
COURSE: '154'
STATUS: '0'
TIMESTAMP: '2020-10-13T07:46:32.000Z'
DSRC: TER
UTC_SECONDS: '30'
200_ps03_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.659450'
LON: '26.497440'
SPEED: '222'
HEADING: '205'
COURSE: '208'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:47:03.000Z'
DSRC: TER
UTC_SECONDS: '0'
SHIPNAME: BLUE STAR MYCONOS
SHIPTYPE: '60'
CALLSIGN: SYJZ
FLAG: GR
LENGTH: '141'
WIDTH: '21'
GRT: '8129'
DWT: '2651'
DRAUGHT: '52'
YEAR_BUILT: '2005'
ROT: '0'
TYPE_NAME: Ro-Ro/Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: S-T-M-E-K-V
ETA: '2020-10-15T11:35:00.000Z'
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
LAT: '50.495310'
LON: '-3.182992'
SPEED: '111'
HEADING: '280'
COURSE: '274'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:47:17.000Z'
DSRC: TER
UTC_SECONDS: '16'
SHIPNAME: QUEEN MARY 2
SHIPTYPE: '60'
CALLSIGN: ZCEF6
FLAG: BM
LENGTH: '345.03'
WIDTH: '48.7'
GRT: '149215'
DWT: '19189'
DRAUGHT: '101'
YEAR_BUILT: '2003'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: TORQUAY
ETA: '2020-10-14T13:00:00.000Z'
200_ps03_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port.
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '240389000'
IMO: '9208679'
SHIP_ID: '212537'
LAT: '37.646880'
LON: '26.488940'
SPEED: '223'
HEADING: '205'
COURSE: '208'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:49:22.000Z'
DSRC: TER
UTC_SECONDS: '18'
SHIPNAME: BLUE STAR MYCONOS
SHIPTYPE: '60'
CALLSIGN: SYJZ
FLAG: GR
LENGTH: '141'
WIDTH: '21'
GRT: '8129'
DWT: '2651'
DRAUGHT: '52'
YEAR_BUILT: '2005'
ROT: '0'
TYPE_NAME: Ro-Ro/Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: S-T-M-E-K-V
ETA: '2020-10-15T11:35:00.000Z'
CURRENT_PORT: ''
LAST_PORT: KARLOVASI
LAST_PORT_TIME: '2020-10-15T11:14:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '44'
LAST_PORT_UNLOCODE: GRKAR
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: '17305'
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: FOURNI
NEXT_PORT_COUNTRY: GR
ETA_CALC: '2020-10-15T12:04:00.000Z'
ETA_UPDATED: '2020-10-15T11:42:00.000Z'
DISTANCE_TO_GO: '7'
DISTANCE_TRAVELLED: '11'
AVG_SPEED: '22.6'
MAX_SPEED: '23.1'
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
LAT: '50.495970'
LON: '-3.195012'
SPEED: '110'
HEADING: '280'
COURSE: '275'
STATUS: '0'
TIMESTAMP: '2020-10-15T11:49:48.000Z'
DSRC: TER
UTC_SECONDS: '47'
SHIPNAME: QUEEN MARY 2
SHIPTYPE: '60'
CALLSIGN: ZCEF6
FLAG: BM
LENGTH: '345.03'
WIDTH: '48.7'
GRT: '149215'
DWT: '19189'
DRAUGHT: '101'
YEAR_BUILT: '2003'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: TORQUAY
ETA: '2020-10-14T13:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: SOUTHAMPTON
LAST_PORT_TIME: '2020-10-14T17:00:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '106'
LAST_PORT_UNLOCODE: GBSOU
LAST_PORT_COUNTRY: GB
NEXT_PORT_ID: '10379'
NEXT_PORT_UNLOCODE: GBTOR
NEXT_PORT_NAME: TORQUAY
NEXT_PORT_COUNTRY: GB
ETA_CALC: '2020-10-15T13:10:00.000Z'
ETA_UPDATED: '2020-10-15T10:48:00.000Z'
DISTANCE_TO_GO: '17'
DISTANCE_TRAVELLED: '190'
AVG_SPEED: '10.6'
MAX_SPEED: '15.4'
200_ps04_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '244830406'
IMO: '0'
SHIP_ID: '253535'
LAT: '52.371040'
LON: '4.888482'
SPEED: '0'
HEADING: '511'
COURSE: '0'
STATUS: '5'
TIMESTAMP: '2020-10-13T07:49:59.000Z'
DSRC: TER
UTC_SECONDS: '59'
- MMSI: '244780352'
IMO: '0'
SHIP_ID: '250936'
LAT: '52.377110'
LON: '4.900798'
SPEED: '2'
HEADING: '511'
COURSE: '16'
STATUS: '7'
TIMESTAMP: '2020-10-13T07:49:59.000Z'
DSRC: TER
UTC_SECONDS: '59'
200_ps04_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '244750688'
IMO: '0'
SHIP_ID: '1496'
LAT: '52.392240'
LON: '4.886143'
SPEED: '0'
HEADING: '511'
COURSE: '244'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:12:20.000Z'
DSRC: TER
UTC_SECONDS: '21'
SHIPNAME: IJVEER 52
SHIPTYPE: '60'
CALLSIGN: PH2792
FLAG: NL
LENGTH: '28.6'
WIDTH: '9'
GRT: ''
DWT: ''
DRAUGHT: '24'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Inland, Ferry
AIS_TYPE_SUMMARY: Passenger
DESTINATION: ''
ETA: ''
- MMSI: '244750690'
IMO: '0'
SHIP_ID: '1498'
LAT: '52.400910'
LON: '4.891057'
SPEED: '0'
HEADING: '511'
COURSE: '7'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:12:31.000Z'
DSRC: TER
UTC_SECONDS: '22'
SHIPNAME: IJVEER 56
SHIPTYPE: '60'
CALLSIGN: PB7406
FLAG: NL
LENGTH: '28.6'
WIDTH: '9'
GRT: ''
DWT: ''
DRAUGHT: '24'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Inland, Ferry
AIS_TYPE_SUMMARY: Passenger
DESTINATION: ''
ETA: ''
200_ps04_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port.
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '244740307'
IMO: '0'
SHIP_ID: '538'
LAT: '52.392770'
LON: '4.823317'
SPEED: '0'
HEADING: '511'
COURSE: '306'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:14:45.000Z'
DSRC: TER
UTC_SECONDS: '45'
SHIPNAME: WABO
SHIPTYPE: '70'
CALLSIGN: PE6642
FLAG: NL
LENGTH: '46'
WIDTH: '6'
GRT: ''
DWT: ''
DRAUGHT: '26'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Inland, Bunkership
AIS_TYPE_SUMMARY: Tanker
DESTINATION: AMSTERDAM
ETA: '2021-02-09T00:00:00.000Z'
CURRENT_PORT: AMSTERDAM
LAST_PORT: ZAANDAM
LAST_PORT_TIME: '2020-08-09T10:27:00.000Z'
CURRENT_PORT_ID: '1766'
CURRENT_PORT_UNLOCODE: NLAMS
CURRENT_PORT_COUNTRY: NL
LAST_PORT_ID: '2141'
LAST_PORT_UNLOCODE: NLZAA
LAST_PORT_COUNTRY: NL
NEXT_PORT_ID: '1766'
NEXT_PORT_UNLOCODE: NLAMS
NEXT_PORT_NAME: AMSTERDAM
NEXT_PORT_COUNTRY: NL
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '54'
AVG_SPEED: '6.4'
MAX_SPEED: '6.8'
- MMSI: '229001000'
IMO: '7827213'
SHIP_ID: '1448'
LAT: '37.938670'
LON: '23.634450'
SPEED: '0'
HEADING: '511'
COURSE: '320'
STATUS: '5'
TIMESTAMP: '2020-10-15T12:17:20.000Z'
DSRC: TER
UTC_SECONDS: '20'
SHIPNAME: CELESTYAL CRYSTAL
SHIPTYPE: '36'
CALLSIGN: 9HA2978
FLAG: MT
LENGTH: '162'
WIDTH: '24'
GRT: '25611'
DWT: '1703'
DRAUGHT: '61'
YEAR_BUILT: '1980'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: PIRAEUS
ETA: '2021-03-14T05:40:00.000Z'
CURRENT_PORT: PIRAEUS
LAST_PORT: KUSADASI
LAST_PORT_TIME: '2020-03-13T17:38:00.000Z'
CURRENT_PORT_ID: '1'
CURRENT_PORT_UNLOCODE: GRPIR
CURRENT_PORT_COUNTRY: GR
LAST_PORT_ID: '17208'
LAST_PORT_UNLOCODE: TRKUS
LAST_PORT_COUNTRY: TR
NEXT_PORT_ID: '1'
NEXT_PORT_UNLOCODE: GRPIR
NEXT_PORT_NAME: PIRAEUS
NEXT_PORT_COUNTRY: GR
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '194'
AVG_SPEED: '14.6'
MAX_SPEED: '16.7'
200_ps05_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
200_ps05_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
SHIPNAME: ACHILLES
SHIPTYPE: '37'
CALLSIGN: SVA6160
FLAG: GR
LENGTH: '15'
WIDTH: '5'
GRT: ''
DWT: ''
DRAUGHT: '0'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Pleasure Craft
AIS_TYPE_SUMMARY: Pleasure Craft
DESTINATION: CLASS B
ETA: ''
200_ps05_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port.
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: AGIOI THEODOROI
LAST_PORT_TIME: '2020-10-13T23:39:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '29'
LAST_PORT_UNLOCODE: GRAGT
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '74'
AVG_SPEED: '12.6'
MAX_SPEED: '13.2'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
SHIPNAME: ACHILLES
SHIPTYPE: '37'
CALLSIGN: SVA6160
FLAG: GR
LENGTH: '15'
WIDTH: '5'
GRT: ''
DWT: ''
DRAUGHT: '0'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Pleasure Craft
AIS_TYPE_SUMMARY: Pleasure Craft
DESTINATION: CLASS B
ETA: ''
CURRENT_PORT: KYTHNOS
LAST_PORT: SERIFOS
LAST_PORT_TIME: '2020-10-15T07:54:00.000Z'
CURRENT_PORT_ID: '19'
CURRENT_PORT_UNLOCODE: GRKYT
CURRENT_PORT_COUNTRY: GR
LAST_PORT_ID: '35'
LAST_PORT_UNLOCODE: GRSER
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '22'
AVG_SPEED: '5.8'
MAX_SPEED: '6.4'
200_ps06_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '538006210'
IMO: '9314105'
SHIP_ID: '475106'
LAT: '36.007480'
LON: '22.291650'
SPEED: '4'
HEADING: '273'
COURSE: '49'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:26:10.000Z'
DSRC: TER
UTC_SECONDS: '7'
- MMSI: '355281000'
IMO: '9590826'
SHIP_ID: '416371'
LAT: '36.008020'
LON: '22.596420'
SPEED: '144'
HEADING: '95'
COURSE: '94'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:26:02.000Z'
DSRC: TER
UTC_SECONDS: '59'
200_ps06_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '249046000'
IMO: '9192399'
SHIP_ID: '287622'
LAT: '37.023900'
LON: '23.123580'
SPEED: '6'
HEADING: '25'
COURSE: '304'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:23:22.000Z'
DSRC: TER
UTC_SECONDS: '19'
SHIPNAME: CELEBRITY CONSTELLATION
SHIPTYPE: '60'
CALLSIGN: 9HJB9
FLAG: MT
LENGTH: '294'
WIDTH: '37.4'
GRT: '90940'
DWT: '11763'
DRAUGHT: '83'
YEAR_BUILT: '2002'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: PIRAEUS ANCHORAGE
ETA: '2020-10-26T06:00:00.000Z'
- MMSI: '271000973'
IMO: '9458250'
SHIP_ID: '335299'
LAT: '37.156790'
LON: '23.799120'
SPEED: '116'
HEADING: '212'
COURSE: '212'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:22:35.000Z'
DSRC: TER
UTC_SECONDS: '35'
SHIPNAME: ULUSOY 8
SHIPTYPE: '70'
CALLSIGN: TCSS9
FLAG: TR
LENGTH: '159.9'
WIDTH: '24'
GRT: '14852'
DWT: '22303'
DRAUGHT: '99'
YEAR_BUILT: '2008'
ROT: '0'
TYPE_NAME: Bulk Carrier
AIS_TYPE_SUMMARY: Cargo
DESTINATION: GI GIB
ETA: '2020-10-20T17:00:00.000Z'
200_ps06_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port.
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '249046000'
IMO: '9192399'
SHIP_ID: '287622'
LAT: '37.023900'
LON: '23.123580'
SPEED: '6'
HEADING: '25'
COURSE: '304'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:23:22.000Z'
DSRC: TER
UTC_SECONDS: '19'
SHIPNAME: CELEBRITY CONSTELLATION
SHIPTYPE: '60'
CALLSIGN: 9HJB9
FLAG: MT
LENGTH: '294'
WIDTH: '37.4'
GRT: '90940'
DWT: '11763'
DRAUGHT: '83'
YEAR_BUILT: '2002'
ROT: '0'
TYPE_NAME: Passenger Ship
AIS_TYPE_SUMMARY: Passenger
DESTINATION: PIRAEUS ANCHORAGE
ETA: '2020-10-26T06:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: PIRAEUS
LAST_PORT_TIME: '2020-07-31T08:56:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '1'
LAST_PORT_UNLOCODE: GRPIR
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: '1'
NEXT_PORT_UNLOCODE: GRPIR
NEXT_PORT_NAME: PIRAEUS
NEXT_PORT_COUNTRY: GR
ETA_CALC: '2020-10-14T17:00:00.000Z'
ETA_UPDATED: '2020-10-14T05:59:00.000Z'
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '3156'
AVG_SPEED: '6'
MAX_SPEED: '6.7'
- MMSI: '271000973'
IMO: '9458250'
SHIP_ID: '335299'
LAT: '37.156790'
LON: '23.799120'
SPEED: '116'
HEADING: '212'
COURSE: '212'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:22:35.000Z'
DSRC: TER
UTC_SECONDS: '35'
SHIPNAME: ULUSOY 8
SHIPTYPE: '70'
CALLSIGN: TCSS9
FLAG: TR
LENGTH: '159.9'
WIDTH: '24'
GRT: '14852'
DWT: '22303'
DRAUGHT: '99'
YEAR_BUILT: '2008'
ROT: '0'
TYPE_NAME: Bulk Carrier
AIS_TYPE_SUMMARY: Cargo
DESTINATION: GI GIB
ETA: '2020-10-20T17:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: ODESSA
LAST_PORT_TIME: '2020-10-12T05:24:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '124'
LAST_PORT_UNLOCODE: UAODS
LAST_PORT_COUNTRY: UA
NEXT_PORT_ID: '186'
NEXT_PORT_UNLOCODE: GIGIB
NEXT_PORT_NAME: GIBRALTAR
NEXT_PORT_COUNTRY: GI
ETA_CALC: '2020-10-21T00:39:00.000Z'
ETA_UPDATED: '2020-10-15T12:02:00.000Z'
DISTANCE_TO_GO: '1454'
DISTANCE_TRAVELLED: '704'
AVG_SPEED: '11.3'
MAX_SPEED: '13'
200_ps07_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
example:
- MMSI: '310627000'
LAT: '50.510560'
LON: '-3.452753'
SPEED: '0'
HEADING: '347'
COURSE: '321'
STATUS: '1'
TIMESTAMP: '2020-10-13T12:21:16.000Z'
DSRC: TER
200_ps07_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
example:
- MMSI: '310627000'
LAT: '-35.564580'
LON: '126.044800'
SPEED: '226'
HEADING: '89'
COURSE: '89'
STATUS: '0'
TIMESTAMP: '2017-02-14T16:14:00.000Z'
SHIPNAME: QUEEN MARY 2
SHIPTYPE: '60'
TYPE_NAME: Passengers Ship
AIS_TYPE_SUMMARY: Passenger
IMO: '9241061'
CALLSIGN: ZCEF6
FLAG: BM
PORT_ID: null
PORT_UNLOCODE: null
CURRENT_PORT: null
LAST_PORT_ID: '768'
LAST_PORT_UNLOCODE: AUFRE
LAST_PORT: FREMANTLE
LAST_PORT_TIME: '2017-02-12T12:47:00.000Z'
DESTINATION: ADELAIDE
ETA: '2017-02-15T23:00:00.000Z'
ETA_CALC: '2017-02-15T21:30:00.000Z'
LENGTH: '345.03'
WIDTH: '48.7'
DRAUGHT: '101'
GRT: '149215'
NEXT_PORT_ID: '890'
NEXT_PORT_UNLOCODE: AUADL
NEXT_PORT_NAME: ADELAIDE
NEXT_PORT_COUNTRY: AU
DWT: '19189'
YEAR_BUILT: '2003'
DSRC: SAT
400_ps07__missing_ship_identifier:
title: ' Missing ship identifier'
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
200_ps08_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
200_ps08_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
SHIPNAME: ACHILLES
SHIPTYPE: '37'
CALLSIGN: SVA6160
FLAG: GR
LENGTH: '15'
WIDTH: '5'
GRT: ''
DWT: ''
DRAUGHT: '0'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Pleasure Craft
AIS_TYPE_SUMMARY: Pleasure Craft
DESTINATION: CLASS B
ETA: ''
200_ps08_full:
title: Full
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Data Source - Defines whether the transmitted AIS data was received by a Terrestrial or a Satellite
AIS Station
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The Type of the subject vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
CURRENT_PORT: ''
LAST_PORT: AGIOI THEODOROI
LAST_PORT_TIME: '2020-10-13T23:39:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '29'
LAST_PORT_UNLOCODE: GRAGT
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '74'
AVG_SPEED: '12.6'
MAX_SPEED: '13.2'
- MMSI: '239885200'
IMO: '0'
SHIP_ID: '3463456'
LAT: '37.390210'
LON: '24.396990'
SPEED: '1'
HEADING: '511'
COURSE: '0'
STATUS: '99'
TIMESTAMP: '2020-10-15T12:21:29.000Z'
DSRC: TER
UTC_SECONDS: '29'
SHIPNAME: ACHILLES
SHIPTYPE: '37'
CALLSIGN: SVA6160
FLAG: GR
LENGTH: '15'
WIDTH: '5'
GRT: ''
DWT: ''
DRAUGHT: '0'
YEAR_BUILT: ''
ROT: '0'
TYPE_NAME: Pleasure Craft
AIS_TYPE_SUMMARY: Pleasure Craft
DESTINATION: CLASS B
ETA: ''
CURRENT_PORT: KYTHNOS
LAST_PORT: SERIFOS
LAST_PORT_TIME: '2020-10-15T07:54:00.000Z'
CURRENT_PORT_ID: '19'
CURRENT_PORT_UNLOCODE: GRKYT
CURRENT_PORT_COUNTRY: GR
LAST_PORT_ID: '35'
LAST_PORT_UNLOCODE: GRSER
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '22'
AVG_SPEED: '5.8'
MAX_SPEED: '6.4'
200_MTA030AD:
title: Default
type: object
properties:
DATA:
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the
Earth's surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the
Earth's surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might
be discrepancies with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Describes whether the transmitted AIS message was received by a terrestrial (TER), satellite
(SAT) or roaming (ROAM) AIS antenna.
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
MARKET:
type: string
description: Vessel's commercial market
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of
a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding
the vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
SHIP_COUNTRY:
type: string
description: The vessel's country
SHIP_CLASS:
type: string
description: Vessel's class based on commercial market, capacity and/or dimensions
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The MarineTraffic ship type of the vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
L_FORE:
type: string
description: The relative distance from the AIS station of the vessel to the foremost of it (front / bow)
W_LEFT:
type: string
description: The relative distance from the AIS station of the vessel to the leftmost of it (left side / port)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported
Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure).
This value updates gradually and may lag behind the current speed following a sudden acceleration or shortly
after port departure.
METADATA:
type: object
properties:
CURSOR:
type: string
description: The pagination cursor that should be provided in the next request
DATE_FROM:
type: string
description: The starting date of the returned positions
format: date-time
DATE_TO:
type: string
description: The ending date of the returned positions
format: date-time
example:
DATA:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
MARKET: SUPPORTING VESSELS
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
SHIP_COUNTRY: Marshall Is
SHIP_CLASS: HANDYSIZE
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
L_FORE: '5'
W_LEFT: '5'
CURRENT_PORT: ''
LAST_PORT: AGIOI THEODOROI
LAST_PORT_TIME: '2020-10-13T23:39:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '29'
LAST_PORT_UNLOCODE: GRAGT
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '74'
AVG_SPEED: '12.6'
MAX_SPEED: '13.2'
METADATA:
CURSOR: abcdef
DATE_FROM: '2023-11-20 15:57:00'
DATE_TO: '2023-11-20 16:57:00'
200_MTA030AD_single:
title: Default
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
HEADING:
type: string
description: The heading (in degrees) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
DSRC:
type: string
description: Describes whether the transmitted AIS message was received by a terrestrial, satellite or roaming
AIS antenna
UTC_SECONDS:
type: string
description: The time slot that the subject vessel uses to transmit information
MARKET:
type: string
description: Vessel's commercial market
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
SHIP_COUNTRY:
type: string
description: The vessel's country
SHIP_CLASS:
type: string
description: Vessel's class based on commercial market, capacity and/or dimensions
ROT:
type: string
description: Rate of Turn
TYPE_NAME:
type: string
description: The MarineTraffic ship type of the vessel
AIS_TYPE_SUMMARY:
type: string
description: Further explanation of the SHIPTYPE ID
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
L_FORE:
type: string
description: The relative distance from the AIS station of the vessel to the foremost of it (front / bow)
W_LEFT:
type: string
description: The relative distance from the AIS station of the vessel to the leftmost of it (left side / port)
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
CURRENT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
CURRENT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
AVG_SPEED:
type: string
description: The average speed of the vessel (in knots) during the current voyage (since last port departure),
calculated using AIS position readings from the last 24 hours where speed exceeds 5 knots.
MAX_SPEED:
type: string
description: The maximum speed (in knots) recorded during the current voyage (since last port departure). This
value updates gradually and may lag behind the current speed following a sudden acceleration or shortly after
port departure.
example:
- MMSI: '538003913'
IMO: '9470959'
SHIP_ID: '713139'
LAT: '37.388430'
LON: '23.871230'
SPEED: '6'
HEADING: '104'
COURSE: '41'
STATUS: '0'
TIMESTAMP: '2020-10-15T12:21:44.000Z'
DSRC: TER
UTC_SECONDS: '45'
MARKET: SUPPORTING VESSELS
SHIPNAME: SUNNY STAR
SHIPTYPE: '89'
CALLSIGN: V7TZ6
FLAG: MH
LENGTH: '184'
WIDTH: '27.43'
GRT: '23313'
DWT: '37857'
DRAUGHT: '95'
YEAR_BUILT: '2010'
SHIP_COUNTRY: Marshall Is
SHIP_CLASS: HANDYSIZE
ROT: '0'
TYPE_NAME: Oil/Chemical Tanker
AIS_TYPE_SUMMARY: Tanker
DESTINATION: FOR ORDERS
ETA: '2020-10-14T12:00:00.000Z'
L_FORE: '5'
W_LEFT: '5'
CURRENT_PORT: ''
LAST_PORT: AGIOI THEODOROI
LAST_PORT_TIME: '2020-10-13T23:39:00.000Z'
CURRENT_PORT_ID: ''
CURRENT_PORT_UNLOCODE: ''
CURRENT_PORT_COUNTRY: ''
LAST_PORT_ID: '29'
LAST_PORT_UNLOCODE: GRAGT
LAST_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA_CALC: ''
ETA_UPDATED: ''
DISTANCE_TO_GO: '0'
DISTANCE_TRAVELLED: '74'
AVG_SPEED: '12.6'
MAX_SPEED: '13.2'
200_ev01_default:
title: Simple
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
SHIPNAME:
type: string
description: The Shipname of the subject vessel
TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) of the Port Call
format: date-time
TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) of the Port Call
format: date-time
MOVE_TYPE:
type: string
description: 0 or 1 - specifies the Port Call type (0 = Arrival, 1 = Departure)
TYPE_NAME:
type: string
description: The Type of the subject vessel
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_NAME:
type: string
description: The Name of the subject Port
PORT_COUNTRY_CODE:
type: string
description: The Country Code of the subject Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the subject Port
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
example:
- SHIP_ID: '3351323'
IMO: '0'
MMSI: '244770588'
SHIPNAME: PIETERNELLA
TIMESTAMP_LT: '2020-10-20T12:15:00'
TIMESTAMP_UTC: '2020-10-20T10:15:00'
MOVE_TYPE: '0'
TYPE_NAME: Inland, Unknown
PORT_ID: '1766'
PORT_NAME: AMSTERDAM
PORT_COUNTRY_CODE: ''
PORT_UNLOCODE: NLAMS
MARKET: null
- SHIP_ID: '241767'
IMO: '0'
MMSI: '244690666'
SHIPNAME: BRABANT
TIMESTAMP_LT: '2020-10-20T12:14:00'
TIMESTAMP_UTC: '2020-10-20T10:14:00'
MOVE_TYPE: '1'
TYPE_NAME: Inland, Motor Freighter
PORT_ID: '1766'
PORT_NAME: AMSTERDAM
PORT_COUNTRY_CODE: ''
PORT_UNLOCODE: NLAMS
MARKET: null
200_ev01_extended:
title: Extended
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
SHIPNAME:
type: string
description: The Shipname of the subject vessel
TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) of the Port Call
format: date-time
TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) of the Port Call
format: date-time
MOVE_TYPE:
type: string
description: 0 or 1 - specifies the Port Call type (0 = Arrival, 1 = Departure)
TYPE_NAME:
type: string
description: The Type of the subject vessel
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_NAME:
type: string
description: The Name of the subject Port
PORT_COUNTRY_CODE:
type: string
description: The Country Code of the subject Port
PORT_LAT:
type: string
description: The latitude of the subject Port
PORT_LON:
type: string
description: The longitude of the subject Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the subject Port
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
LOAD_STATUS:
type: string
description: 'The load status of the subject vessel (0 : N/A, 1 : In Ballast, 2 : Partially Laden, 3 : Fully Laden)
Available after 2017-10-01 (YYYY-MM-DD)'
PORT_OPERATION:
type: string
description: 'Indicates LOAD/DISCHARGE operations in the subject Port Call event (0 : N/A, 1 : load, 2 : discharge,
3 : both, 4 : none) Available after 2017-10-01 (YYYY-MM-DD)'
INTRANSIT:
type: string
description: 0 or 1 - specifies whether the vessel anchored in the Port or was In Transit (1 = In Transit)
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
VOYAGE_SPEED_AVG:
type: string
description: Average Maintained Speed (in knots x10) since the last Port Call while steaming at speed > 5 knots
- Updated upon Arrival
VOYAGE_SPEED_MAX:
type: string
description: Maximum Recorded Speed (in knots x10) since the last Port Call - Updated upon Arrival
VOYAGE_IDLE_TIME_MINS:
type: string
description: Total time in minutes since the previous Port Call while the vessel stopped or moving at speed <
3 knots - Updated upon Arrival
ELAPSED_NOANCH:
type: string
description: Total time of Voyage since the previous Port Call except Anchorages and Canals - Updated upon Arrival
DISTANCE_LEG:
type: string
description: The distance (in NM) between the last two calls regardless of Port Type
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
SHIPCLASS:
type: string
description: The class of the subject vessel based on vessel type and size
example:
- SHIP_ID: '3351323'
IMO: '0'
MMSI: '244770588'
SHIPNAME: PIETERNELLA
TIMESTAMP_LT: '2020-10-20T12:15:00'
TIMESTAMP_UTC: '2020-10-20T10:15:00'
MOVE_TYPE: '0'
TYPE_NAME: Inland, Unknown
PORT_ID: '1766'
PORT_NAME: AMSTERDAM
PORT_COUNTRY_CODE: ''
PORT_LAT: ''
PORT_LON: ''
PORT_UNLOCODE: NLAMS
DRAUGHT: '59'
LOAD_STATUS: '0'
PORT_OPERATION: '0'
INTRANSIT: '0'
DISTANCE_TRAVELLED: '0'
VOYAGE_SPEED_AVG: null
VOYAGE_SPEED_MAX: null
VOYAGE_IDLE_TIME_MINS: null
ELAPSED_NOANCH: '672'
DISTANCE_LEG: null
MARKET: DRY BREAKBULK
SHIPCLASS: null
- SHIP_ID: '241767'
IMO: '0'
MMSI: '244690666'
SHIPNAME: BRABANT
TIMESTAMP_LT: '2020-10-20T12:14:00.000Z'
TIMESTAMP_UTC: '2020-10-20T10:14:00.000Z'
MOVE_TYPE: '1'
TYPE_NAME: Inland, Motor Freighter
PORT_ID: '1766'
PORT_NAME: AMSTERDAM
PORT_COUNTRY_CODE: ''
PORT_LAT: ''
PORT_LON: ''
PORT_UNLOCODE: NLAMS
DRAUGHT: '18'
LOAD_STATUS: '0'
PORT_OPERATION: '0'
INTRANSIT: '0'
DISTANCE_TRAVELLED: '76'
VOYAGE_SPEED_AVG: '86'
VOYAGE_SPEED_MAX: '102'
VOYAGE_IDLE_TIME_MINS: '525'
ELAPSED_NOANCH: '1057'
DISTANCE_LEG: '17'
MARKET: DRY BREAKBULK
SHIPCLASS: null
400_ev01_date_range_out_of_bounds:
title: Date range out of bounds
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1g
detail: DATE RANGE OUT OF BOUNDS
400_ev01_missing_ship_identifier:
title: Missing ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE MISSING
400_ev01_polling_range_out_of_limit:
title: Polling range out of limit
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1f
detail: POLLING RANGE MAXIMUM IS 190 DAYS
200_ev02_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
SHIPNAME:
type: string
description: The Shipname of the subject vessel
EVENT_ID:
type: string
description: The ID of the subject event - more
EVENT_NAME:
type: string
description: The Name of the subject Event
EVENT_CONTENT:
type: string
description: The description of the subject Event
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
example:
- MMSI: '310624000'
IMO: ''
SHIP_ID: ''
SHIPNAME: QUEEN VICTORIA
EVENT_ID: '1'
EVENT_NAME: FIRST_DAILY_POS
EVENT_CONTENT: At N 50° 12' 06.53'' - W 002° 41' 31.37''
TIMESTAMP: '2020-10-20T00:13:00.000Z'
- MMSI: '310624000'
IMO: ''
SHIP_ID: ''
SHIPNAME: QUEEN VICTORIA
EVENT_ID: '6'
EVENT_NAME: UNDERWAY
EVENT_CONTENT: At N 50° 35' 15.59'' - W 002° 21' 27.11''
TIMESTAMP: '2020-10-19T19:56:00.000Z'
400_ev02_invalid_date_range:
title: Invalid date range
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1g
detail: DATE RANGE OUT OF BOUNDS
400_ev02_missing_ship_identifier:
title: Missing ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE MISSING
400_ev02_polling_range_out_of_limit:
title: Polling range out of limit
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1f
detail: POLLING RANGE MAXIMUM IS 190 DAYS
200_ev03_default:
title: Simple
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
DOCK_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel was Docked at the Berth
format: date-time
DOCK_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel was Docked at the Berth
format: date-time
DOCK_TIMESTAMP_OFFSET:
type: string
description: The time zone offset at the time of arrival/docking
UNDOCK_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel was Undocked from the Berth
format: date-time
UNDOCK_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel was Undocked from the Berth
format: date-time
UNDOCK_TIMESTAMP_OFFSET:
type: string
description: The time zone offset at the time of undocking/departure
SHIPNAME:
type: string
description: The Shipname of the subject vessel
TYPE_NAME:
type: string
description: The Type of the subject vessel.
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
BERTH_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Berth
BERTH_NAME:
type: string
description: The Name of the subject Berth
TERMINAL_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Terminal where the Berth belongs (if available)
TERMINAL_NAME:
type: string
description: The Name of the Terminal where the Berth belongs (if available)
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_NAME:
type: string
description: The Name of the subject Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the subject Port
PORT_COUNTRY_CODE:
type: string
description: The Country of the subject Port
DESTINATION_ID:
type: string
description: Api Rspfield Destination Id
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
example:
- SHIP_ID: '5567750'
MMSI: '237710500'
IMO: '0'
DOCK_TIMESTAMP_LT: '2020-10-20 06:22:00'
DOCK_TIMESTAMP_UTC: '2020-10-20 03:22:00'
DOCK_TIMESTAMP_OFFSET: '3.000000'
UNDOCK_TIMESTAMP_LT: '2020-10-20 06:45:00'
UNDOCK_TIMESTAMP_UTC: '2020-10-20 03:45:00'
UNDOCK_TIMESTAMP_OFFSET: '3.000000'
SHIPNAME: PILOT BOAT PY56
TYPE_NAME: Pilot Vessel
DWT: null
GRT: null
FLAG: GR
YEAR_BUILT: null
BERTH_ID: '6'
BERTH_NAME: Container Terminal
TERMINAL_ID: '978'
TERMINAL_NAME: Container Terminal
PORT_ID: '1'
PORT_NAME: PIRAEUS
PORT_UNLOCODE: GRPIR
PORT_COUNTRY_CODE: GR
DESTINATION_ID: '1'
DESTINATION: PIRAEUS
MARKET: null
- SHIP_ID: '213328'
MMSI: '240612000'
IMO: '8008254'
DOCK_TIMESTAMP_LT: '2020-10-20 06:24:00'
DOCK_TIMESTAMP_UTC: '2020-10-20 03:24:00'
DOCK_TIMESTAMP_OFFSET: '3.000000'
UNDOCK_TIMESTAMP_LT: '2020-10-20 06:49:00'
UNDOCK_TIMESTAMP_UTC: '2020-10-20 03:49:00'
UNDOCK_TIMESTAMP_OFFSET: '3.000000'
SHIPNAME: IFESTOS 3
TYPE_NAME: Tug
DWT: null
GRT: '191'
FLAG: GR
YEAR_BUILT: '1980'
BERTH_ID: '6'
BERTH_NAME: Container Terminal
TERMINAL_ID: '978'
TERMINAL_NAME: Container Terminal
PORT_ID: '1'
PORT_NAME: PIRAEUS
PORT_UNLOCODE: GRPIR
PORT_COUNTRY_CODE: GR
DESTINATION_ID: null
DESTINATION: null
MARKET: null
200_ev03_extended:
title: Extended
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
DOCK_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel was Docked at the Berth
format: date-time
DOCK_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel was Docked at the Berth
format: date-time
DOCK_TIMESTAMP_OFFSET:
type: string
description: The time zone offset at the time of arrival/docking
UNDOCK_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel was Undocked from the Berth
format: date-time
UNDOCK_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel was Undocked from the Berth
format: date-time
UNDOCK_TIMESTAMP_OFFSET:
type: string
description: The time zone offset at the time of undocking/departure
SHIPNAME:
type: string
description: The Shipname of the subject vessel
TYPE_NAME:
type: string
description: The Type of the subject vessel.
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
BERTH_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Berth
BERTH_NAME:
type: string
description: The Name of the subject Berth
TERMINAL_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Terminal where the Berth belongs (if available)
TERMINAL_NAME:
type: string
description: The Name of the Terminal where the Berth belongs (if available)
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_NAME:
type: string
description: The Name of the subject Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the subject Port
PORT_COUNTRY_CODE:
type: string
description: The Country of the subject Port
DESTINATION_ID:
type: string
description: Api Rspfield Destination Id
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
ARR_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel arrived at the port, before the docking
format: date-time
ARR_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel arrived at the port, before the docking
format: date-time
ARR_DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel, at the time of arrival, according to the AIS transmissions
ARR_LOAD_STATUS:
type: string
description: 'The load status of the subject vessel (0 : N/A, 1 : In Ballast, 2 : Partially Laden, 3 : Fully Laden)
at the time of arrival'
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
VOYAGE_SPEED_AVG:
type: string
description: Average Maintained Speed (in knots x10) since the last Port Call while steaming at speed > 5 knots
- Updated upon Arrival
VOYAGE_SPEED_MAX:
type: string
description: Maximum Recorded Speed (in knots x10) since the last Port Call - Updated upon Arrival
VOYAGE_IDLE_TIME_MINS:
type: string
description: Total time in minutes since the previous Port Call while the vessel stopped or moving at speed <
3 knots - Updated upon Arrival
PREVIOUS_NOANCH_ID:
type: string
description: Identifier of the zone where the current voyage started, defined as either the last port call or
any other zone (for example, an anchorage) where a substantial draught change was detected. This zone marks
the origin of the current voyage.
PREVIOUS_NOANCH_TIMESTAMP:
type: string
description: The time of Departure from the zone that has been identified as an origin for the current voyage
(in UTC)
format: date-time
PREVIOUS_NOANCH_NAME:
type: string
description: Name of the zone identified by PREVIOUS_NOANCH_ID, representing the starting zone of the current
voyage.
ELAPSED_NOANCH:
type: string
description: Elapsed time in minutes between PREVIOUS_NOANCH_TIMESTAMP (start of current voyage) and the vessel
arrival timestamp for this berth call. Updated upon arrival
DEP_TIMESTAMP_LT:
type: string
description: The Date and Time (in Local Time) the subject vessel departed from the port, after the undocking
format: date-time
DEP_TIMESTAMP_UTC:
type: string
description: The Date and Time (in UTC) the subject vessel departed from the port, after the undocking
format: date-time
DEP_DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel, at the time of departure, according to the AIS
transmissions
DEP_LOAD_STATUS:
type: string
description: 'The load status of the subject vessel (0 : N/A, 1 : In Ballast, 2 : Partially Laden, 3 : Fully Laden)
at the time of departure'
PORT_OPERATION:
type: string
description: 'Indicates LOAD/DISCHARGE operations in the subject Port Call event (0 : N/A, 1 : load, 2 : discharge,
3 : both, 4 : none)'
TIME_AT_BERTH:
type: string
description: The total time in minutes that the vessel stayed at berth
TIME_AT_PORT:
type: string
description: The total time in minutes that the vessel stayed at port
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
SHIPCLASS:
type: string
description: The class of the subject vessel based on vessel type and size
example:
- SHIP_ID: '5568705'
MMSI: '237710400'
IMO: '0'
DOCK_TIMESTAMP_LT: '2020-10-20 15:40:00'
DOCK_TIMESTAMP_UTC: '2020-10-20 12:40:00'
DOCK_TIMESTAMP_OFFSET: '3.000000'
UNDOCK_TIMESTAMP_LT: '2020-10-20 15:43:00'
UNDOCK_TIMESTAMP_UTC: '2020-10-20 12:43:00'
UNDOCK_TIMESTAMP_OFFSET: '3.000000'
SHIPNAME: PILOT BOAT PY55
TYPE_NAME: Pilot Vessel
DWT: null
GRT: null
FLAG: GR
YEAR_BUILT: null
BERTH_ID: '6'
BERTH_NAME: Container Terminal
TERMINAL_ID: '978'
TERMINAL_NAME: Container Terminal
PORT_ID: '1'
PORT_NAME: PIRAEUS
PORT_UNLOCODE: GRPIR
PORT_COUNTRY_CODE: GR
DESTINATION_ID: null
DESTINATION: null
ARR_TIMESTAMP_LT: '2020-10-20 15:25:00'
ARR_TIMESTAMP_UTC: '2020-10-20 12:25:00'
ARR_DRAUGHT: '0'
ARR_LOAD_STATUS: '0'
DISTANCE_TRAVELLED: '2'
VOYAGE_SPEED_AVG: '166'
VOYAGE_SPEED_MAX: '166'
VOYAGE_IDLE_TIME_MINS: '0'
PREVIOUS_NOANCH_ID: '1'
PREVIOUS_NOANCH_TIMESTAMP: '2020-10-20 12:22:00'
PREVIOUS_NOANCH_NAME: PIRAEUS
ELAPSED_NOANCH: '3'
DEP_TIMESTAMP_LT: null
DEP_TIMESTAMP_UTC: null
DEP_DRAUGHT: null
DEP_LOAD_STATUS: null
PORT_OPERATION: null
TIME_AT_BERTH: '3'
TIME_AT_PORT: null
MARKET: SUPPORTING VESSELS
SHIPCLASS: null
- SHIP_ID: '5568705'
MMSI: '237710400'
IMO: '0'
DOCK_TIMESTAMP_LT: '2020-10-20 15:49:00'
DOCK_TIMESTAMP_UTC: '2020-10-20 12:49:00'
DOCK_TIMESTAMP_OFFSET: '3.000000'
UNDOCK_TIMESTAMP_LT: null
UNDOCK_TIMESTAMP_UTC: null
UNDOCK_TIMESTAMP_OFFSET: null
SHIPNAME: PILOT BOAT PY55
TYPE_NAME: Pilot Vessel
DWT: null
GRT: null
FLAG: GR
YEAR_BUILT: null
BERTH_ID: '9'
BERTH_NAME: Cruise Terminal
TERMINAL_ID: '979'
TERMINAL_NAME: Passenger Terminal
PORT_ID: '1'
PORT_NAME: PIRAEUS
PORT_UNLOCODE: GRPIR
PORT_COUNTRY_CODE: GR
DESTINATION_ID: null
DESTINATION: null
ARR_TIMESTAMP_LT: '2020-10-20 15:25:00'
ARR_TIMESTAMP_UTC: '2020-10-20 12:25:00'
ARR_DRAUGHT: '0'
ARR_LOAD_STATUS: '0'
DISTANCE_TRAVELLED: '2'
VOYAGE_SPEED_AVG: '166'
VOYAGE_SPEED_MAX: '166'
VOYAGE_IDLE_TIME_MINS: '0'
PREVIOUS_NOANCH_ID: '1'
PREVIOUS_NOANCH_TIMESTAMP: '2020-10-20 12:22:00'
PREVIOUS_NOANCH_NAME: PIRAEUS
ELAPSED_NOANCH: '3'
DEP_TIMESTAMP_LT: null
DEP_TIMESTAMP_UTC: null
DEP_DRAUGHT: null
DEP_LOAD_STATUS: null
PORT_OPERATION: null
TIME_AT_BERTH: null
TIME_AT_PORT: null
MARKET: SUPPORTING VESSELS
SHIPCLASS: null
400_ev03_date_range_out_of_bounds:
title: Date range out of bounds
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1g
detail: DATE RANGE OUT OF BOUNDS
400_ev03_missing_ship_identifier:
title: Missing ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a8
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE OR BERTHID OR TERMINALID MISSING
400_ev03_polling_range_out_of_limit:
title: Polling range out of limit
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 1m
detail: POLLING RANGE EXCEEDED BY 15 DAYS
400_ev01_missing_port_identifier:
title: Missing port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE MISSING
400_ev03_missing_port_identifier:
title: Missing port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a8
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE OR BERTHID OR TERMINALID MISSING
200_vd01_default:
title: Simple
type: array
items:
type: object
properties:
URL:
type: string
description: The URL of the photo.
example:
- URL: https://photos.marinetraffic.com/ais/showphoto.aspx?photoid=534918
400_vd01_missing_or_invalid_ship_identifier:
title: Missing or invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
200_vd02_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
ENI:
type: string
description: European Number of Identification - a unique eight-digit registration number for vessels capable
of navigating on inland European waters
NAME:
type: string
description: The Name of the subject vessel
BUILDER:
type: string
description: The Builder of the subject vessel
PLACE_OF_BUILD:
type: string
description: The place the subject vessel was built at
BUILD:
type: string
description: The year that the subject vessel was built
YARD_NUMBER:
type: string
description: The number assigned to the subject vessel from the Shipyard (prior to her commercial name)
BREADTH_EXTREME:
type: string
description: The extreme breadth (in metres) of the subject vessel
BREADTH_MOULDED:
type: string
description: The Moulded Breadth (in meters) of the subject vessel
DEPTH:
type: string
description: The Extreme Depth (in meters) of the subject vessel
SUMMER_DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DISPLACEMENT_SUMMER:
type: string
description: Displacement - a measure of the vessel's weight
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions - more
DRAUGHT:
type: string
description: The Maximum Draught (in metres) of the subject vessel
LENGHT_OVERALL:
type: string
description: The Overall Length (in metres) of the subject vessel
LENGTH_B_W_PERPENDICULARS:
type: string
description: The Length (in meters) measured between perpendiculars for the subject vessel
FUEL_CONSUMPTION:
type: string
description: The Fuel Consumption of the subject vessel
SPEED_MAX:
type: string
description: The Maximum Operational Speed of the subject vessel
SPEED_SERVICE:
type: string
description: The Speed that the vessel is designed to sail under certain conditions
TEU:
type: string
description: The Capacity of a containership measured in twenty-foot equivalent units (TEU)
GROSS_TONNAGE:
type: string
description: The Gross Tonnage of the subject vessel
NET_TONNAGE:
type: string
description: The Net Tonnage of the subject vessel
LIQUID_OIL:
type: string
description: The Capacity (in cubic metres) of the wet cargo the vessel can carry
LIQUID_GAS:
type: string
description: The Capacity (in cubic metres) of the gas cargo the vessel can carry
GRAIN:
type: string
description: The Capacity (in cubic metres) of the grain cargo the vessel can carry
OWNER:
type: string
description: The Owning Company of the subject vessel
MANAGER:
type: string
description: The Managing Company of the subject vessel
FINANCIAL_OWNER:
type: string
description: The Financial Owner of the subject vessel
TECHNICAL_MANAGER:
type: string
description: The Technical Manager of the subject vessel
INSURER:
type: string
description: The Insurer of the subject vessel
VESSEL_TYPE:
type: string
description: The specific type of the subject vessel
example:
- MMSI: '440389000'
IMO: '9360283'
ENI: null
NAME: DONGJIN AUBE
BUILDER: HAKATA SHIPBUILDING
PLACE_OF_BUILD: MATSUYAMA JAPAN
BUILD: '2005'
YARD_NUMBER: HN. 670
BREADTH_EXTREME: '25'
BREADTH_MOULDED: '25'
DEPTH: '13.7'
SUMMER_DWT: '15220'
DISPLACEMENT_SUMMER: null
CALLSIGN: D7OT
FLAG: KR
DRAUGHT: '8.97'
LENGTH_OVERALL: '147'
LENGTH_B_W_PERPENDICULARS: '135'
FUEL_CONSUMPTION: 36 t/day at 17.50 kn
SPEED_MAX: null
SPEED_SERVICE: '18'
TEU: '1060'
GROSS_TONNAGE: '12679'
NET_TONNAGE: '5614'
LIQUID_OIL: null
LIQUID_GAS: null
GRAIN: null
OWNER: DONG JIN SHIPPING CO LTD
MANAGER: DONG JIN SHIPPING CO LTD
FINANCIAL_OWNER: DONG JIN SHIPPING CO LTD
TECHNICAL_MANAGER: null
INSURER: JAPAN SHIP OWNERS P & I ASSOCIATION
VESSEL_TYPE: CONTAINER SHIP
200_vd02_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
ENI:
type: string
description: European Number of Identification - a unique eight-digit registration number for vessels capable
of navigating on inland European waters
NAME:
type: string
description: The Name of the subject vessel
BUILDER:
type: string
description: The Builder of the subject vessel
PLACE_OF_BUILD:
type: string
description: The place the subject vessel was built at
BUILD:
type: string
description: The year that the subject vessel was built
YARD_NUMBER:
type: string
description: The number assigned to the subject vessel from the Shipyard (prior to her commercial name)
BREADTH_EXTREME:
type: string
description: The extreme breadth (in metres) of the subject vessel
BREADTH_MOULDED:
type: string
description: The Moulded Breadth (in meters) of the subject vessel
DEPTH:
type: string
description: The Extreme Depth (in meters) of the subject vessel
SUMMER_DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
DISPLACEMENT_SUMMER:
type: string
description: Displacement - a measure of the vessel's weight
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions - more
DRAUGHT:
type: string
description: The Maximum Draught (in metres) of the subject vessel
LENGHT_OVERALL:
type: string
description: The Overall Length (in metres) of the subject vessel
LENGTH_B_W_PERPENDICULARS:
type: string
description: The Length (in meters) measured between perpendiculars for the subject vessel
FUEL_CONSUMPTION:
type: string
description: The Fuel Consumption of the subject vessel
SPEED_MAX:
type: string
description: The Maximum Operational Speed of the subject vessel
SPEED_SERVICE:
type: string
description: The Speed that the vessel is designed to sail under certain conditions
TEU:
type: string
description: The Capacity of a containership measured in twenty-foot equivalent units (TEU)
GROSS_TONNAGE:
type: string
description: The Gross Tonnage of the subject vessel
NET_TONNAGE:
type: string
description: The Net Tonnage of the subject vessel
LIQUID_OIL:
type: string
description: The Capacity (in cubic metres) of the wet cargo the vessel can carry
LIQUID_GAS:
type: string
description: The Capacity (in cubic metres) of the gas cargo the vessel can carry
GRAIN:
type: string
description: The Capacity (in cubic metres) of the grain cargo the vessel can carry
OWNER:
type: string
description: The Owning Company of the subject vessel
MANAGER:
type: string
description: The Managing Company of the subject vessel
FINANCIAL_OWNER:
type: string
description: The Financial Owner of the subject vessel
TECHNICAL_MANAGER:
type: string
description: The Technical Manager of the subject vessel
INSURER:
type: string
description: The Insurer of the subject vessel
VESSEL_TYPE:
type: string
description: The specific type of the subject vessel
MANAGER_COUNTRY:
type: string
description: The Managing Company's Country
MANAGER_TOWN:
type: string
description: The Managing Company's Town
MANAGER_WEBSITE:
type: string
description: The Managing Company's Website
OWNER_COUNTRY:
type: string
description: The Owning Company's Country
OWNER_TOWN:
type: string
description: The Owning Company's Town
OWNER_WEBSITE:
type: string
description: The Owning Company's Website
ENGINE_BUILDER:
type: string
description: The builder of the main engine
ENGINE_CYLINDERS:
type: string
description: The number of main engine cylinders
ENGINE_POWER:
type: string
description: Power of main engine in kW
ENGINE_STROKE:
type: string
description: The space the piston travels from top to bottom in mm
ENGINE_NUMBER:
type: string
description: Number of main engines
ENGINE_TYPE:
type: string
description: The type of the main engine
ENGINE_RPM:
type: string
description: Revolutions per minute
CLASS_SOCIETY:
type: string
description: The Classification Society the vessel is registered in
HULL_MATERIAL:
type: string
description: The material the ship is made of
HULL_TYPE:
type: string
description: Defines whether a vessel is double, single hull etc.
DECKS_NUMBER:
type: string
description: Number of decks
PROPELLER:
type: string
description: Number of propellers
L_FORE:
type: string
description: The relative distance from the AIS station of the vessel to the foremost of it (front / bow). Contains
no decimals, always rounded.
W_LEFT:
type: string
description: The relative distance from the AIS station of the vessel to the leftmost of it (left side / port).
Contains no decimals, always rounded.
FINANCIAL_OWNER_COUNTRY:
type: string
description: The Financial Owner's country
TECHNICAL_MANAGER_COUNTRY:
type: string
description: The Technical Manager's country
example:
- MMSI: '440389000'
IMO: '9360283'
ENI: null
NAME: DONGJIN AUBE
BUILDER: HAKATA SHIPBUILDING
PLACE_OF_BUILD: MATSUYAMA JAPAN
BUILD: '2005'
YARD_NUMBER: HN. 670
BREADTH_EXTREME: '25'
BREADTH_MOULDED: '25'
DEPTH: '13.7'
SUMMER_DWT: '15220'
DISPLACEMENT_SUMMER: null
CALLSIGN: D7OT
FLAG: KR
DRAUGHT: '8.97'
LENGTH_OVERALL: '147'
LENGTH_B_W_PERPENDICULARS: '135'
FUEL_CONSUMPTION: 36 t/day at 17.50 kn
SPEED_MAX: null
SPEED_SERVICE: '18'
TEU: '1060'
GROSS_TONNAGE: '12679'
NET_TONNAGE: '5614'
LIQUID_OIL: null
LIQUID_GAS: null
GRAIN: null
OWNER: DONG JIN SHIPPING CO LTD
MANAGER: DONG JIN SHIPPING CO LTD
FINANCIAL_OWNER: DONG JIN SHIPPING CO LTD
TECHNICAL_MANAGER: null
INSURER: JAPAN SHIP OWNERS P & I ASSOCIATION
VESSEL_TYPE: CONTAINER SHIP
MANAGER_COUNTRY: SWITZERLAND
MANAGER_TOWN: null
MANAGER_WEBSITE: http://www.mscgva.ch
OWNER_COUNTRY: SWITZERLAND
OWNER_TOWN: null
OWNER_WEBSITE: http://www.mscgva.ch
ENGINE_BUILDER: MITSUI TAMANO ENGINEERING & SHIPBUILDING
ENGINE_CYLINDERS: '7'
ENGINE_POWER: '9988'
ENGINE_STROKE: '1910'
ENGINE_NUMBER: '1'
ENGINE_TYPE: DIESEL
ENGINE_RPM: '127'
CLASS_SOCIETY: KOREAN REGISTER OF SHIPPING
HULL_MATERIAL: STEEL
HULL_TYPE: SINGLE HULL
DECKS_NUMBER: '616'
PROPELLER: 1 FIXED PITCH
L_FORE: '132'
W_LEFT: '25'
FINANCIAL_OWNER_COUNTRY: null,
TECHNICAL_MANAGER_COUNTRY: CYPRUS
400_vd02_missing_or_invalid_ship_identifier:
title: Missing or invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
200_vd03_default:
title: Simple
type: array
items:
type: object
properties:
SHIPNAME:
type: string
description: The Shipname of the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
TYPE_NAME:
type: string
description: The Type of the subject vessel
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
COUNTRY:
type: string
description: The country of the subject vessel according to AIS transmissions
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
MT_URL:
type: string
description: URL to the Details page of the subject vessel at MarineTraffic
example:
- SHIPNAME: THE QUEEN JACQUELINE
MMSI: '244740452'
IMO: '0'
SHIP_ID: '639'
CALLSIGN: PE6545
TYPE_NAME: Inland, Ferry
DWT: ''
FLAG: NL
COUNTRY: Netherlands
YEAR_BUILT: ''
MT_URL: http://www.marinetraffic.com/en/ais/details/ships/shipid:639/mmsi:244740452/vessel:639
- SHIPNAME: BACHATA QUEEN
MMSI: '229540000'
IMO: '0'
SHIP_ID: '2771'
CALLSIGN: 9HB3419
TYPE_NAME: Pleasure Craft
DWT: ''
FLAG: MT
COUNTRY: Malta
YEAR_BUILT: ''
MT_URL: http://www.marinetraffic.com/en/ais/details/ships/shipid:2771/mmsi:229540000/vessel:2771
400_vd03_missing_search_identifier:
title: Missing search identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '54'
detail: NO SEARCH TERM SUPPLIED
400_vd03_invalid_search_string_length:
title: Invalid search string length
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '11'
detail: KEYWORD SHOULD BE AT LEAST 3 CHARACTERS
400_vd03_missing_search_term:
title: Missing search term
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '54'
detail: NO SEARCH TERM SUPPLIED
200_vi01_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
SHIPNAME:
type: string
description: The Shipname of the subject vessel
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
example:
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
SHIPNAME: QUEEN MARY 2
DESTINATION: TORQUAY
LAST_PORT_ID: '106'
LAST_PORT: SOUTHAMPTON
LAST_PORT_UNLOCODE: GBSOU
LAST_PORT_TIME: '2020-10-14T17:00:00.000Z'
NEXT_PORT_ID: '10379'
NEXT_PORT_NAME: TORQUAY
NEXT_PORT_UNLOCODE: GBTOR
ETA: '2020-10-14T13:00:00.000Z'
ETA_CALC: ''
200_vi01_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
SHIPNAME:
type: string
description: The Shipname of the subject vessel
DESTINATION:
type: string
description: The Destination of the subject vessel according to the AIS transmissions
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
SPEED_CALC:
type: string
description: The Speed of the vessel (in knots x10) that MarineTraffic used to produce the ETA_CALC value
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
DRAUGHT_MAX:
type: string
description: The Maximum Draught (in metres x10) that has been recorded for the subject vessel
LOAD_STATUS_NAME:
type: string
description: The Load Condition of the subject vessel (In Ballast, Partially Loaded, Loaded)
ROUTE:
type: string
description: The estimated route of the subject vessel to destination in WKT format
example:
- MMSI: '310627000'
IMO: '9241061'
SHIP_ID: '371681'
SHIPNAME: QUEEN MARY 2
DESTINATION: TORQUAY
LAST_PORT_ID: '106'
LAST_PORT: SOUTHAMPTON
LAST_PORT_UNLOCODE: GBSOU
LAST_PORT_TIME: '2020-10-14T17:00:00.000Z'
NEXT_PORT_ID: '10379'
NEXT_PORT_NAME: TORQUAY
NEXT_PORT_UNLOCODE: GBTOR
ETA: '2020-10-14T13:00:00.000Z'
ETA_CALC: ''
DISTANCE_TRAVELLED: '201'
DISTANCE_TO_GO: '0'
SPEED_CALC: '120'
DRAUGHT: '101'
DRAUGHT_MAX: '105'
LOAD_STATUS_NAME: N/A
ROUTE: ''
400_vi01_missing_or_invalid_ship_identifier:
title: Missing or invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a
detail: VESSEL MMSI OR IMO OR SHIPID OR PORTID OR UNLOCODE MISSING
404_vi01_invalid_fleet_identifier:
title: Invalid fleet identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 6b
detail: FLEET NOT FOUND
200_vi04_default:
title: Simple
type: array
items:
type: object
properties:
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
SHIPNAME:
type: string
description: The Shipname of the subject vessel
SHIPCLASS:
type: string
description: The class of the subject vessel based on vessel type and size
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
MANAGER:
type: string
description: The Managing Company of the subject vessel (null if the Owner and the Manager are the same)
OWNER:
type: string
description: The Owning Company of the subject vessel (null if the Owner and the Manager are the same)
FROM_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the port that was used as origin to retrieve possible
destinations
FROM_PORT:
type: string
description: The port that was used as origin to retrieve possible destinations
NEXT_PORT_1_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the most probable destination port from the given port
of origin
NEXT_PORT_1:
type: string
description: Most probable destination port from the given port of origin
NEXT_PORT_1_PROB:
type: string
description: The probability of visiting the most likely destination port
NEXT_AREA_1:
type: string
description: The area where the most probable port is
NEXT_AREA_1_PROB:
type: string
description: The probability of visiting the area where the predicted port is
NEXT_PORT_2_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the second most probable destination port from the given
port of origin
NEXT_PORT_2:
type: string
description: Second most probable destination port from the given port of origin
NEXT_PORT_2_PROB:
type: string
description: The probability of visiting the second most likely destination port
NEXT_AREA_2:
type: string
description: The area where the second most probable port is
NEXT_AREA_2_PROB:
type: string
description: The probability of visiting the area where the predicted port is
NEXT_PORT_3_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the third most probable destination port from the given
port of origin
NEXT_PORT_3:
type: string
description: Third most probable destination port from the given port of origin
NEXT_PORT_3_PROB:
type: string
description: The probability of visiting the third most likely destination port
NEXT_AREA_3:
type: string
description: The area where the third most probable port is
NEXT_AREA_3_PROB:
type: string
description: The probability of visiting the area where the predicted port is
NEXT_PORT_4_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the fourth most probable destination port from the given
port of origin
NEXT_PORT_4:
type: string
description: Fourth most probable destination port from the given port of origin
NEXT_PORT_4_PROB:
type: string
description: The probability of visiting the fourth most likely destination port
NEXT_AREA_4:
type: string
description: The area where the fourth most probable port is
NEXT_AREA_4_PROB:
type: string
description: The probability of visiting the area where the predicted port is
NEXT_PORT_5_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the fifth most probable destination port from the given
port of origin
NEXT_PORT_5:
type: string
description: Fifth most probable destination port from the given port of origin
NEXT_PORT_5_PROB:
type: string
description: The probability of visiting the fifith most likely destination port
NEXT_AREA_5:
type: string
description: The area where the fifth most probable port is
NEXT_AREA_5_PROB:
type: string
description: The probability of visiting the area where the predicted port is
example:
- IMO: '9450832'
SHIP_ID: '4615400'
MMSI: '538003690'
SHIPNAME: APHRODITE M
SHIPCLASS: HANDYSIZE
MARKET: DRY BULK
MANAGER: EMPIRE BULKERS
OWNER: BANK OF AMERICA LEASING AND CAPITAL
FROM_PORT_ID: '257'
FROM_PORT: ARATU
NEXT_PORT_1_ID: '5018'
NEXT_PORT_1: FORTALEZA
NEXT_PORT_1_PROB: '0.400'
NEXT_AREA_1: ECSA
NEXT_AREA_1_PROB: '1.000'
NEXT_PORT_2_ID: '5026'
NEXT_PORT_2: RECIFE
NEXT_PORT_2_PROB: '0.200'
NEXT_AREA_2: ECSA
NEXT_AREA_2_PROB: '1.000'
NEXT_PORT_3_ID: '645'
NEXT_PORT_3: VITORIA
NEXT_PORT_3_PROB: '0.200'
NEXT_AREA_3: ECSA
NEXT_AREA_3_PROB: '1.000'
NEXT_PORT_4_ID: '2479'
NEXT_PORT_4: CABEDELO
NEXT_PORT_4_PROB: '0.200'
NEXT_AREA_4: ECSA
NEXT_AREA_4_PROB: '1.000'
NEXT_PORT_5_ID: ''
NEXT_PORT_5: ''
NEXT_PORT_5_PROB: ''
NEXT_AREA_5: ''
NEXT_AREA_5_PROB: ''
400_vi04_missing_or_invalid_ship_identifier:
title: Missing or invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '1'
detail: INCORRECT CALL-CHECK PARAMETERS
400_vi04_invalid_fleet_identifier:
title: Invalid fleet identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '1'
detail: INCORRECT CALL-CHECK PARAMETERS
200_vi07_default:
title: Simple
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
ETA_PORT_NAME:
type: string
description: The name of the Port that was provided by the user as input parameter during the API call and that
was used by MarineTraffic for ETA and voyage calculations
ETA_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Port that was provided by the user as input parameter
during the API call and that was used by MarineTraffic for ETA and voyage calculations
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
example:
- SHIP_ID: '4615400'
MMSI: '538003690'
IMO: '9450832'
LAST_PORT_ID: '133'
LAST_PORT: TERNEUZEN
LAST_PORT_UNLOCODE: NLTNZ
LAST_PORT_TIME: '2020-10-23T07:20:00.000Z'
NEXT_PORT_NAME: ARATU
NEXT_PORT_UNLOCODE: BRARB
ETA_PORT_NAME: ROTTERDAM
ETA_PORT_UNLOCODE: NLRTM
ETA_CALC: '2020-11-17T04:18:35.000Z'
200_vi07_extended:
title: Extended
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
ETA_PORT_NAME:
type: string
description: The name of the Port that was provided by the user as input parameter during the API call and that
was used by MarineTraffic for ETA and voyage calculations
ETA_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Port that was provided by the user as input parameter
during the API call and that was used by MarineTraffic for ETA and voyage calculations
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
DISTANCE_TRAVELLED:
type: string
description: The Distance (in NM) that the subject vessel has travelled since departing from Last Port
DISTANCE_TO_GO:
type: string
description: The Remaining Distance (in NM) for the subject vessel to reach the reported Destination
SPEED_CALC:
type: string
description: The Speed of the vessel (in knots x10) that MarineTraffic used to produce the ETA_CALC value
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
DRAUGHT_MAX:
type: string
description: The Maximum Draught (in metres x10) that has been recorded for the subject vessel
LOAD_STATUS_NAME:
type: string
description: The Load Condition of the subject vessel (In Ballast, Partially Loaded, Loaded)
ROUTE:
type: string
description: The estimated route of the subject vessel to destination in WKT format
ETD_CALC:
type: string
description: The Estimated Time of Departure from the Port specified in query parameters according to the MarineTraffic
calculations based on calculated eta, time at anchorage & time at port
format: date-time
TIME_ANCH:
type: string
description: The median number of days spent at anchorage the previous week
TIME_PORT:
type: string
description: The median number of days spent at port by the selected market/shipclass
example:
- SHIP_ID: '4615400'
MMSI: '538003690'
IMO: '9450832'
LAST_PORT_ID: '133'
LAST_PORT: TERNEUZEN
LAST_PORT_UNLOCODE: NLTNZ
LAST_PORT_TIME: '2020-10-23T07:20:00.000Z'
NEXT_PORT_NAME: ARATU
NEXT_PORT_UNLOCODE: BRARB
ETA_PORT_NAME: ROTTERDAM
ETA_PORT_UNLOCODE: NLRTM
ETA_CALC: '2020-11-17T04:20:14.000Z'
DISTANCE_TRAVELLED: '519'
DISTANCE_TO_GO: '2629'
SPEED_CALC: '58'
DRAUGHT: '93'
DRAUGHT_MAX: '104'
LOAD_STATUS_NAME: LADEN
ROUTE: LINESTRING (-3.25721 50.5102, -3.36854 50.4274, -3.43517 50.4228, -3.43879 50.4169, -3.43297 50.4142, -3.42169
50.4115, -3.41547 50.407, -3.41412 50.4007, -3.41569 50.395, -3.4188 50.3885, -3.56497 50.1962, -4.6912 49.5453,
-5.17703 49.2673, -5.78868 48.8526, -6.98989 47.5559, -7.2535 47.316, -7.2102 47.0939, -7.2935 46.9586, -8.33592
45.8395, -9.09363 44.8248, -9.5244 44.2492, -9.70133 44.0603, -10.0427 43.6447, -10.1111 43.4934, -10.2361 43.3193,
-10.2123 42.2985, -10.1906 41.2322, -10.1462 40.1117, -10.1056 39.0589, -10.0989 38.6851, -10.0265 38.4306, -10.0125
38.3022, -9.69923 37.261, -9.57864 36.8751, -9.52376 36.7973, -9.25278 36.5721, -9.19231 36.5391, -8.15901 36.2992,
-7.0206 36.0401, -6.48534 35.9174, -5.82036 35.9016, -5.63979 35.9169, -5.26123 35.984, -4.97929 36.0055, -4.90942
36.0021, -3.80999 36.1162, -2.70866 36.1953, -1.70453 36.3222, -0.620848 36.4784, 0.607268 36.6633, 1.71278 36.8284,
2.7549 36.9733, 3.87165 37.1261, 4.69295 37.2316, 5.74852 37.2387, 6.90585 37.2472, 8.02881 37.2582, 8.64414 37.2678,
9.70149 37.5087, 10.0471 37.569, 10.1756 37.5695, 10.9414 37.4179, 11.4793 37.2768, 11.9401 37.095, 12.4415 36.9732,
13.4569 36.7885, 13.5064 36.7736, 14.5303 36.6101, 15.1167 36.5096, 16.1937 36.477, 17.4477 36.4471, 18.371 36.4181,
18.7263 36.3965, 20.799 36.3638, 21.7999 36.3351, 22.0905 36.3339, 22.2645 36.3226, 22.7168 36.356, 22.9405 36.4011,
23.1341 36.3843, 23.1449 36.3864, 23.1681 36.3932, 23.176 36.3965, 23.2887 36.4584, 23.2941 36.4631, 23.2984 36.4683,
23.3022 36.4743, 23.3053 36.4812, 23.4143 36.9312, 23.6949 37.4873, 23.7461 37.6468, 23.75 37.6672, 23.749 37.6724,
23.6701 37.8133, 23.5845 37.8766, 23.5848 37.8872)
ETD_CALC: '2020-11-26T16:20:14.000Z'
TIME_ANCH: '3.4'
TIME_PORT: '6.1'
400_vi07_missing_or_invalid_port_identifier:
title: Missing or invalid port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a10
detail: PORT_ID OR UNLOCODE MISSING
400_vi07_missing_or_invalid_ship_identifier:
title: Missing or invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
200_vi02_default:
title: Simple
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
SHIPNAME:
type: string
description: The Shipname of the subject vessel
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
example:
- MMSI: '229001000'
IMO: ''
SHIP_ID: ''
SHIPNAME: ''
LAT: '37.938690'
LON: '23.634480'
SPEED: '0'
COURSE: '129'
STATUS: '5'
PORT_ID: '1'
PORT_UNLOCODE: GRPIR
CURRENT_PORT: PIRAEUS
CURRENT_PORT_COUNTRY: GR
NEXT_PORT_ID: '1'
NEXT_PORT_UNLOCODE: GRPIR
NEXT_PORT_NAME: PIRAEUS
NEXT_PORT_COUNTRY: GR
ETA: '2021-03-14T05:40:00.000Z'
ETA_CALC: ''
ETA_UPDATED: ''
TIMESTAMP: '2020-10-30T08:58:08.000Z'
- MMSI: '201100129'
IMO: ''
SHIP_ID: ''
SHIPNAME: ''
LAT: '37.943630'
LON: '23.631900'
SPEED: '0'
COURSE: '0'
STATUS: '5'
PORT_ID: '1'
PORT_UNLOCODE: GRPIR
CURRENT_PORT: PIRAEUS
CURRENT_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
ETA: '2020-10-26T08:00:00.000Z'
ETA_CALC: ''
ETA_UPDATED: ''
TIMESTAMP: '2020-10-30T08:57:24.000Z'
200_vi02_extended:
title: Extended
type: array
items:
type: object
properties:
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
SHIPNAME:
type: string
description: The Shipname of the subject vessel
TYPE_NAME:
type: string
description: The Type of the subject vessel
SHIPTYPE:
type: string
description: The Shiptype of the subject vessel according to AIS transmissions
CALLSIGN:
type: string
description: A uniquely designated identifier for the vessel's transmitter station
FLAG:
type: string
description: The flag of the subject vessel according to AIS transmissions
LENGTH:
type: string
description: The overall Length (in metres) of the subject vessel
WIDTH:
type: string
description: The Breadth (in metres) of the subject vessel
DRAUGHT:
type: string
description: The Draught (in metres x10) of the subject vessel according to the AIS transmissions
GRT:
type: string
description: Gross Tonnage - unitless measure that calculates the moulded volume of all enclosed spaces of a ship
DWT:
type: string
description: Deadweight - a measure (in metric tons) of how much weight a vessel can safely carry (excluding the
vessel's own weight)
YEAR_BUILT:
type: string
description: The year that the subject vessel was built
LAT:
type: string
description: Latitude - a geographic coordinate that specifies the north-south position of the vessel on the Earth's
surface
LON:
type: string
description: Longitude - a geographic coordinate that specifies the east-west position of the vessel on the Earth's
surface
SPEED:
type: string
description: The speed (in knots x10) that the subject vessel is reporting according to AIS transmissions
COURSE:
type: string
description: The course (in degrees) that the subject vessel is reporting according to AIS transmissions
STATUS:
type: string
description: The AIS Navigational Status of the subject vessel as input by the vessel's crew. There might be discrepancies
with the vessel's detail page when vessel speed is near zero (0) knots
ETA:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the AIS transmissions
format: date-time
ETA_CALC:
type: string
description: The Estimated Time of Arrival to Destination of the subject vessel according to the MarineTraffic
calculations
format: date-time
ETA_UPDATED:
type: string
description: The date and time (in UTC) that the ETA was calculated by MarineTraffic
format: date-time
LAST_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Last Port
LAST_PORT:
type: string
description: The Name of the Last Port the vessel has visited
LAST_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Last Port
LAST_PORT_COUNTRY:
type: string
description: The Country that the Last Port is located at
LAST_PORT_TIME:
type: string
description: The Date and Time (in UTC) that the subject vessel departed from the Last Port
format: date-time
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Current Port
CURRENT_PORT:
type: string
description: The name of the Port the subject vessel is currently in (NULL if the vessel is underway)
CURRENT_PORT_COUNTRY:
type: string
description: The Country that the Current Port is located at
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT_UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for the Next Port
NEXT_PORT_NAME:
type: string
description: The Name of the Next Port as derived by MarineTraffic based on the subject vessel's reported Destination
NEXT_PORT_COUNTRY:
type: string
description: The Country that the Next Port is located at
TIMESTAMP:
type: string
description: The date and time (in UTC) that the subject vessel's position or event was recorded by MarineTraffic
format: date-time
example:
- IMO: '7827213'
MMSI: '229001000'
SHIP_ID: ''
SHIPNAME: CELESTYAL CRYSTAL
TYPE_NAME: Passenger Ship
SHIPTYPE: '36'
CALLSIGN: 9HA2978
FLAG: MT
LENGTH: '162'
WIDTH: '24'
DRAUGHT: '61'
GRT: '25611'
DWT: '1703'
YEAR_BUILT: '1980'
LAT: '37.938690'
LON: '23.634480'
SPEED: '0'
COURSE: '129'
STATUS: '5'
ETA: '2021-03-14T05:40:00.000Z'
ETA_CALC: ''
ETA_UPDATED: ''
LAST_PORT_ID: '17208'
LAST_PORT: KUSADASI
LAST_PORT_UNLOCODE: TRKUS
LAST_PORT_COUNTRY: TR
LAST_PORT_TIME: '2020-03-13T17:38:00.000Z'
PORT_ID: '1'
PORT_UNLOCODE: GRPIR
CURRENT_PORT: PIRAEUS
CURRENT_PORT_COUNTRY: GR
NEXT_PORT_ID: '1'
NEXT_PORT_UNLOCODE: GRPIR
NEXT_PORT_NAME: PIRAEUS
NEXT_PORT_COUNTRY: GR
TIMESTAMP: '2020-10-30T08:58:08.000Z'
- IMO: '8843886'
MMSI: '201100129'
SHIP_ID: ''
SHIPNAME: EDRO IV
TYPE_NAME: General Cargo
SHIPTYPE: '0'
CALLSIGN: ZADL2
FLAG: AL
LENGTH: '89.97'
WIDTH: '12.37'
DRAUGHT: '34'
GRT: '2138'
DWT: '2850'
YEAR_BUILT: '1983'
LAT: '37.943630'
LON: '23.631900'
SPEED: '0'
COURSE: '0'
STATUS: '5'
ETA: '2020-10-26T08:00:00.000Z'
ETA_CALC: ''
ETA_UPDATED: ''
LAST_PORT_ID: '118'
LAST_PORT: VALLETTA
LAST_PORT_UNLOCODE: MTMLA
LAST_PORT_COUNTRY: MT
LAST_PORT_TIME: '2020-10-21T16:41:00.000Z'
PORT_ID: '1'
PORT_UNLOCODE: GRPIR
CURRENT_PORT: PIRAEUS
CURRENT_PORT_COUNTRY: GR
NEXT_PORT_ID: ''
NEXT_PORT_UNLOCODE: ''
NEXT_PORT_NAME: ''
NEXT_PORT_COUNTRY: ''
TIMESTAMP: '2020-10-30T08:57:24.000Z'
400_vi02_missing_or_invalid_port_identifier:
title: Missing or invalid port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a5
detail: PORT OR COUNTRY MISSING
200_vi05_default:
title: Simple
type: array
items:
type: object
properties:
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
SHIPNAME:
type: string
description: The Shipname of the subject vessel
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
SHIPCLASS:
type: string
description: The class of the subject vessel based on vessel type and size
FROM_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the port that was used as origin to retrieve possible
destinations
FROM_PORT:
type: string
description: The port that was used as origin to retrieve possible destinations
NEXT_PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Next Port
NEXT_PORT:
type: string
description: The target port used to predict arrivals of vessels
NEXT_AREA:
type: string
description: The area where the target port belongs to
NEXT_PORT_PROB:
type: string
description: The probability of visiting the target port
NEXT_AREA_PROB:
type: string
description: The probability of visiting the area where the target port is
example:
- IMO: '9020340'
SHIP_ID: '337987'
MMSI: '271041000'
SHIPNAME: MARTINE A
MARKET: CONTAINER SHIPS
SHIPCLASS: FEEDER
FROM_PORT_ID: '1379'
FROM_PORT: BIZERTE
NEXT_PORT_ID: '1'
NEXT_PORT: PIRAEUS
NEXT_AREA: EMED
NEXT_PORT_PROB: '1.000'
NEXT_AREA_PROB: '1.000'
- IMO: '9357810'
SHIP_ID: '712465'
MMSI: '538003142'
SHIPNAME: EF EMIRA
MARKET: CONTAINER SHIPS
SHIPCLASS: FEEDER
FROM_PORT_ID: '528'
FROM_PORT: ANCONA
NEXT_PORT_ID: '1'
NEXT_PORT: PIRAEUS
NEXT_AREA: EMED
NEXT_PORT_PROB: '1.000'
NEXT_AREA_PROB: '1.000'
400_vi05_missing_or_invalid_port_identifier:
title: Missing or invalid port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '1'
detail: INCORRECT CALL-CHECK PARAMETERS
200_vi06_default:
title: Simple
type: array
items:
type: object
properties:
PORT_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the Current Port
YEAR:
type: string
description: Year of week the data are referring to
WEEK:
type: string
description: Week of year the data are referring to
MARKET:
type: string
description: The commercial market segment the subject vessel belongs to
SHIPCLASS:
type: string
description: The class of the subject vessel based on vessel type and size
TIME_ANCH:
type: string
description: The median number of days spent at anchorage the previous week
TIME_PORT:
type: string
description: The median number of days spent at port by the selected market/shipclass
VESSELS:
type: string
description: Number of vessels that were used in the median calculations
CALLS:
type: string
description: Number of individual calls that were used in the median calculations (e.g. if the same vessel has
called twice within the same week, it will count twice in CALLS and once in VESSELS
TIME_ANCH_STDEV:
type: string
description: The week-to-week standard deviation in days spent at anchorage
TIME_ANCH_DIFF:
type: string
description: The week-to-week difference of number of days spent at anchorage
TIME_ANCH_DIFF_PERC:
type: string
description: The week-to-week difference of number of days spent at anchorage as a percentage
TIME_PORT_STDEV:
type: string
description: The week-to-week standard deviation in days spent at port
TIME_PORT_DIFF:
type: string
description: The week-to-week difference of number of days spent at port
TIME_PORT_DIFF_PERC:
type: string
description: The week-to-week difference of number of days spent at port as a percentage
example:
- PORT_ID: '1766'
YEAR: '2020'
WEEK: '8'
MARKET: DRY BULK
SHIPCLASS: HANDYSIZE
TIME_ANCH: ''
TIME_PORT: '3.4'
VESSELS: '2'
CALLS: '2'
TIME_ANCH_STDEV: ''
TIME_ANCH_DIFF: ''
TIME_ANCH_DIFF_PERC: ''
TIME_PORT_STDEV: '3.5'
TIME_PORT_DIFF: '-9.9'
TIME_PORT_DIFF_PERC: '-74.4'
400_vi06_mandatory_field_missing:
title: Mandatory field missing
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a9
detail: MANDATORY FIELD MISSING portid
200_vi03_default:
title: Simple
type: array
items:
type: object
properties:
DISTANCE:
type: string
description: The Distance (in NM) between the specified point or port to the destination port
PANAMA:
type: string
description: Flag to indicate whether the vessel route passes via the Panama canal (0:no, 1:yes)
SUEZ:
type: string
description: Flag to indicate whether the vessel route passes via the Suez canal (0:no, 1:yes)
example:
- DISTANCE: '2938'
PANAMA: '0'
SUEZ: '0'
200_vi03_extended:
title: Extended
type: array
items:
type: object
properties:
DISTANCE:
type: string
description: The Distance (in NM) between the specified point or port to the destination port
PANAMA:
type: string
description: Flag to indicate whether the vessel route passes via the Panama canal (0:no, 1:yes)
SUEZ:
type: string
description: Flag to indicate whether the vessel route passes via the Suez canal (0:no, 1:yes)
FINAL_PATH:
type: string
description: Route/Waypoints as Linestring Geometry in WKT - Well-Known Text
example:
- DISTANCE: '2938'
PANAMA: '0'
SUEZ: '0'
FINAL_PATH: LINESTRING (23.6031 37.9345, 23.6022 37.8302, 23.7127 37.6496, 23.7056 37.6035, 23.6234 37.3639, 23.4216
36.9451, 23.229 36.4224, 23.1209 36.4007, 22.9908 36.4161, 22.8799 36.4056, 22.5453 36.3436, 22.0771 36.3505, 19.8853
36.3859, 17.0453 36.4213, 16.0126 36.4389, 14.5459 36.461, 12.2835 37.0352, 11.0962 37.4966, 10.2338 37.6534, 9.5746
37.6577, 8.8824 37.6447, 7.8552 37.5924, 6.2292 37.4225, 4.3781 37.2391, 3.5815 37.1472, 2.2467 37.0245, 0.1648
36.7609, -1.9391 36.4655, -2.9718 36.3328, -4.021 36.2132, -5.3448 36.0269, -5.5563 35.9713, -5.8612 35.9625, -6.1963
35.9558, -9.0088 36.6948, -9.1681 36.7609, -9.3109 36.884, -9.3713 37.1341, -9.657 38.1043, -9.8602 38.7455, -9.8492
39.0491, -9.8492 39.6818, -9.8383 40.1873, -9.7998 42.3829, -9.7943 42.9444, -9.7778 43.2091, -6.861 47.1486, -5.9876
48.3051, -5.6195 48.7562, -5.1691 48.9442, -4.5428 49.1781, -3.3893 49.6214, -2.9169 49.8026, -2.439 49.8911, -1.5491
50.0501, -0.3571 50.2612, 0.9668 50.4889, 1.3528 50.7125, 1.4177 50.8727, 1.4687 50.906, 1.7071 51.0776, 2.0596
51.2246, 2.2412 51.4745, 3.1406 52.1546, 3.5788 52.4091, 4.1803 52.4844, 4.5456 52.4644, 4.6609 52.4627, 4.6788
52.4526, 4.7173 52.4351, 4.7392 52.4301, 4.7763 52.4251, 4.7955 52.4234, 4.8225 52.4197, 4.8581 52.4147, 4.8793
52.4083, 4.8985 52.389)
400_vi03_invalid_ship_identifier:
title: Invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
400_vi03_missing_or_invalid_port_identifier:
title: Missing or invalid port identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 2a6
detail: PORT IS MISSING
200_gi01_default:
title: Simple
type: array
items:
type: object
properties:
ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the returned area/asset
NAME:
type: string
description: Name of the returned area/asset
TYPE:
type: string
description: Type of the returned area/asset
SUBTYPE:
type: string
description: Subtype of the returned area/asset
COUNTRY:
type: string
description: Country of the returned area/asset. Not applicable for Standard Areas and Custom Areas
UNLOCODE:
type: string
description: A uniquely assigned ID by United Nations for a Port . Only applicable for Ports, Berths and Terminals
GEOMETRY_CENTER:
type: string
description: Geometry center of the returned area
DISTANCE:
type: string
description: Distance of the returned area/asset from the given point (in NM)
TERMINAL:
type: string
description: ID of the Terminal the returned Berth belongs to . Only applicable for Berths
URL:
type: string
description: URL of MarineTraffic page with area/asset details (if exists)
example:
- ID: '1'
NAME: PIRAEUS
TYPE: Port
SUBTYPE: P
COUNTRY: GR
UNLOCODE: GRPIR
GEOMETRY_CENTER: 37.1111,23.222
DISTANCE: '0'
TERMINAL: null
URL: https://marinetraffic.com/en/ais/details/ports/1
- ID: '13'
NAME: Piraeus Area
TYPE: Standard Area
SUBTYPE: Geographical Area
COUNTRY: null
UNLOCODE: null
GEOMETRY_CENTER: 37.1111,23.222
DISTANCE: '0'
TERMINAL: null
URL: https://marinetraffic.com/en/ais/details/areas/areaId:13
- ID: '12345'
NAME: Pier III East
TYPE: Berth
SUBTYPE: null
COUNTRY: GR
UNLOCODE: GRPIR
GEOMETRY_CENTER: 37.1111,23.222
DISTANCE: '0'
TERMINAL: '12'
URL: null
- ID: '12'
NAME: Container Terminal
TYPE: Terminal
SUBTYPE: null
COUNTRY: GR
UNLOCODE: GRPIR
GEOMETRY_CENTER: null
DISTANCE: '0'
TERMINAL: null
URL: null
200_pu01_update:
title: Update Fleet
type: object
properties:
status:
type: array
items:
type: object
properties:
success:
type: array
items:
type: object
properties:
code:
type: string
description: Success code
description:
type: string
description: Success message
400_pu01_invalid_ship_identifier:
title: Invalid ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '1'
detail: INCORRECT CALL-CHECK PARAMETERS
400_pu01_missing_ship_identifier:
title: Missing ship identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '2'
detail: VESSEL MMSI OR IMO OR SHIPID MISSING
404_pu01_invalid_fleet_identifier:
title: Invalid fleet identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 6b
detail: FLEET NOT FOUND
200_pu02_default:
title: Simple
type: array
items:
type: object
properties:
SHIP_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject vessel
MMSI:
type: string
description: Maritime Mobile Service Identity - a nine-digit number sent in digital form over a radio frequency
that identifies the vessel's transmitter station
IMO:
type: string
description: International Maritime Organisation number - a seven-digit number that uniquely identifies vessels
SHIPNAME:
type: string
description: The Shipname of the subject vessel
ACTIVE:
type: string
description: The Status of the subject vessel (Off = 0, Terrestrial = 1, Satellite = 2 )
example:
- SHIP_ID: '319'
MMSI: '228316700'
IMO: '9387542'
SHIPNAME: KAOMBO NORTE
ACTIVE: '1'
- SHIP_ID: '326'
MMSI: '256609000'
IMO: '9409156'
SHIPNAME: LAPEROUSE
ACTIVE: '1'
- SHIP_ID: '487'
MMSI: '228333700'
IMO: '9320075'
SHIPNAME: GASELYS
ACTIVE: '1'
- SHIP_ID: '510'
MMSI: '228337700'
IMO: '9306495'
SHIPNAME: PROVALYS
ACTIVE: '1'
- SHIP_ID: '1595'
MMSI: '229036000'
IMO: '9529475'
SHIPNAME: PETALIDI
ACTIVE: '1'
400_pu02_empty_fleet:
title: Empty fleet
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: '7'
detail: FLEET IS EMPTY
403_pu02_invalid_fleet_identifier:
title: Invalid fleet identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 6a
detail: USER DOES NOT OWN FLEET
200_pu03_default:
title: Simple
type: array
items:
type: object
properties:
ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject Fleet
NAME:
type: string
description: The Name of the subject Fleet
ACTIVE:
type: string
description: The Status of the subject Fleet (1 = Active )
CREATED:
type: string
description: The Date and Time (in UTC) that the subject Fleet was created
DEFAULT:
type: string
description: 1 = Default Fleet
example:
- ID: '1696822'
NAME: Demo fleet
ACTIVE: '1'
CREATED: '2020-09-22T06:51:00.000Z'
DEFAULT: '1'
200_pu05_default:
title: Simple
type: array
items:
type: object
properties:
FLEET_ID:
type: string
description: The fleet_id you wish to clear
DELETE:
type: string
description: Indicates whether the vessels were successfully deleted from a fleet (0:no, 1:yes)
example:
- FLEET_ID: '1716163'
DELETE: '1'
404_pu05_missing_or_invalid_fleet_identifier:
title: Missing or invalid fleet identifier
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
detail:
type: string
description: Error message
example:
errors:
- code: 6b
detail: FLEET NOT FOUND
200_pu04_default:
title: Simple
type: array
items:
type: object
properties:
USER_ID:
type: string
description: A uniquely assigned ID by MarineTraffic for the subject MarineTraffic registered user
CREDIT_BALANCE:
type: string
description: The current Credits balance of the user
LAST_CHARGED:
type: string
description: The last date and time (in UTC) that the user purchased Credits
example:
- USER_ID: '13541873'
CREDIT_BALANCE: '1542'
LAST_CHARGED: '2017-01-17T12:23:24.000Z'
pu06_request_body:
title: Request Body
type: array
items:
type: object
properties:
imo:
type: integer
description: The International Maritime Organization (IMO) number of the vessel you wish to import the passage
plan for
file:
type: object
description: 'Input file that contains an ECDIS passage plan. Accepted formats are: CSV, RTZ and RT3'
protocol:
type: string
description: 'Response type. Use one of the following: xml, csv, json, jsono (object)'
example:
- imo: 9750701
file: your_file.rtz
suez: jsono
200_pu06_default:
title: Simple
type: object
properties:
status:
type: array
items:
type: object
properties:
code:
type: string
description: Success Code Status
description:
type: string
description: Success Code Description
example:
status:
- code: s8
description: PASSAGE PLAN IMPORTED
400_pu06_vessel_not_found:
title: Vessel not found
type: object
properties:
error:
type: array
items:
type: object
properties:
code:
type: string
description: Error code
description:
type: string
description: Error message
example:
error:
- code: 2a11
description: VESSEL NOT FOUND
x-tagGroups:
- name: Solutions
tags:
- Containers API
- MT Inbox
- name: Vessel Positions
tags:
- AIS API
- Vessel Historical Track
- Vessel Positions (Legacy API)
- name: Events
tags:
- Single Vessel Events
- Port Events
- name: Vessels Data
tags:
- Vessel Information
- Search Vessel
- name: Voyage Info
tags:
- Voyage Information
- Ports Information
- Routing Information
- name: Geographical Info
tags:
- Reverse Geocoding
- name: Power User
tags:
- Fleets
- Balances
- Passage Plans