Skip to content

/v2/sea-margin-area.json

POST
/v2/sea-margin-area.json

Sea-Margin Area Data Specification

Item Value
Data Name Sea Margin Area
Data Area Global
Data Output Format JSON / JSONP
Data Size ~4 KB
No Data Value -9999999

Sea-Margin (Area to Area) Data Elements

No Item Code at JSON Output Item Meaning Unit/Format Value Type
1 (leginfo).ship_type Ship type - String
2 (leginfo).ship_size Ship size - String
3 (leginfo).loading Loading condition of the ship - String
4 (leginfo).departurearea.code Departure area code Area Code String
5 (leginfo).departurearea.name Departure area name - String
6 (leginfo).arrivalarea.code Arrival area code Area Code String
7 (leginfo).arrivalarea.name Arrival area name - String
8 (leginfo).calm_sea_speed Speed of calm sea as a base Knot Float
9 (leginfo).annual_sea_margin Annual % of passage days difference % Float
10 (leginfo).total_voyages_analysis Total of all simulation voyages - String
11 (leginfo).simulationinfo.passage_name Name of the area passed through - String
12 (leginfo).simulationinfo.total_voyages_passage.all Total voyages within analysis - String
13 (leginfo).simulationinfo.total_voyages_passage.winter Winter(Dec,Jan,Feb) voyages - String
14 (leginfo).simulationinfo.total_voyages_passage.spring Spring(Mar,Apr,May) voyages - String
15 (leginfo).simulationinfo.total_voyages_passage.summer Summer(Jun,Jul,Aug) voyages - String
16 (leginfo).simulationinfo.total_voyages_passage.autumn Autumn(Sep,Oct,Nov) voyages - String
17 (leginfo).simulationinfo.month.sea_margin % of passage days difference % Float
18 (leginfo).simulationinfo.month.avg_speed Average speed Knot Float
19 (leginfo).simulationinfo.month.wf Weather factor Knot Float
20 (leginfo).simulationinfo.month.cf Current factor Knot Float

Data Request Input Specification

No Item Code at JSON Input Item Meaning Unit/Format Value Type Remarks
1 ship_type Ship type Bulker, Tanker, PCTC String
2 dwt Ship DWT (Deadweight tonnage) Ton String
3 load Loading L, B String L: Laden, B: Ballast
4 dep Departure Area Code Area Code* String
5 arr Arrival Area Code Area Code* String
6 knot Calm Sea Speed Knot String Optional

*Only Area Code that has been aligned/registered on WNI area table will be used.

Area Code Table

No Area Code Area Name
1 1 JAPAN
2 2 NORTH CHINA
3 3 SINGAPORE/INDOCHINA
4 4 SOUTH EAST ASIA
5 5 PAPUA NEW GUINEA
6 6 NORTH WEST AUSTRALIA
7 7 SOUTH WEST AUSTRALIA
8 8 SOUTH EAST AUSTRALIA
9 9 NORTH EAST AUSTRALIA
10 10 NEW ZEALAND
11 11 HAWAII
12 12 ALASKA
13 13 ALEUTIAN ISLANDS
14 14 PACIFIC NORTHWEST
15 15 CALIFORNIA
16 16 CENTRAL AMERICA
17 17 COLUMBIA/ECUADOR/PERU
18 18 CHILE
19 19 PANAMA
20 20 GREAT LAKES/CANADA
21 21 US NORTH EAST COAST
22 22 US SOUTH EAST COAST
23 23 US GULF
24 24 CARIBBEAN
25 25 BRAZIL
26 26 NE OF SOUTH AMERICA
27 27 URUGUAY/ARGENTINA
28 28 CAPE HORN
29 29 BALTIC SEA
30 30 NORTH SEA
31 31 NORWEGIAN SEA
32 32 WEST UK
33 33 SPAIN/PORTUGAL
34 34 GIBRALTAR
35 35 MEDITERANIA
36 36 CANARY ISLANDS
37 37 CENTRAL AFRICA
38 38 ANGOLA/S.W.AFRICA
39 39 CAPE OF GOOD HOPE
40 40 EAST AFRICA
41 41 RED SEA
42 42 WEST INDIA/PAKISTAN
43 43 EAST INDIA
44 44 PERSIAN GULF
45 45 MOZAMBIQUE/MALAGASY

Parameters

Query Parameters

callback

Name of the JSONP callback function (optional).

Typestring

Request Body

JSON
"string"

Responses

Successful response with sea margin area data.
application/json
JSON
{
"leginfo": [
{
"ship_type": "Bulker",
"ship_size": "Handysize",
"loading": "Laden",
"departurearea": {
"code": "4",
"name": "SOUTH EAST ASIA"
},
"arrivalarea": {
"code": "25",
"name": "BRAZIL"
},
"calm_sea_speed": {
"value": 13,
"unit": "knot"
},
"annual_sea_margin": {
"value": 14.3,
"unit": "%"
},
"total_voyages_analysis": "23",
"simulationinfo": [
{
"passage_name": "Cape Horn",
"total_voyages_passage": {
"all": "1",
"winter": "0",
"spring": "0",
"summer": "1",
"autumn": "0"
},
"january": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"february": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"march": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"april": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"may": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"june": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"july": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"august": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"september": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"october": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"november": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
},
"december": {
"sea_margin": {
"value": 14.4,
"unit": "%"
},
"avg_speed": {
"value": 12.2,
"unit": "knot"
},
"wf": {
"value": -0.9,
"unit": "knot"
},
"cf": {
"value": 0.1,
"unit": "knot"
}
}
}
]
}
]
}

Playground

Authorization
Variables
Key
Value
Body

Samples

All product names and names of products mentioned herein are registered trademarks or trademarks of their respective companies.