Welcome to the Veson Nautical Knowledge Base. In the Help Center, you can view the same articles and contact support as needed.
Tonnage Service
- Laura Packard
(getGlobalTonnageStatus)
Fetches global tonnage status timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
v3GetGlobalTonnageStatusResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"globalTonnageZoneCounts" : [ {
"date" : "date",
"vesselDwt" : 1.4658129805029452,
"vesselCount" : 6,
"zoneId" : 0,
"zoneName" : "zoneName",
"avgSpeed" : 5.962133916683182
}, {
"date" : "date",
"vesselDwt" : 1.4658129805029452,
"vesselCount" : 6,
"zoneId" : 0,
"zoneName" : "zoneName",
"avgSpeed" : 5.962133916683182
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetGlobalTonnageStatusResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/basin
(getTonnageBasinCount)
Provides timeseries data on the number of vessels that are within the four major basins.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageBasinRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetTonnageBasinResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/chinesewaters
(getTonnageChineseWaters)
Provides chinese waters tonnage timeseries data. This timeseries shows the number of Chinese flagged that are trading inside and outside of Chinese waters respectively.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TonnageChineseWatersRequest (required)
Body Parameter —
Return type
v3TonnageChineseWatersResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
}, {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
}, {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3TonnageChineseWatersResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/fleetgrowth
(getTonnageFleetGrowth)
Provides fleet growth timeseries of how the fleet have developed over time. This timeseries shows number of vessels added to/removed from the fleet during any given period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageFleetRequest (required)
Body Parameter —
Return type
v3GetTonnageFleetGrowthResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
}, {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
}, {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetTonnageFleetGrowthResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/speed
(getTonnageFleetSpeed)
Fetches fleet speed timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetFleetSpeedResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/fleetstatus
(getTonnageFleetStatus)
Provides fleet status timeseries of how the fleet have developed over time. This timeseries shows number of active vessels on the water at any given time.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageFleetRequest (required)
Body Parameter —
Return type
v3GetTonnageFleetStatusResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetTonnageFleetStatusResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/zonechanges
(getTonnageZoneChanges)
Provides timeseries data on the number of vessels that cross zone boundaries during any given period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageZoneChangesRequest (required)
Body Parameter —
Return type
v3GetTonnageZoneChangesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetTonnageZoneChangesResponse
default
An unexpected error response. rpcStatus
Â
post /v3/tonnage/zone
(getTonnageZoneCount)
Fetches tonnage counts timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"csv" : "csv"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3GetTonnageZoneCountResponse
default
An unexpected error response. rpcStatus
Still need help? Visit the Veson Nautical Help Center.
Copyright © 2017-2024 Veson Nautical LLC All Rights Reserved - Privacy Notice | End User Terms of Use