Getting Started

Sections

Theme switcher

Dry Vessels

Header Parameters

Authorizationstring Required

Token used for authentication.

Query Parameters

pageinteger

Page number

Minimum
1
Default value
1
limitinteger

The numbers of items to return. Max 500. Min 1. Default 25.

Minimum
1
Maximum
500
Default value
25
update_date_orderstring

Sort result set by update date in ascending or descending order. Allowed values - asc | desc.

Enum values:
ascdesc
propertiesstring

Return specified properties. Comma separated list. Ex. id,imo,name,dwt,built

imosstring

List of vessel IMOs (comma-separated list).

vessel_namestring

Fetch vessels by name. Min characters - 3. Ex. value cape|cape*|*cape|*cape*. NB. No special characters (&,/,,',",?,.,{,}). Space is allowed.

typeinteger

Fetch vessels where type matched value. See /shipinfo/types for available types. Ex. value 221 (Bulk carrier).

subtypeinteger

Fetch vessels where subtype matched value. See /shipinfo/types for available subtypes. Ex. value 20 (Heavy Load Carrier).

categoryinteger

Fetch vessels where category matched value. See /shipinfo/categories for available categories. Ex. value 16 (VLOC).

ship_statusinteger

Fetch vessels where status matched value. See /shipinfo/statuses for available statuses. Ex. value 2 (DELIVERED).

built_fromstring

Fetch vessels where built year is greater than or equal to value. Ex. value 2010-05-16.

built_tostring

Fetch vessels where built year is less than or equal to value. Ex. value 2022-12-31.

update_date_fromstring

Fetch vessels where update date is greater or equal to given date. Ex. value 2022-05-16.

Response

200
Object

List of vessel resources.

Response Attributes

totalinteger

The total results from current query.

resultsarray
codeinteger Required
messagestring Required

GET

/

Select
1

Response