POST /get_hull

OpenAPI Specification

2GIS Navigation API (6.0.0)

Algorithms

Getting a reachable area

Getting an area that is reachable in a given time from a given point.

query Parameters

key

required

string

Developer API key

Request Body schema: /
required

Request parameters

durations required	Array of integers Travel times in seconds.
required	object (WGS84Point) Point in WGS84 format.
	string or null Date and time to start the movement in RFC 3339 format (for example, 2020-05-15T15:52:01Z).
	boolean or null If true, the direction of movement will be reversed: `false` - move from the specified point `true` - move to the specified point
detailing	number Default: 0 The level of polygon detail ranges from `0` to `1`, where `0` is the minimum detail and `1` is the maximum detail.
transport	string Default: "driving" Enum: "driving" "walking" "bicycle" "motorcycle" Movement type: driving - by car, walking - on foot, bicycle - by bicycle, motorcycle - by motorcycle,
simplify	boolean Deprecated Default: true If true, the polygon that forms the area will be simplified (less vertices): `false` - detailed polygon `true` - simplified polygon Parameter is deprecated, use `detailing` instead.

Responses

Response Schema: application/json

	number or null <double> Time taken to generate the response in seconds.
	Array of Geometry (objects) or null
	Transport (string) or null
	Transport (string) or null
	Status (string) or null
	string or null Description of the error if there was any.

Response samples

Content type

application/json

