Trade Flow Service
(getLocationVolume)
GetLocationVolume gets location (port/berth/country/region) flow stats for the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"locationName" : "locationName",
"locationId" : "locationId",
"countryCode" : "countryCode",
"locationType" : "locationType",
"value" : 0.8008281904610115,
"coords" : {
"lon" : 1.4658129805029452,
"lat" : 6.027456183070403
}
}, {
"locationName" : "locationName",
"locationId" : "locationId",
"countryCode" : "countryCode",
"locationType" : "locationType",
"value" : 0.8008281904610115,
"coords" : {
"lon" : 1.4658129805029452,
"lat" : 6.027456183070403
}
} ]
}
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. v3GetLocationVolumeResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/aggregation
(getTradeFlowAggregation)
Aggregates tradeflow data across multiple dimensions.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowAggregationResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"rows" : [ {
"category" : "category",
"value" : 0.8008281904610115
}, {
"category" : "category",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"category" : "category",
"value" : 0.8008281904610115
}, {
"category" : "category",
"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. v3GetTradeFlowAggregationResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/histogram
(getTradeFlowHistogram)
GetTradeFlowHistogramValues gets trade flow histogram values by grouping.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowHistogramResponse
Example data
Content-Type: application/json
{
"groupingVariable" : "groupingVariable",
"numberOfGroups" : 0,
"groups" : [ {
"numberOfValues" : 6,
"values" : [ 1.4658129805029452, 1.4658129805029452 ],
"group" : "group"
}, {
"numberOfValues" : 6,
"values" : [ 1.4658129805029452, 1.4658129805029452 ],
"group" : "group"
} ]
}
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. v3GetTradeFlowHistogramResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/onthewater
(getTradeFlowOnTheWater)
Gets aggregated trade flow timeseries (on the water) by period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"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. v3GetTradeFlowTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/timeseries
(getTradeFlowTimeseries)
Gets aggregated trade flow timeseries by period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"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. v3GetTradeFlowTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/listflows
(getTradeFlows)
GetVoyages retrieves all the individual voyages for the given filter parameters. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of voyages to return per query.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"loadPortUnberthedAt" : "loadPortUnberthedAt",
"ballastStartedAt" : "ballastStartedAt",
"subSegment" : "subSegment",
"dischargeCountry" : "dischargeCountry",
"daysTotalDuration" : 1.4894159098541704,
"loadPortBerthedAt" : "loadPortBerthedAt",
"loadPortDaysWaiting" : 9.301444243932576,
"loadBerthId" : 5,
"ballastCountry" : "ballastCountry",
"eta" : "eta",
"ballastCountryCode" : "ballastCountryCode",
"loadPortDaysBerthed" : 7.061401241503109,
"segment" : "segment",
"commodityGroup" : "commodityGroup",
"dischargeCountryCode" : "dischargeCountryCode",
"dischargePortDaysWaiting" : 1.2315135367772556,
"ballastPortUnlocode" : "ballastPortUnlocode",
"volume" : 1.4658129805029452,
"dischargePortBerthedAt" : "dischargePortBerthedAt",
"daysSteaming" : 1.0246457001441578,
"voyageId" : "voyageId",
"dischargePortName" : "dischargePortName",
"loadPortId" : 5,
"vesselName" : "vesselName",
"status" : "status",
"dwt" : 6.027456183070403,
"commodity" : "commodity",
"dischargeBerthId" : 2,
"parceling" : true,
"ballastPortName" : "ballastPortName",
"dischargePortDaysBerthed" : 7.386281948385884,
"distanceCalculated" : 6.84685269835264,
"dischargePortDepartedAt" : "dischargePortDepartedAt",
"destination" : "destination",
"imo" : 0,
"dischargePortUnberthedAt" : "dischargePortUnberthedAt",
"loadPortDaysTotal" : 2.3021358869347655,
"dischargePortArrivedAt" : "dischargePortArrivedAt",
"ballastPortId" : 1,
"loadCountry" : "loadCountry",
"dischargeRegion" : "dischargeRegion",
"flowId" : "flowId",
"loadPortName" : "loadPortName",
"loadBerthName" : "loadBerthName",
"loadPortUnlocode" : "loadPortUnlocode",
"dischargePortDaysTotal" : 4.145608029883936,
"dischargePortUnlocode" : "dischargePortUnlocode",
"loadPortDepartedAt" : "loadPortDepartedAt",
"dischargePortId" : 3,
"distanceActual" : 7.457744773683766,
"loadRegion" : "loadRegion",
"ballastRegion" : "ballastRegion",
"loadPortArrivedAt" : "loadPortArrivedAt",
"dischargeBerthName" : "dischargeBerthName",
"commodityValue" : "commodityValue",
"loadCountryCode" : "loadCountryCode"
}, {
"loadPortUnberthedAt" : "loadPortUnberthedAt",
"ballastStartedAt" : "ballastStartedAt",
"subSegment" : "subSegment",
"dischargeCountry" : "dischargeCountry",
"daysTotalDuration" : 1.4894159098541704,
"loadPortBerthedAt" : "loadPortBerthedAt",
"loadPortDaysWaiting" : 9.301444243932576,
"loadBerthId" : 5,
"ballastCountry" : "ballastCountry",
"eta" : "eta",
"ballastCountryCode" : "ballastCountryCode",
"loadPortDaysBerthed" : 7.061401241503109,
"segment" : "segment",
"commodityGroup" : "commodityGroup",
"dischargeCountryCode" : "dischargeCountryCode",
"dischargePortDaysWaiting" : 1.2315135367772556,
"ballastPortUnlocode" : "ballastPortUnlocode",
"volume" : 1.4658129805029452,
"dischargePortBerthedAt" : "dischargePortBerthedAt",
"daysSteaming" : 1.0246457001441578,
"voyageId" : "voyageId",
"dischargePortName" : "dischargePortName",
"loadPortId" : 5,
"vesselName" : "vesselName",
"status" : "status",
"dwt" : 6.027456183070403,
"commodity" : "commodity",
"dischargeBerthId" : 2,
"parceling" : true,
"ballastPortName" : "ballastPortName",
"dischargePortDaysBerthed" : 7.386281948385884,
"distanceCalculated" : 6.84685269835264,
"dischargePortDepartedAt" : "dischargePortDepartedAt",
"destination" : "destination",
"imo" : 0,
"dischargePortUnberthedAt" : "dischargePortUnberthedAt",
"loadPortDaysTotal" : 2.3021358869347655,
"dischargePortArrivedAt" : "dischargePortArrivedAt",
"ballastPortId" : 1,
"loadCountry" : "loadCountry",
"dischargeRegion" : "dischargeRegion",
"flowId" : "flowId",
"loadPortName" : "loadPortName",
"loadBerthName" : "loadBerthName",
"loadPortUnlocode" : "loadPortUnlocode",
"dischargePortDaysTotal" : 4.145608029883936,
"dischargePortUnlocode" : "dischargePortUnlocode",
"loadPortDepartedAt" : "loadPortDepartedAt",
"dischargePortId" : 3,
"distanceActual" : 7.457744773683766,
"loadRegion" : "loadRegion",
"ballastRegion" : "ballastRegion",
"loadPortArrivedAt" : "loadPortArrivedAt",
"dischargeBerthName" : "dischargeBerthName",
"commodityValue" : "commodityValue",
"loadCountryCode" : "loadCountryCode"
} ],
"nextToken" : "nextToken",
"csv" : "csv",
"prevToken" : "prevToken"
}
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. v3GetTradeFlowsResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/tradelanemetrics
(getTradeLaneMetrics)
GetTradeflowModelVoyage gets trade flow model voyage values by grouping
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"groupingVariable" : "groupingVariable",
"tradeLaneMetrics" : [ {
"avgVoyageDurationsDays" : 7.061401241503109,
"sumOfVolume" : 5.025004791520295,
"uniqueVessels" : 9,
"avgDischargePortDaysWaiting" : 5.637376656633329,
"medianDischargePortDaysWaiting" : 1.4894159098541704,
"avgVolume" : 3.616076749251911,
"medianVolume" : 7.457744773683766,
"avgDaysAtSea" : 6.027456183070403,
"avgSpeed" : 9.301444243932576,
"medianDistanceNm" : 1.1730742509559433,
"uniqueLoadPorts" : 9,
"avgDischargePortDaysBerthed" : 2.3021358869347655,
"medianDischargePortDaysBerthed" : 6.84685269835264,
"medianLoadPortDaysBerthed" : 1.0246457001441578,
"medianLoadPortDaysWaiting" : 1.2315135367772556,
"numberOfVoyages" : 4,
"avgDistanceCalculatedNm" : 4.145608029883936,
"medianDaysAtSea" : 7.386281948385884,
"avgLoadPortDaysWaiting" : 1.4658129805029452,
"avgLoadPortDaysBerthed" : 5.962133916683182,
"avgDistanceNm" : 2.027123023002322,
"uniqueDischargePorts" : 6,
"group" : "group"
}, {
"avgVoyageDurationsDays" : 7.061401241503109,
"sumOfVolume" : 5.025004791520295,
"uniqueVessels" : 9,
"avgDischargePortDaysWaiting" : 5.637376656633329,
"medianDischargePortDaysWaiting" : 1.4894159098541704,
"avgVolume" : 3.616076749251911,
"medianVolume" : 7.457744773683766,
"avgDaysAtSea" : 6.027456183070403,
"avgSpeed" : 9.301444243932576,
"medianDistanceNm" : 1.1730742509559433,
"uniqueLoadPorts" : 9,
"avgDischargePortDaysBerthed" : 2.3021358869347655,
"medianDischargePortDaysBerthed" : 6.84685269835264,
"medianLoadPortDaysBerthed" : 1.0246457001441578,
"medianLoadPortDaysWaiting" : 1.2315135367772556,
"numberOfVoyages" : 4,
"avgDistanceCalculatedNm" : 4.145608029883936,
"medianDaysAtSea" : 7.386281948385884,
"avgLoadPortDaysWaiting" : 1.4658129805029452,
"avgLoadPortDaysBerthed" : 5.962133916683182,
"avgDistanceNm" : 2.027123023002322,
"uniqueDischargePorts" : 6,
"group" : "group"
} ],
"numberOfGroups" : 0
}
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. v3GetTradeLaneMetricsResponse
default
An unexpected error response. rpcStatus