Vessels by Navigational Status

POST

get-vessels-by-navigational-status

curl --request POST \
  --url https://datadocked.com/api/vessels_operations/get-vessels-by-navigational-status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "navigational_status": "at-anchor",
  "world_zone": "baltic-sea",
  "vessel_type": "bulk-carrier"
}
'

{
  "vessels": [
    {
      "imo": "9876543",
      "mmsi": "123456789",
      "name": "VESSEL NAME",
      "country": "Panama",
      "shipType": "Bulk Carrier"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Returns a list of vessels currently matching a specified AIS navigational status, with optional filters for world zone, vessel type, laden condition, and for-order availability.

Credits: 10 credits per request

Request Parameters

Field	Type	Required	Description
`navigational_status`	string	Yes	AIS navigational status
`world_zone`	string	Conditional	Required unless status is `drifting`, `constrained`, or `aground`
`vessel_type`	string	No	Filter by vessel type
`laden`	string	No	Laden/ballast condition
`for_order`	string	No	Whether vessel is sailing for orders

Navigational Status Values

Value	Description
`under-way`	Vessel is underway using engine
`at-anchor`	Vessel is at anchor
`drifting`	Vessel is drifting (world_zone not required)
`restricted`	Vessel has restricted manoeuvrability
`constrained`	Vessel is constrained by her draught (world_zone not required)
`moored`	Vessel is moored
`aground`	Vessel is aground (world_zone not required)
`fishing`	Vessel is engaged in fishing
`sailing`	Vessel is underway sailing

World Zones

View all world zones

Value	Region
`north-canada`	North Canada
`great-lakes`	Great Lakes
`north-west-atlantic-ocean`	NW Atlantic Ocean
`us-east-coast`	US East Coast
`us-inland`	US Inland
`gulf-of-mexico`	Gulf of Mexico
`caribbean-sea`	Caribbean Sea
`north-america-west-coast`	North America West Coast
`south-america-east-coast`	South America East Coast
`south-america-west-coast`	South America West Coast
`south-america-inland`	South America Inland
`north-east-atlantic-ocean`	NE Atlantic Ocean
`north-sea`	North Sea
`baltic-sea`	Baltic Sea
`west-mediterranean`	West Mediterranean
`east-mediterranean`	East Mediterranean
`adriatic-sea`	Adriatic Sea
`aegean-sea`	Aegean Sea
`marmara-sea`	Marmara Sea
`black-sea`	Black Sea
`azov-sea`	Azov Sea
`caspian-sea`	Caspian Sea
`europe-inland`	Europe Inland
`north-russia`	North Russia
`russia-inland`	Russia Inland
`west-africa`	West Africa
`south-africa`	South Africa
`east-africa`	East Africa
`red-sea`	Red Sea
`persian-gulf`	Persian Gulf
`arabian-sea`	Arabian Sea
`indian-coast`	Indian Coast
`indian-ocean`	Indian Ocean
`south-east-asia`	South-East Asia
`indonesia`	Indonesia
`china-coast`	China Coast
`east-asia`	East Asia
`west-australia`	West Australia
`east-australia`	East Australia
`north-pacific-ocean`	North Pacific Ocean
`south-pacific-ocean`	South Pacific Ocean

Vessel Types

Cargo vessels

cargo-vessels, bulk-carrier, general-cargo, container-ship, reefer, ro-ro, vehicles-carrier, cement-carrier, wood-chips carrier, urea-carrier, aggregates-carrier, limestone-carrier, landing-craft, livestock-carrier, heavy-load-carrier

Tankers

tankers, crude-oil-tanker, oil-products-tanker, chemical-oil tanker, lng-tanker, lpg-tanker, asphalt-bitumen, bunkering-tanker, fso-fpso, other-tankers

Passenger vessels

passenger-and-cruise-ships, cruise-ships, passenger-cargo-ships, passenger-roro-ships, passenger-ships

Other vessel types

fishing-ships, yachts-or-sailing-vessels, military, tugs, other-type-or-auxiliary, unknown

Laden Condition

Value	Description
`ballast`	Load factor 0–49%
`partial`	Load factor 50–75%
`laden`	Load factor 76–100%

For Order

Value	Description
`true`	Vessel is sailing for orders
`false`	Vessel is not sailing for orders

Response Fields

Field	Type	Description
`vessels`	array	List of matched vessels (empty array if none found)
`vessels[].imo`	string	IMO number
`vessels[].mmsi`	string	MMSI number
`vessels[].name`	string	Vessel name
`vessels[].country`	string	Country of registration
`vessels[].shipType`	string	Vessel type label

Examples

Bulk carriers at anchor in the Baltic Sea

{
  "navigational_status": "at-anchor",
  "world_zone": "baltic-sea",
  "vessel_type": "bulk-carrier"
}

All drifting vessels (no zone required)

{
  "navigational_status": "drifting"
}

Laden crude oil tankers moored in the Persian Gulf, for orders

{
  "navigational_status": "moored",
  "world_zone": "persian-gulf",
  "vessel_type": "crude-oil-tanker",
  "laden": "laden",
  "for_order": "true"
}

Authorizations

x-api-key

string

header

required

Your personal API key found in your profile dashboard at https://datadocked.com/dashboard/my_keys

Body

application/json

navigational_status

enum<string>

required

AIS navigational status. For drifting, constrained, and aground statuses, world_zone is not required.

Available options:

under-way,

at-anchor,

drifting,

restricted,

constrained,

moored,

aground,

fishing,

sailing

world_zone

enum<string>

Ocean/sea zone. Required unless navigational_status is drifting, constrained, or aground.

Available options:

north-canada,

great-lakes,

north-west-atlantic-ocean,

us-east-coast,

us-inland,

gulf-of-mexico,

caribbean-sea,

north-america-west-coast,

south-america-east-coast,

south-america-west-coast,

south-america-inland,

north-east-atlantic-ocean,

north-sea,

baltic-sea,

west-mediterranean,

east-mediterranean,

adriatic-sea,

aegean-sea,

marmara-sea,

black-sea,

azov-sea,

caspian-sea,

europe-inland,

north-russia,

russia-inland,

west-africa,

south-africa,

east-africa,

red-sea,

persian-gulf,

arabian-sea,

indian-coast,

indian-ocean,

south-east-asia,

indonesia,

china-coast,

east-asia,

west-australia,

east-australia,

north-pacific-ocean,

south-pacific-ocean

vessel_type

enum<string>

Filter by vessel type

Available options:

cargo-vessels,

bulk-carrier,

general-cargo,

container-ship,

reefer,

ro-ro,

vehicles-carrier,

cement-carrier,

wood-chips carrier,

urea-carrier,

aggregates-carrier,

limestone-carrier,

landing-craft,

livestock-carrier,

heavy-load-carrier,

tankers,

crude-oil-tanker,

oil-products-tanker,

chemical-oil tanker,

lng-tanker,

lpg-tanker,

asphalt-bitumen,

bunkering-tanker,

fso-fpso,

other-tankers,

passenger-and-cruise-ships,

cruise-ships,

passenger-cargo-ships,

passenger-roro-ships,

passenger-ships,

fishing-ships,

yachts-or-sailing-vessels,

military,

tugs,

other-type-or-auxiliary,

unknown

laden

enum<string>

Laden/ballast condition. ballast=0-49%, partial=50-75%, laden=76-100%

Available options:

ballast,

partial,

laden

for_order

enum<string>

Whether vessel is sailing for orders

Available options:

true,

false

Response

Successful response with matching vessels

vessels

object[]

Show child attributes

curl --request POST \
  --url https://datadocked.com/api/vessels_operations/get-vessels-by-navigational-status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "navigational_status": "at-anchor",
  "world_zone": "baltic-sea",
  "vessel_type": "bulk-carrier"
}
'

{
  "vessels": [
    {
      "imo": "9876543",
      "mmsi": "123456789",
      "name": "VESSEL NAME",
      "country": "Panama",
      "shipType": "Bulk Carrier"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Overview

Account

Vessel Operations

Port Operations

Vessels by Navigational Status

Request Parameters

Navigational Status Values

World Zones

Vessel Types

Laden Condition

For Order

Response Fields

Examples

Bulk carriers at anchor in the Baltic Sea

All drifting vessels (no zone required)

Laden crude oil tankers moored in the Persian Gulf, for orders

Authorizations

Body

Response

​Request Parameters

​Navigational Status Values

​World Zones

​Vessel Types

​Laden Condition

​For Order

​Response Fields

​Examples

​Bulk carriers at anchor in the Baltic Sea

​All drifting vessels (no zone required)

​Laden crude oil tankers moored in the Persian Gulf, for orders

Authorizations

Body

Response

Request Parameters

Navigational Status Values

World Zones

Vessel Types

Laden Condition

For Order

Response Fields

Examples

Bulk carriers at anchor in the Baltic Sea

All drifting vessels (no zone required)

Laden crude oil tankers moored in the Persian Gulf, for orders