Getting Started

Sections

Theme switcher

Dry Historical Ship Status

Header Parameters

Authorizationstring Required

Bearer token used for authentication.

Query Parameters

page_sizeinteger

Maximum number of results per page.

Example 10

Maximum
10000
afterstring

Cursor of the last event. Will return events after this one based on filters.

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
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: 50881,98331
  • parameterRepeated: vessel_ids=50881&vessel_ids=98331
imosstring

List of vessel IMOs as array. Can be used either as a string, separated by commas, or by repeating the parameter. Examples

  • commaSeparated: 8419520,9281906
  • parameterRepeated: imos=8419520&imos=9281906
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

ais_date_fromstring

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

Example 2024-01-01T00:00:00

ais_date_tostring

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

Example 2025-04-01T00:00:00

ais_heading_frominteger

Ais heading from.

Example 0

ais_heading_tointeger

Ais heading to.

Example 180

ais_draft_fromnumber

Ais draft from.

Example 5

ais_draft_tonumber

Ais draft to.

Example 15

ais_speed_fromnumber

Ais speed from.

Example 5

ais_speed_tonumber

Ais speed to.

Example 15

snapshot_hoursstring

List of snapshot hours. Can be used either as an integer, separated by commas, or by repeating the parameter. Only 0,6,12,18 values are allowed.

Examples

  • commaSeparated: 0,12
  • parameterRepeated: snapshot_hours=0&snapshot_hours=12
snapshot_time_fromstring

Beginning of the time of the snapshot. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2024-12-24T15:00:00

snapshot_time_tostring

End of the time of the snapshot. Date-time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss) and UTC.

Example 2024-12-27T15:00:00

updated_afterstring

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

Example 2025-01-01T00:00:00

vessel_main_statusesstring

List of vessel main statuses. Can be used either as a string separated by commas, or by repeating the parameter.

Available values: at_shipyard, at_berth, at_anchorage, at_canal, at_port, at_sea

Examples

  • commaSeparated: at_berth,at_anchorage
  • parameterRepeated: vessel_main_statuses=at_berth&vessel_main_statuses=at_anchorage
include_cabotageboolean

Include vessels in cabotage voyages.

Example true

commoditiesstring

List of commodities. Can be used either as a string separated by commas, or by repeating the parameter.

Examples

  • commaSeparated: Iron Ore,Coal
  • parameterRepeated: commodities=Iron Ore&commodities=Coal
voyage_typestring

Filter by voyage type.

Example laden

Enum values:
ladenballast
is_in_blackoutboolean

Filter by blackout status. Set to true to only return vessels currently in blackout, false to exclude them.

Example true

destinationsstring

Filter by destination port/country. Accepts location IDs (numeric strings), location names or location UN/LOCODE. Multiple values use OR logic.

Examples

  • commaSeparated: Singapore,Shanghai
  • parameterRepeated: destinations=Singapore&destinations=Shanghai

Response

200
Object

OK

Response Attributes

resultsarray

ShowΒ child attributes

All Of:

nextstring

Only available if there are more items than the requested page_size for the same parameters. This is a link to the next page of the request, using the same parameters.

GET

/

Select
1

Response