Dark Mode
/v2/sea-margin-port.json
POST
/v2/sea-margin-port.json
Sea-Margin Port to Port Data Specification
| Item | Value |
|---|---|
| Data Name | Sea Margin |
| Data Area | Global |
| Data Output Format | JSON / JSONP |
| Data Size | ~4 KB |
| No Data Value | -9999999 |
Sea-Margin Port to Port Data Elements
| No | Item Name | API Item Name | Value Type | Unit | Null Value | Example | Remarks |
|---|---|---|---|---|---|---|---|
| 1 | (Shortest without WF, CF) Distance | shortest_without_wfcf.distance | Number | nm | -9999999 | 3267 | |
| 2 | (Shortest without WF, CF) Days | shortest_without_wfcf.days | Number | Day | -9999999 | 11.3 | |
| 3 | (Shortest without WF, CF) Difference | shortest_without_wfcf.difference | Number | Day | -9999999 | - | |
| 4 | (Shortest without WF, CF) % | shortest_without_wfcf.sea_margin | Number | % | -9999999 | - | |
| 5 | (Shortest without WF, CF) FuelMT | shortest_without_wfcf.fuel_mt | Number | MT | -9999999 | 453.8 | |
| 6 | (Shortest without WF, CF) (Speed) AVG | shortest_without_wfcf.speed.avg | Number | Knots | -9999999 | - | |
| 7 | (Shortest without WF, CF) (Speed) WF | shortest_without_wfcf.speed.wf | Number | Knots | -9999999 | - | |
| 8 | (Shortest without WF, CF) (Speed) CF | shortest_without_wfcf.speed.cf | Number | Knots | -9999999 | - | |
| 9 | (Shortest without WF, CF) (Total Voyages) Numerator | shortest_without_wfcf.total_voyages.numerator | Number | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 10 | (Shortest without WF, CF) (Total Voyages) Denominator | shortest_without_wfcf.total_voyages.denominator | Number | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 11 | (Shortest without WF, CF) (Way Point) NavTrack | shortest_without_wfcf.total_voyages.NavTrack | String | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 12 | (Shortest without WF, CF) (Way Point) SourceID | shortest_without_wfcf.WayPoint.SourceID | String | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 13 | (Shortest without WF, CF) (Way Point) (SourceID) Lat | shortest_without_wfcf.WayPoint.SourceID.Lat | String | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 14 | (Shortest without WF, CF) (Way Point) (SourceID) Lon | shortest_without_wfcf.WayPoint.SourceID.Lon | String | - | -9999999 | 10 | Always -9999999 because the corresponding value does not exist. |
| 15 | (Shortest) Distance | shortest.distance | Number | nm | -9999999 | 3267 | |
| 16 | (Shortest) Days | shortest.days | Number | Day | -9999999 | 14.1 | |
| 17 | (Shortest) Difference | shortest.difference | Number | Day | -9999999 | 2.8 | |
| 18 | (Shortest) % | shortest.sea_margin | Number | % | -9999999 | 24.8 | Difference passage day between "shortest route without wf and cf" compare with "shortest route with wf and cf" |
| 19 | (Shortest) FuelMT | shortest.fuel_mt | Number | MT | -9999999 | 563.1 | |
| 20 | (Shortest) (Speed) AVG | shortest.speed.avg | Number | Knots | -9999999 | 10.1 | |
| 21 | (Shortest) (Speed) WF | shortest.speed.wf | Number | Knots | -9999999 | -1.7 | |
| 22 | (Shortest) (Speed) CF | shortest.speed.cf | Number | Knots | -9999999 | -0.2 | |
| 23 | (Shortest) (Total Voyages) Numerator | shortest.total_voyages.numerator | Number | - | -9999999 | 3 | Always -9999999 because the corresponding value does not exist. |
| 24 | (Shortest) (Total Voyages) Denominator | shortest.total_voyages.denominator | Number | - | -9999999 | 9 | Always -9999999 because the corresponding value does not exist. |
| 25 | (Shortest) (Way Point) NavTrack | shortest.total_voyages.NavTrack | String | - | -9999999 | RL | RL :Rhumb Line, GC :Great Circle |
| 26 | (Shortest) (Way Point) SourceID | shortest.WayPoint.SourceID | String | - | -9999999 | w0 | w0,w1,w2,... are the order of waypoints |
| 27 | (Shortest) (Way Point) (SourceID) Lat | shortest.WayPoint.SourceID.Lat | String | - | -9999999 | -7095 | Notation in 60 decimal |
| 28 | (Shortest) (Way Point) (SourceID) Lon | shortest.WayPoint.SourceID.Lon | String | - | -9999999 | 1964 | Notation in 60 decimal |
| 29 | (Shortest Navigated) Distance | shortest_navigated.distance | Number | nm | -9999999 | 3267 | |
| 30 | (Shortest Navigated) Days | shortest_navigated.days | Number | Day | -9999999 | 14.2 | |
| 31 | (Shortest Navigated) Difference | shortest_navigated.difference | Number | Day | -9999999 | 2.9 | |
| 32 | (Shortest Navigated) % | shortest_navigated.sea_margin | Number | % | -9999999 | 25.7 | Difference passage day between "shortest route without wf and cf" compare with "frequently navigate route with wf and cf" |
| 33 | (Shortest Navigated) FuelMT | frequently_navigated.fuel_mt | Number | MT | -9999999 | 567.6 | |
| 34 | (Shortest Navigated) (Speed) AVG | shortest_navigated.speed.avg | Number | Knots | -9999999 | 10.2 | |
| 35 | (Shortest Navigated) (Speed) WF | shortest_navigated.speed.wf | Number | Knots | -9999999 | -1.7 | Weather Factor |
| 36 | (Shortest Navigated) (Speed) CF | shortest_navigated.speed.cf | Number | Knots | -9999999 | -0.1 | Current Factor |
| 37 | (Shortest Navigated) (Total Voyages) Numerator | shortest_navigated.total_voyages.numerator | Number | - | -9999999 | 10 | Number of voyages included in "Shortest Navigated Group" respectively. |
| 38 | (Shortest Navigated) (Total Voyages) Denominator | shortest_navigated.total_voyages.denominator | Number | - | -9999999 | 10 | Total number of voyages extracted which meet user selected departure / arrival ports, ship size, and ETD periods. |
| 39 | (Shortest Navigated) Distance | shortest_navigated.distance | Number | nm | -9999999 | 3267 | |
| 40 | (Shortest Navigated) Days | shortest_navigated.days | Number | Day | -9999999 | 14.2 | |
| 41 | (Shortest Navigated) Difference | shortest_navigated.difference | Number | Day | -9999999 | 2.9 | |
| 42 | (Shortest Navigated) % | shortest_navigated.sea_margin | Number | % | -9999999 | 25.7 | Difference passage day between "shortest route without wf and cf" compare with "frequently navigate route with wf and cf" |
| 43 | (Shortest Navigated) FuelMT | shortest_navigated.fuel_mt | Number | MT | -9999999 | 567.6 | |
| 44 | (Shortest Navigated) (Speed) AVG | shortest_navigated.speed.avg | Number | Knots | -9999999 | 10.2 | |
| 45 | (Shortest Navigated) (Speed) WF | shortest_navigated.speed.wf | Number | Knots | -9999999 | -1.7 | Weather Factor |
| 46 | (Shortest Navigated) (Speed) CF | shortest_navigated.speed.cf | Number | Knots | -9999999 | -0.1 | Current Factor |
| 47 | (Shortest Navigated) (Total Voyages) Numerator | shortest_navigated.total_voyages.numerator | Number | - | -9999999 | 3 | Number of voyages included in "Frequently Navigated Group" respectively. |
| 48 | (Shortest Navigated) (Total Voyages) Denominator | shortest_navigated.total_voyages.denominator | Number | - | -9999999 | 9 | Total number of voyages extracted which meet user selected departure / arrival ports, ship size, and ETD periods. |
| 49 | (Shortest Navigated) (Way Point) NavTrack | shortest_navigated.total_voyages.NavTrack | String | - | -9999999 | RL | RL :Rhumb Line, GC :Great Circle |
| 50 | (Shortest Navigated) (Way Point) SourceID | shortest_navigated.WayPoint.SourceID | String | - | -9999999 | w0 | w0,w1,w2,... are the order of waypoints |
| 51 | (Shortest Navigated) (Way Point) (SourceID) Lat | shortest_navigated.WayPoint.SourceID.Lat | String | - | -9999999 | -7095 | Notation in 60 decimal |
| 52 | (Shortest Navigated) (Way Point) (SourceID) Lon | shortest_navigated.WayPoint.SourceID.Lon | String | - | -9999999 | 1964 | Notation in 60 decimal |
| 53 | (Frequently Navigated) Distance | frequently_navigated.distance | Number | nm | -9999999 | 3267 | |
| 54 | (Frequently Navigated) Days | frequently_navigated.days | Number | Day | -9999999 | 14.2 | |
| 55 | (Frequently Navigated) Difference | frequently_navigated.difference | Number | Day | -9999999 | 2.9 | |
| 56 | (Frequently Navigated) % | frequently_navigated.sea_margin | Number | % | -9999999 | 25.7 | Difference passage day between "shortest route without wf and cf" compare with "frequently navigate route with wf and cf" |
| 57 | (Frequently Navigated) FuelMT | frequently_navigated.fuel_mt | Number | MT | -9999999 | 567.6 | |
| 58 | (Frequently Navigated) (Speed) AVG | frequently_navigated.speed.avg | Number | Knots | -9999999 | 10.2 | |
| 59 | (Frequently Navigated) (Speed) WF | frequently_navigated.speed.wf | Number | Knots | -9999999 | -1.7 | Weather Factor |
| 60 | (Frequently Navigated) (Speed) CF | frequently_navigated.speed.cf | Number | Knots | -9999999 | -0.1 | Current Factor |
| 61 | (Frequently Navigated) (Total Voyages) Numerator | frequently_navigated.total_voyages.numerator | Number | - | -9999999 | 10 | Number of voyages included in "Frequently Navigated Group" respectively. |
| 62 | (Frequently Navigated) (Total Voyages) Denominator | frequently_navigated.total_voyages.denominator | Number | - | -9999999 | 10 | Total number of voyages extracted which meet user selected departure / arrival ports, ship size, and ETD periods. |
| 63 | (Frequently Navigated) Distance | frequently_navigated.distance | Number | nm | -9999999 | 3267 | |
| 64 | (Frequently Navigated) Days | frequently_navigated.days | Number | Day | -9999999 | 14.2 | |
| 65 | (Frequently Navigated) Difference | frequently_navigated.difference | Number | Day | -9999999 | 2.9 | |
| 66 | (Frequently Navigated) % | frequently_navigated.sea_margin | Number | % | -9999999 | 25.7 | Difference passage day between "shortest route without wf and cf" compare with "frequently navigate route with wf and cf" |
| 67 | (Frequently Navigated) FuelMT | frequently_navigated.fuel_mt | Number | MT | -9999999 | 567.6 | |
| 68 | (Frequently Navigated) (Speed) AVG | frequently_navigated.speed.avg | Number | Knots | -9999999 | 10.2 | |
| 69 | (Frequently Navigated) (Speed) WF | frequently_navigated.speed.wf | Number | Knots | -9999999 | -1.7 | Weather Factor |
| 70 | (Frequently Navigated) (Speed) CF | frequently_navigated.speed.cf | Number | Knots | -9999999 | -0.1 | Current Factor |
| 71 | (Frequently Navigated) (Total Voyages) Numerator | frequently_navigated.total_voyages.numerator | Number | - | -9999999 | 3 | Number of voyages included in "Frequently Navigated Group" respectively. |
| 72 | (Frequently Navigated) (Total Voyages) Denominator | frequently_navigated.total_voyages.denominator | Number | - | -9999999 | 9 | Total number of voyages extracted which meet user selected departure / arrival ports, ship size, and ETD periods. |
| 73 | (Frequently Navigated) (Way Point) NavTrack | frequently_navigated.total_voyages.NavTrack | String | - | -9999999 | RL | RL :Rhumb Line, GC :Great Circle |
| 74 | (Frequently Navigated) (Way Point) SourceID | frequently_navigated.WayPoint.SourceID | String | - | -9999999 | w0 | w0,w1,w2,... are the order of waypoints |
| 75 | (Frequently Navigated) (Way Point) (SourceID) Lat | frequently_navigated.WayPoint.SourceID.Lat | String | - | -9999999 | -7095 | Notation in 60 decimal |
| 76 | (Frequently Navigated) (Way Point) (SourceID) Lon | frequently_navigated.WayPoint.SourceID.Lon | String | - | -9999999 | 1964 | Notation in 60 decimal |
| 77 | (Voyage Info) (Departure Port) PortCode | voyage_info.departure_port.PortCode | String | - | -9999999 | SHA | |
| 78 | (Voyage Info) (Departure Port) PortName | voyage_info.departure_port.PortName | String | - | -9999999 | SHANGHAI | |
| 79 | (Voyage Info) (Departure Port) TimeZone | voyage_info.departure_port.TimeZone | String | - | -9999999 | ||
| 80 | (Voyage Info) (Departure Port) (Point) Lat | voyage_info.departure_port.Point.Lat | Number | - | -9999999 | 1882.434 | minutes |
| 81 | (Voyage Info) (Departure Port) (Point) Lon | voyage_info.departure_port.Point.Lon | Number | - | -9999999 | 7296.12 | minutes |
| 82 | (Voyage Info) (Arrival Port) PortCode | voyage_info.arrival_port.PortCode | String | - | -9999999 | SHA | |
| 83 | (Voyage Info) (Arrival Port) PortName | voyage_info.arrival_port.PortName | String | - | -9999999 | SHANGHAI | |
| 84 | (Voyage Info) (Arrival Port) TimeZone | voyage_info.arrival_port.TimeZone | String | - | -9999999 | ||
| 85 | (Voyage Info) (Arrival Port) (Point) Lat | voyage_info.arrival_port.Point.Lat | Number | - | -9999999 | 1882.434 | minutes |
| 86 | (Voyage Info) (Arrival Port) (Point) Lon | voyage_info.arrival_port.Point.Lon | Number | - | -9999999 | 7296.12 | minutes |
Example cURL (application/x-www-form-urlencoded)
curl https://sea-api.wni.com/api/v2/sea-margin-port.json \
--request POST \
--header 'Authorization: WniWebApi b8d1e715-78a2-4da8-b915-4bfbc8607580' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={
"ship_type": "Bulker",
"dwt": "70000",
"etd": "2024-Jan-01",
"calm_sea_speed": "15",
"ifo": "10",
"port_list": "YOK,LBE",
"sea_margin_type": "wfcf"
}'
Parameters
Query Parameters
callback
Name of the JSONP callback function (optional).
Typestring
Request Body
JSON
"string"
Responses
Successful response with sea margin data.
application/json
JSON
{
"voyage_info": [
{
"shortest_without_wfcf": {
"distance": {
"value": 0,
"unit": "string"
},
"days": {
"days": {
"value": 0,
"unit": "string"
},
"difference": {
"value": 0,
"unit": "string"
},
"sea_margin": {
"value": 0,
"unit": "string"
}
},
"fuel_mt": {
"value": 0,
"unit": "string"
},
"speed": {
"avg": {
"value": 0,
"unit": "string"
},
"wf": {
"value": 0,
"unit": "string"
},
"cf": {
"value": 0,
"unit": "string"
}
},
"total_voyages": {
"numerator": 0,
"denominator": 0
},
"wayPoint": [
{
}
]
},
"departure_port": {
"PortCode": "string",
"PortName": "string",
"TimeZone": "string",
"Point": {
"Lat": 0,
"Lon": 0
}
},
"arrival_port": {
"PortCode": "string",
"PortName": "string",
"TimeZone": "string",
"Point": {
"Lat": 0,
"Lon": 0
}
},
"shortest": {
"distance": {
"value": 0,
"unit": "string"
},
"days": {
"days": {
"value": 0,
"unit": "string"
},
"difference": {
"value": 0,
"unit": "string"
},
"sea_margin": {
"value": 0,
"unit": "string"
}
},
"fuel_mt": {
"value": 0,
"unit": "string"
},
"speed": {
"avg": {
"value": 0,
"unit": "string"
},
"wf": {
"value": 0,
"unit": "string"
},
"cf": {
"value": 0,
"unit": "string"
}
},
"total_voyages": {
"numerator": 0,
"denominator": 0
},
"wayPoint": [
{
"point": {
"lat": 0,
"lon": 0
},
"navTrack": "string",
"sourceId": "string"
}
]
},
"shortest_navigated": {
"distance": {
"value": 0,
"unit": "string"
},
"days": {
"days": {
"value": 0,
"unit": "string"
},
"difference": {
"value": 0,
"unit": "string"
},
"sea_margin": {
"value": 0,
"unit": "string"
}
},
"fuel_mt": {
"value": 0,
"unit": "string"
},
"speed": {
"avg": {
"value": 0,
"unit": "string"
},
"wf": {
"value": 0,
"unit": "string"
},
"cf": {
"value": 0,
"unit": "string"
}
},
"total_voyages": {
"numerator": 0,
"denominator": 0
},
"wayPoint": [
{
"point": {
"lat": 0,
"lon": 0
},
"navTrack": "string",
"sourceId": "string"
}
]
},
"frequently_navigated": {
"distance": {
"value": 0,
"unit": "string"
},
"days": {
"days": {
"value": 0,
"unit": "string"
},
"difference": {
"value": 0,
"unit": "string"
},
"sea_margin": {
"value": 0,
"unit": "string"
}
},
"fuel_mt": {
"value": 0,
"unit": "string"
},
"speed": {
"avg": {
"value": 0,
"unit": "string"
},
"wf": {
"value": 0,
"unit": "string"
},
"cf": {
"value": 0,
"unit": "string"
}
},
"total_voyages": {
"numerator": 0,
"denominator": 0
},
"wayPoint": [
{
"point": {
"lat": 0,
"lon": 0
},
"navTrack": "string",
"sourceId": "string"
}
]
}
}
]
}