{"generation_time": 0.1,
"geometries": [{"attract_points": [{"lat": 55.02827284304516,
"lon": 82.91857135011028
}
],
"duration": 600,
"points": [{"lat": 55.02091517191845,
"lon": 82.91930033296336
},
{"lat": 55.02189790351334,
"lon": 82.92096221623898
},
{"lat": 55.02148082616529,
"lon": 82.92345504115241
},
{"lat": 55.02402133103122,
"lon": 82.92873982996888
},
{"lat": 55.02973680106705,
"lon": 82.93015611384583
},
{"lat": 55.03318947684599,
"lon": 82.92594786606584
},
{"lat": 55.03528002828299,
"lon": 82.91930033296336
},
{"lat": 55.035750757975656,
"lon": 82.9143146831365
},
{"lat": 55.03442601866272,
"lon": 82.91361112260597
},
{"lat": 55.03262223739394,
"lon": 82.90849809167182
},
{"lat": 55.03164177662545,
"lon": 82.90969833072293
},
{"lat": 55.029260543027746,
"lon": 82.90616777199328
},
{"lat": 55.0277609368288,
"lon": 82.90588174840681
},
{"lat": 55.027355454270705,
"lon": 82.90722877217536
},
{"lat": 55.02687916793131,
"lon": 82.90570190568694
},
{"lat": 55.02354500507027,
"lon": 82.91013473228796
},
{"lat": 55.02091517191845,
"lon": 82.91930033296336
}
],
"start_point": {"lat": 55.02826810606327,
"lon": 82.91853901076006
},
"wkt": "LINESTRING(82.9193 55.020915, 82.920962 55.021898, 82.923455 55.021481, 82.92874 55.024021, 82.930156 55.029737, 82.925948 55.033189, 82.9193 55.03528, 82.914315 55.035751, 82.913611 55.034426, 82.908498 55.032622, 82.909698 55.031642, 82.906168 55.029261, 82.905882 55.027761, 82.907229 55.027355, 82.905702 55.026879, 82.910135 55.023545, 82.9193 55.020915)"
},
{"attract_points": [{"lat": 55.02827284304516,
"lon": 82.91857135011028
}
],
"duration": 1200,
"points": [{"lat": 55.01330262775303,
"lon": 82.92428598279021
},
{"lat": 55.01395991801891,
"lon": 82.92687879019478
},
{"lat": 55.01542491388813,
"lon": 82.9276474785834
},
{"lat": 55.01528775467837,
"lon": 82.93037952485699
},
{"lat": 55.01938656777446,
"lon": 82.9332017619851
},
{"lat": 55.017590452954195,
"lon": 82.93675010735737
},
{"lat": 55.01892434949936,
"lon": 82.93733176650385
},
{"lat": 55.01872076576524,
"lon": 82.93934866397974
},
{"lat": 55.01993267373003,
"lon": 82.9395891429813
},
{"lat": 55.02163964462248,
"lon": 82.93729772035458
},
{"lat": 55.023227434119846,
"lon": 82.93785799959728
},
{"lat": 55.02449765133185,
"lon": 82.93414930494679
},
{"lat": 55.027424811387675,
"lon": 82.9382908977327
},
{"lat": 55.02783173495001,
"lon": 82.94132028636534
},
{"lat": 55.02973680106705,
"lon": 82.94132028636534
},
{"lat": 55.031165541225604,
"lon": 82.93896589183719
},
{"lat": 55.033266134384384,
"lon": 82.94124626518592
},
{"lat": 55.033796091890665,
"lon": 82.93967816602596
},
{"lat": 55.03457572520339,
"lon": 82.94020763305443
},
{"lat": 55.03669915031415,
"lon": 82.93394170428463
},
{"lat": 55.03783757241404,
"lon": 82.93426644525984
},
{"lat": 55.04037173879511,
"lon": 82.92954858321917
},
{"lat": 55.04272132697484,
"lon": 82.9151456247743
},
{"lat": 55.0440296823124,
"lon": 82.91265279986087
},
{"lat": 55.04196712460017,
"lon": 82.91042237284192
},
{"lat": 55.042276208775704,
"lon": 82.90739010960039
},
{"lat": 55.03910202467964,
"lon": 82.90462033408485
},
{"lat": 55.03709877284399,
"lon": 82.8993577336559
},
{"lat": 55.03735615997084,
"lon": 82.89728037956138
},
{"lat": 55.03354666162742,
"lon": 82.89513906541862
},
{"lat": 55.03310149296269,
"lon": 82.89858096042973
},
{"lat": 55.031165541225604,
"lon": 82.89644943792356
},
{"lat": 55.03137410728486,
"lon": 82.89852679201809
},
{"lat": 55.027355454270705,
"lon": 82.90278238101355
},
{"lat": 55.02681300230018,
"lon": 82.90090418341751
},
{"lat": 55.02941927917391,
"lon": 82.89575692667104
},
{"lat": 55.027355454270705,
"lon": 82.89733966837012
},
{"lat": 55.02211599322509,
"lon": 82.89509459881205
},
{"lat": 55.02376148948437,
"lon": 82.89769585038027
},
{"lat": 55.022354165403726,
"lon": 82.9001886752937
},
{"lat": 55.02331085660117,
"lon": 82.90268150020714
},
{"lat": 55.01991974731705,
"lon": 82.90632892975525
},
{"lat": 55.01933311037907,
"lon": 82.91029130864197
},
{"lat": 55.01776175041505,
"lon": 82.91170516706765
},
{"lat": 55.01492808937771,
"lon": 82.91922694060464
},
{"lat": 55.015588082776304,
"lon": 82.92120898344753
},
{"lat": 55.01349501027593,
"lon": 82.92254414945431
},
{"lat": 55.01330262775303,
"lon": 82.92428598279021
}
],
"start_point": {"lat": 55.02826810606327,
"lon": 82.91853901076006
},
"wkt": "LINESTRING(82.924286 55.013303, 82.926879 55.01396, 82.927647 55.015425, 82.93038 55.015288, 82.933202 55.019387, 82.93675 55.01759, 82.937332 55.018924, 82.939349 55.018721, 82.939589 55.019933, 82.937298 55.02164, 82.937858 55.023227, 82.934149 55.024498, 82.938291 55.027425, 82.94132 55.027832, 82.94132 55.029737, 82.938966 55.031166, 82.941246 55.033266, 82.939678 55.033796, 82.940208 55.034576, 82.933942 55.036699, 82.934266 55.037838, 82.929549 55.040372, 82.915146 55.042721, 82.912653 55.04403, 82.910422 55.041967, 82.90739 55.042276, 82.90462 55.039102, 82.899358 55.037099, 82.89728 55.037356, 82.895139 55.033547, 82.898581 55.033101, 82.896449 55.031166, 82.898527 55.031374, 82.902782 55.027355, 82.900904 55.026813, 82.895757 55.029419, 82.89734 55.027355, 82.895095 55.022116, 82.897696 55.023761, 82.900189 55.022354, 82.902682 55.023311, 82.906329 55.01992, 82.910291 55.019333, 82.911705 55.017762, 82.919227 55.014928, 82.921209 55.015588, 82.922544 55.013495, 82.924286 55.013303)"
}
],
"status": "OK",
"transport": "walking"
}

2GIS Navigation API (6.0.0)

Algorithms

Getting a reachable area

query Parameters

Request Body schema: */*required

Responses

Response Schema: application/json

Response samples

Request Body schema: /
required