Getting Started

Sections

Theme switcher

Liner Polygon Events

Header Parameters

Authorizationstring Required

Bearer token used for authentication.

Query Parameters

page_sizeinteger

Maximum number of results per page.

Example 10

Maximum
10000
polygon_idsstring

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
polygon_typesstring

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
ancestor_polygonsstring

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
vessel_idsstring

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
imosstring

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_fromstring

Vessel built from.

Recognized date format is YYYY-MM-DD

Example 2005-01-01

vessel_built_tostring

Vessel built to.

Recognized date format is YYYY-MM-DD

Example 2006-01-01

vessel_beam_fromnumber

Vessel beam from.

Example 45

vessel_beam_tonumber

Vessel beam to.

Example 55

vessel_loa_fromnumber

Vessel loa from.

Example 200

vessel_loa_tonumber

Vessel loa to.

Example 300

vessel_draft_fromnumber

Vessel draft from.

Example 10

vessel_draft_tonumber

Vessel draft to.

Example 20

vessel_dwt_frominteger

Vessel dwt from.

Example 200000

vessel_dwt_tointeger

Vessel dwt to.

Example 300000

vessel_teu_frominteger

Vessel TEU from.

Example 2000

vessel_teu_tointeger

Vessel TEU to.

Example 20000

vessel_service_idsstring

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
vessel_service_region_idsstring

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_fromstring

Entry date from. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2025-04-01T00:00:00

entry_date_tostring

Entry date to. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2025-04-10T00:00:00

entry_heading_frominteger

Entry heading from.

Example 0

entry_heading_tointeger

Entry heading to.

Example 180

entry_draft_fromnumber

Entry draft from.

Example 5

entry_draft_tonumber

Entry draft to.

Example 15

entry_speed_fromnumber

Entry speed from.

Example 5

entry_speed_tonumber

Entry speed to.

Example 15

out_date_fromstring

Out date from. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2025-04-01T00:00:00

out_date_tostring

Out date to. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2025-04-10T00:00:00

out_heading_frominteger

Out heading from.

Example 60

out_heading_tointeger

Out heading to.

Example 180

out_draft_fromnumber

Out draft from.

Example 5

out_draft_tonumber

Out draft to.

Example 15

out_speed_fromnumber

Out speed from.

Example 5

out_speed_tonumber

Out speed to.

Example 15

is_open_eventboolean

Is the event opened?

Example false

updated_afterstring

Polygon event updated after. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2025-06-01T00:00:00

Response

200
Object
OK

Response Attributes

linksobject

Object containing useful links for the API.

Show child attributes

resultsarray

Show child attributes

GET

/

Select
1

Response