{
"opencollection": "1.0.0",
"info": {
"name": "MarineTraffic AIS Data API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Vessel Historical Track",
"type": "folder"
},
"items": [
{
"info": {
"name": "Single Vessel Historical Positions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvesseltrack/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 3 to get the latest"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo or mmsi"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "days",
"value": "",
"type": "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)"
},
{
"name": "fromdate",
"value": "",
"type": "query",
"description": "Use with todate instead of days to get data for a date period"
},
{
"name": "todate",
"value": "",
"type": "query",
"description": "Use with fromdate instead of days to get data for a date period"
},
{
"name": "period",
"value": "",
"type": "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
"
},
{
"name": "msgtype",
"value": "",
"type": "query",
"description": "Resolution of the response. Available values: If used with the value extended, the response includes also weather data"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 "
},
{
"info": {
"name": "Vessel Historical Positions in an Area",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvesseltrack/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 3 to get the latest"
},
{
"name": "days",
"value": "",
"type": "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)"
},
{
"name": "fromdate",
"value": "",
"type": "query",
"description": "Use with todate instead of days to get data for a date period"
},
{
"name": "todate",
"value": "",
"type": "query",
"description": "Use with fromdate instead of days to get data for a date period"
},
{
"name": "MINLAT",
"value": "",
"type": "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"
},
{
"name": "MAXLAT",
"value": "",
"type": "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"
},
{
"name": "MINLON",
"value": "",
"type": "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"
},
{
"name": "MAXLON",
"value": "",
"type": "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"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo or mmsi"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "period",
"value": "",
"type": "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
"
},
{
"name": "msgtype",
"value": "",
"type": "query",
"description": "Resolution of the response. Available values: If used with the value extended, the response includes also weather data"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 "
}
]
},
{
"info": {
"name": "Vessel Positions (Legacy API)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Vessel Positions of a Static Fleet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 8 to get the latest"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 <"
},
{
"info": {
"name": "Vessel Positions of a Dynamic Fleet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 8 to get the latest"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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**"
},
{
"info": {
"name": "Vessel Positions Within a Port",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 8 to get the latest"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 - **S"
},
{
"info": {
"name": "Vessel Positions in a Predefined Bounding Box",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 8 to get the latest"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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"
},
{
"info": {
"name": "Vessel Positions in a Dynamic Bounding Box",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 8 to get the latest"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned positions. Maximum value is 2880"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "MAXLAT",
"value": "",
"type": "query",
"description": "Use with MINLAT, MINLON, MAXLON to define an area and retrieve positional information of vessels sailing in it"
},
{
"name": "MINLON",
"value": "",
"type": "query",
"description": "Use with MINLAT, MAXLAT, MAXLON to define an area and retrieve positional information of vessels sailing in it"
},
{
"name": "MAXLON",
"value": "",
"type": "query",
"description": "Use with MINLAT, MINLON, MAXLAT to define an area and retrieve positional information of vessels sailing in it"
},
{
"name": "MINLAT",
"value": "",
"type": "query",
"description": "Use with MAXLAT, MINLON, MAXLON to define an area and retrieve positional information of vessels sailing in it"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
}
]
},
"docs": "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 ind"
},
{
"info": {
"name": "Single Vessel Positions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessel/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 5 to get the latest"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo or mmsi"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned positions. Maximum value is 2880"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 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"
},
{
"name": "shiptype_detailed",
"value": "",
"type": "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"
},
{
"name": "msgtype",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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"
}
]
},
{
"info": {
"name": "AIS API",
"type": "folder"
},
"items": [
{
"info": {
"name": "Vessel Positions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportvessels/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Use latest version **9**"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "Overrides the default timespan"
},
{
"name": "vesseltypeid",
"value": "",
"type": "query",
"description": "Filter vessels based on vessel types, comma separated ids supported more"
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "The pagination cursor provided in the metadata section of the previous response"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit of vessels per page (min=1000, max=5000)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - jsono
\n - csv
"
}
]
},
"docs": "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.\nTrack vessels of interest anywhere in the world.Notes\n - Information about more"
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "The pagination cursor provided in the metadata section of the previous response"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit of vessels per page (min=1000, max=5000)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - jsono
\n - csv
"
}
]
},
"docs": "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.\nTrack Vessels of interest in a predefined area of interest.Notes\n - Information about You can instead use imo or mmsi"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "Overrides the default timespan"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - jsono
\n - csv
"
}
]
},
"docs": "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.\nGet the latest available position and voyage information for a single vessel.Notes\n - Information about You can instead use imo or mmsi"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned port calls. Maximum value is 2880"
},
{
"name": "movetype",
"value": "",
"type": "query",
"description": "Use 0 to only receive arrivals or 1 to only receive departures. If not used, the response will include both"
},
{
"name": "exclude_intransit",
"value": "",
"type": "query",
"description": "Use 1 to exclude vessels in transit"
},
{
"name": "fromdate",
"value": "",
"type": "query",
"description": "Portcalls between fromdate and todate. Maximum period requested 190 days Date format: YYYY-MM-DD HH:MM"
},
{
"name": "todate",
"value": "",
"type": "query",
"description": "Portcalls between fromdate and todate. Maximum period requested 190 days Date format: YYYY-MM-DD HH:MM"
},
{
"name": "dwt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum DWT Applicable to IMO-having vessels"
},
{
"name": "dwt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum DWT Applicable to IMO-having vessels"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels"
},
{
"name": "market",
"value": "",
"type": "query",
"description": "Define market(s) for which you would like to receive port calls (single or comma separated values) - more"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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"
},
{
"info": {
"name": "Single Vessel Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/vesselevents/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 2 to get the latest"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel You can instead use imo or mmsi"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned port calls. Maximum value is 2880"
},
{
"name": "fromdate",
"value": "",
"type": "query",
"description": "Vessel Events between fromdate and todate Date format: YYYY-MM-DD HH:MM:SS"
},
{
"name": "todate",
"value": "",
"type": "query",
"description": "Vessel Events between fromdate and todate Date format: YYYY-MM-DD HH:MM:SS"
},
{
"name": "event_type",
"value": "",
"type": "query",
"description": "You may use one or more event ids in comma separated format for the events you wish to receive"
},
{
"name": "limit_events",
"value": "",
"type": "query",
"description": "Limit the number of results"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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 You can instead use imo or mmsi"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned port calls. Maximum value is 2880"
},
{
"name": "fromdate",
"value": "",
"type": "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."
},
{
"name": "todate",
"value": "",
"type": "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"
},
{
"name": "market",
"value": "",
"type": "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
"
},
{
"name": "shipclass",
"value": "",
"type": "query",
"description": "Define ship class of interest - more"
},
{
"name": "dwt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype = 7,8)"
},
{
"name": "dwt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype = 7,8)"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels"
},
{
"name": "movetype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - jsono
"
},
{
"name": "msgtype",
"value": "",
"type": "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"
}
]
},
"docs": "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: Date format: YYYY-MM-DD HH:MM"
},
{
"name": "todate",
"value": "",
"type": "query",
"description": "Portcalls between fromdate and todate. Maximum period requested 190 days Date format: YYYY-MM-DD HH:MM"
},
{
"name": "dwt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum DWT Applicable to IMO-having vessels"
},
{
"name": "dwt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum DWT Applicable to IMO-having vessels"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels"
},
{
"name": "market",
"value": "",
"type": "query",
"description": "Define market(s) for which you would like to receive port calls (single or comma separated values) - more"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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 "
},
{
"info": {
"name": "Berth Calls",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/berth-calls/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 3 to get the latest"
},
{
"name": "portid",
"value": "",
"type": "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"
},
{
"name": "port_unlocode",
"value": "",
"type": "query",
"description": "Port UN LOCODE (without gaps or spaces)"
},
{
"name": "berthid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the berth you wish to monitor (list to be provided upon request) "
},
{
"name": "terminalid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the terminal you wish to monitor (list to be provided upon request)"
},
{
"name": "timespan",
"value": "",
"type": "query",
"description": "The maximum age, in minutes, of the returned port calls. Maximum value is 2880"
},
{
"name": "fromdate",
"value": "",
"type": "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."
},
{
"name": "todate",
"value": "",
"type": "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"
},
{
"name": "market",
"value": "",
"type": "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
"
},
{
"name": "shipclass",
"value": "",
"type": "query",
"description": "Define ship class of interest - more"
},
{
"name": "dwt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype = 7,8)"
},
{
"name": "dwt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum DWT Use it to filter by size Cargo and Tanker IMO-having vessels (shiptype = 7,8)"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels"
},
{
"name": "movetype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - jsono
"
},
{
"name": "msgtype",
"value": "",
"type": "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"
}
]
},
"docs": "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: You can instead use shipid"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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
"
},
{
"info": {
"name": "Vessel Particulars (Legacy API)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/vesselmasterdata/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 5 to get the latest"
},
{
"name": "mmsi",
"value": "",
"type": "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"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track (single or comma separated values)"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel (single or comma separated values)"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "The interval parameter can be either minutes or days"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number of the results to be returned"
},
{
"name": "msgtype",
"value": "",
"type": "query",
"description": "Resolution of the response. Available values: "
}
]
},
"docs": "⚠️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 You can instead use mmsi or imo"
},
{
"name": "mmsi",
"value": "",
"type": "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"
},
{
"name": "imo",
"value": "",
"type": "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"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "type_name_id",
"value": "",
"type": "query",
"description": "Data filter: AIS Shiptype Find more information here"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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
"
},
{
"info": {
"name": "Search Vessel by Name",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/shipsearch/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "shipname",
"value": "",
"type": "query",
"description": "The vessel name. The results will contain all vessels whose name is like the given words"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type: \n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "type_name_id",
"value": "",
"type": "query",
"description": "Data filter: AIS Shiptype Find more information here"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 t"
}
]
},
{
"info": {
"name": "Voyage Information",
"type": "folder"
},
"items": [
{
"info": {
"name": "Single Vessel Voyage Forecast",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/voyageforecast/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 2 to get the latest"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead use imo or shipid"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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"
},
{
"info": {
"name": "Fleet Voyage Forecast",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/voyageforecast/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 2 to get the latest"
},
{
"name": "fleet_id",
"value": "",
"type": "query",
"description": "The fleet id you wish to receive voyage forecast for"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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 “"
},
{
"info": {
"name": "Single Vessel Predictive Destinations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/predictive-destination-areas/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead use imo or shipid"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel"
},
{
"name": "fromportid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the port you wish to receive a prediction (found on the URL of the respective Port page)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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
"
},
{
"info": {
"name": "Fleet Predictive Destinations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/predictive-destination-areas/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "fleet_id",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the fleet you wish to track"
},
{
"name": "fromportid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the port you wish to receive a prediction (found on the URL of the respective Port page)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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. You can instead use unlocode"
},
{
"name": "unlocode",
"value": "",
"type": "query",
"description": "The UN LOCODE (without gaps or spaces) of the port you wish to receive ETA info"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead use imo or shipid"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel"
},
{
"name": "speed_calc",
"value": "",
"type": "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
"
},
{
"name": "msgtype",
"value": "",
"type": "query",
"description": "Resolution of the response. Available values: If used with the value extended, the response includes voyage related data"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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. 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"
},
{
"name": "days_last_signal",
"value": "",
"type": "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."
},
{
"name": "fromdate",
"value": "",
"type": "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"
},
{
"name": "todate",
"value": "",
"type": "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"
},
{
"name": "fromportid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the previous port (found on the URL of the respective Port page) or previous port UNLOCODE"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "dwt_min",
"value": "",
"type": "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"
},
{
"name": "dwt_max",
"value": "",
"type": "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"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels. If used, then you should also define the gt_max parameter"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels. If used, then you should also define the gt_min parameter"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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"
},
{
"info": {
"name": "Expected Country Arrivals",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/expectedarrivals/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 4 to get the latest"
},
{
"name": "country",
"value": "",
"type": "query",
"description": "The Country code of interest. Response includes all ports within the Country"
},
{
"name": "timespan",
"value": "",
"type": "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"
},
{
"name": "days_last_signal",
"value": "",
"type": "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."
},
{
"name": "fromdate",
"value": "",
"type": "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"
},
{
"name": "todate",
"value": "",
"type": "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"
},
{
"name": "fromportid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the previous port (found on the URL of the respective Port page) or previous port UNLOCODE"
},
{
"name": "shiptype",
"value": "",
"type": "query",
"description": "Filter data by vessel type:
\n - 2: Fishing
\n - 4: High Speed Craf
\n - 6: Passenger
\n - 7: Cargo
\n - 8: Tanker
"
},
{
"name": "dwt_min",
"value": "",
"type": "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"
},
{
"name": "dwt_max",
"value": "",
"type": "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"
},
{
"name": "gt_min",
"value": "",
"type": "query",
"description": "Data filter: minimum GT Applicable to IMO-having vessels. If used, then you should also define the gt_max parameter"
},
{
"name": "gt_max",
"value": "",
"type": "query",
"description": "Data filter: maximum GT Applicable to IMO-having vessels. If used, then you should also define the gt_min parameter"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - jsono
"
}
]
},
"docs": "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 y"
},
{
"info": {
"name": "Predictive Port Arrivals",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/predictive-arrivals/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "portid",
"value": "",
"type": "query",
"description": "The MarineTraffic ID of the port you wish to receive probable visits (found on the URL of the respective Port page)"
},
{
"name": "market",
"value": "",
"type": "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
"
},
{
"name": "shipclass",
"value": "",
"type": "query",
"description": "Define ship class of interest - more"
},
{
"name": "probability",
"value": "",
"type": "query",
"description": "Define probability over which you would like to receive probable visits (accepted > 0.3)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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 allowe"
},
{
"info": {
"name": "Port Congestion",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/port-congestion/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "portid",
"value": "",
"type": "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"
},
{
"name": "year",
"value": "",
"type": "query",
"description": "Year of interest (data available back to 1 year). Information further back can be requested ad-hoc"
},
{
"name": "week",
"value": "",
"type": "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)"
},
{
"name": "market",
"value": "",
"type": "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)"
},
{
"name": "shipclass",
"value": "",
"type": "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)"
},
{
"name": "agg_port",
"value": "",
"type": "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
"
},
{
"name": "agg_market",
"value": "",
"type": "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
"
},
{
"name": "agg_shipclass",
"value": "",
"type": "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
"
},
{
"name": "time_anch",
"value": "",
"type": "query",
"description": "The median number of days spent at anchorage by the selected market/shipclass.\nValues indicate in between set to be returned Comma separated float\nnumbers (one decimal)\nAvailable only if extended version of the API is used"
},
{
"name": "time_port",
"value": "",
"type": "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"
},
{
"name": "vessels",
"value": "",
"type": "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"
},
{
"name": "calls",
"value": "",
"type": "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"
},
{
"name": "time_anch_stdev",
"value": "",
"type": "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"
},
{
"name": "time_anch_diff",
"value": "",
"type": "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"
},
{
"name": "time_anch_diff_perc",
"value": "",
"type": "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"
},
{
"name": "time_port_stdev",
"value": "",
"type": "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"
},
{
"name": "time_port_diff",
"value": "",
"type": "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"
},
{
"name": "time_port_diff_perc",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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<"
}
]
},
{
"info": {
"name": "Routing Information",
"type": "folder"
},
"items": [
{
"info": {
"name": "Vessel Route to Port",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportroutes/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "mmsi",
"value": "",
"type": "query",
"description": "The Maritime Mobile Service Identity (MMSI) of the vessel you wish to track You can instead use imo or shipid"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to track"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel"
},
{
"name": "port_target_id",
"value": "",
"type": "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"
},
{
"name": "includealternatives",
"value": "",
"type": "query",
"description": "Use 1 to search for all available routes regarding the specific journey or 0 to not include alternative routes"
},
{
"name": "includeinland",
"value": "",
"type": "query",
"description": "Use 1 in order to receive routes which include inland waterways or 0 to not include alternative routes"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9\nReceive 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 technicall"
},
{
"info": {
"name": "Distance to Port",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportroutes/:api_key ",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "port_start_id",
"value": "",
"type": "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"
},
{
"name": "LAT",
"value": "",
"type": "query",
"description": "The latitude of the starting point It can be used together with LON instead of port_start_id"
},
{
"name": "LON",
"value": "",
"type": "query",
"description": "The longitude of the starting point It can be used together with LAT instead of port_start_id"
},
{
"name": "port_target_id",
"value": "",
"type": "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"
},
{
"name": "includealternatives",
"value": "",
"type": "query",
"description": "Use 1 to search for all available routes regarding the specific journey or 0 to not include alternative routes"
},
{
"name": "includeinland",
"value": "",
"type": "query",
"description": "Use 1 in order to receive routes which include inland waterways or 0 to not include alternative routes"
},
{
"name": "msgtype",
"value": "",
"type": "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"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "A newer version of this endpoint is available here: https://developers.kpler.com/spec/c78f79cf-4169-4a59-987d-e5970ea170f9\nReceive 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"
}
]
},
{
"info": {
"name": "Reverse Geocoding",
"type": "folder"
},
"items": [
{
"info": {
"name": "Reverse Geocoding of a Single Point",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/reversegeocode/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "coordinates",
"value": "",
"type": "query",
"description": "A latitude/longitude pair that you wish to receive the MarineTraffic areas/assets that intersects with"
},
{
"name": "radius",
"value": "",
"type": "query",
"description": "Maximum distance (in NM) from the given point that should be searched for nearby areas/assets Cannot be greater than 10NM"
},
{
"name": "exclude_ports",
"value": "",
"type": "query",
"description": "Flag that indicates if Ports information will be excluded from response in case given point intersects with them (0:no, 1:yes)"
},
{
"name": "exclude_berths",
"value": "",
"type": "query",
"description": "Flag that indicates if Berths information will be excluded from response in case given point intersects with them (0:no, 1:yes)"
},
{
"name": "exclude_terminals",
"value": "",
"type": "query",
"description": "Flag that indicates if Terminals information will be excluded from response in case given point intersects with them (0:no, 1:yes)"
},
{
"name": "exclude_standard_areas",
"value": "",
"type": "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)"
},
{
"name": "exclude_custom_areas",
"value": "",
"type": "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)"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following:
\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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
"
}
]
},
{
"info": {
"name": "Fleets",
"type": "folder"
},
"items": [
{
"info": {
"name": "Modify Fleet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/setfleet/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "mmsi",
"value": "",
"type": "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"
},
{
"name": "imo",
"value": "",
"type": "query",
"description": "The International Maritime Organization (IMO) number of the vessel you wish to handle, comma separated values supported"
},
{
"name": "shipid",
"value": "",
"type": "query",
"description": "A uniquely assigned ID by MarineTraffic for the subject vessel, comma separated values supported"
},
{
"name": "fleet_id",
"value": "",
"type": "query",
"description": "If used, vessel will be added to the specific fleet, otherwise default fleet is used"
},
{
"name": "active",
"value": "",
"type": "query",
"description": "Possible values are: \n - 0 to set to inactive
\n - 1 to activate
\n - 2 to enable satellite coverage
\n
"
},
{
"name": "delete",
"value": "",
"type": "query",
"description": "Set this parameter to 1 to delete a vessel from your fleet"
}
]
},
"docs": "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 t"
},
{
"info": {
"name": "Vessels in Fleet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/getfleet/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "v",
"value": "",
"type": "query",
"description": "Version of the service to be executed. Use version 2 to get the latest"
},
{
"name": "fleet_id",
"value": "",
"type": "query",
"description": "If used, will return specific fleet otherwise default fleet is used"
},
{
"name": "page",
"value": "",
"type": "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."
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Response type. Use one of the following: \n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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\n - xml
\n - csv
\n - json
\n - jsono
"
}
]
},
"docs": "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
"
},
{
"info": {
"name": "Clear Fleet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/clearfleet/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
},
{
"name": "fleet_id",
"value": "",
"type": "query",
"description": "The fleet id you wish to clear"
}
]
},
"docs": "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
"
}
]
},
{
"info": {
"name": "Balances",
"type": "folder"
},
"items": [
{
"info": {
"name": "Credits Balance",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://services.marinetraffic.com/api/exportcredits/:api_key",
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
}
]
},
"docs": "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
"
}
]
},
{
"info": {
"name": "Passage Plans",
"type": "folder"
},
"items": [
{
"info": {
"name": "Import Passage Plan",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://services.marinetraffic.com/api/import-passage-plan/:api_key",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "api_key",
"value": "",
"type": "path",
"description": "API key: 40-character hexadecimal number"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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 over"
}
]
}
],
"bundled": true
}