Liner Polygon Events
Header Parameters
Bearer token used for authentication.
Query Parameters
Maximum number of results per page.
Example 10
List of polygon Ids as array. Can be used either as an integer, separated by commas, or by repeating the parameter.
Examples
- commaSeparated:
19896,9242 - parameterRepeated:
polygon_ids=19896&polygon_ids=9242
List of polygon types as array. Can be used either as an string, separated by commas, or by repeating the parameter.
Examples
- commaSeparated:
zone,anchorage - parameterRepeated:
polygon_types=zone&polygon_types=anchorage
List of ancestor polygons as array. Can be used either as an string, separated by commas, or by repeating the parameter. Filters polygonEvents by the parent polygons that contain the event. Must be combined with polygon_types to narrow the search to specific child types. Values may be UN/LOCODE, Numeric ID, Human-readable name.
Examples
- commaSeparated:
NL,NLRTM - parameterRepeated:
ancestor_polygons=NL&ancestor_polygons=NLRTM
List of vessel unique IDs as array. Can be used either as a string, separated by commas, or by repeating the parameter. Examples
- commaSeparated:
108728,4105 - parameterRepeated:
vessel_ids=108728&vessel_ids=4105
List of vessel IMOs as array. Can be used either as a string, separated by commas, or by repeating the parameter.
Examples
- commaSeparated:
9388534,9996680 - parameterRepeated:
imos=9388534&imos=9996680
Vessel built from.
Recognized date format is YYYY-MM-DD
Example 2005-01-01
Vessel built to.
Recognized date format is YYYY-MM-DD
Example 2006-01-01
Vessel beam from.
Example 45
Vessel beam to.
Example 55
Vessel loa from.
Example 200
Vessel loa to.
Example 300
Vessel draft from.
Example 10
Vessel draft to.
Example 20
Vessel dwt from.
Example 200000
Vessel dwt to.
Example 300000
Vessel TEU from.
Example 2000
Vessel TEU to.
Example 20000
List of vessel service ids as array. Can be used either as a string, separated by commas, or by repeating the parameter. Examples
- commaSeparated:
666,291 - parameterRepeated:
vessel_service_ids=666&vessel_service_ids=291
List of service region ids as array. Can be used either as a string, separated by commas, or by repeating the parameter.
Examples
- commaSeparated:
35,68 - parameterRepeated:
vessel_service_region_ids=35&vessel_service_region_ids=68
Entry date from. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.
Example 2025-04-01T00:00:00
Entry date to. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.
Example 2025-04-10T00:00:00
Entry heading from.
Example 0
Entry heading to.
Example 180
Entry draft from.
Example 5
Entry draft to.
Example 15
Entry speed from.
Example 5
Entry speed to.
Example 15
Out date from. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.
Example 2025-04-01T00:00:00
Out date to. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.
Example 2025-04-10T00:00:00
Out heading from.
Example 60
Out heading to.
Example 180
Out draft from.
Example 5
Out draft to.
Example 15
Out speed from.
Example 5
Out speed to.
Example 15
Is the event opened?
Example false
Polygon event updated after. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.
Example 2025-06-01T00:00:00
Response
Response Attributes
Object containing useful links for the API.