POST /isochrone/2.0.0

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" "public_transport" Movement type: driving - by car, walking - on foot, bicycle - by bicycle, motorcycle - by motorcycle, public_transport - by public transport,
	Array of CTXTransportType (strings) or null Types of public transport.
	ResponseGeometryFormat (any) or null Format of geometry in response.
	boolean or null This flag controls behavior in case of partially successful isochrone calculation. If the flag is set, each `isochrone` gets `status` field. If the flag is set and some of the requested isochrones were not calculated, then code 200 will be returned, the calculated isochrones will have the `OK` status, the uncalculated isochrones will have the `build_error` status. The overall status will be `partial_success`. If all of the requested isochrones were not calculated, then code 200 will be returned. Uncalculated isochrones will have the `build_error` status, overall status will be `build_error`. If the flag is not set, code 204 and empty response will be returned.

Responses

Response Schema: application/json

	number or null <double> Time taken to generate the response in seconds.
	(Array of Isochrone (object) or FailedIsochrone (object)) or null
	TransportV2 (string) or null
	StatusV2 (string) or null
format required	any Format of geometry in response. Value: "wkt"

Response samples

Content type

application/json

{"format": "wkt",
"generation_time": 0,
"isochrones": [{"attract_points": [{"lat": 55.02826810606327,
"lon": 82.91853901076006
}
],
"duration": 1200,
"geometry": "MULTIPOLYGON(((82.923498 55.013993, 82.925005 55.01694, 82.926779 55.017478, 82.927386 55.015795, 82.929315 55.015898, 82.928441 55.01981, 82.93048 55.018781, 82.930934 55.016853, 82.930934 55.020413, 82.933426 55.020319, 82.935285 55.01937, 82.935088 55.018177, 82.937581 55.019085, 82.939301 55.018748, 82.938625 55.021286, 82.935661 55.022116, 82.937616 55.023088, 82.93675 55.023746, 82.934107 55.023459, 82.934998 55.025502, 82.938762 55.027155, 82.939501 55.028784, 82.93659 55.027264, 82.935192 55.029677, 82.936942 55.030213, 82.934771 55.032594, 82.936895 55.032987, 82.93675 55.03384, 82.932423 55.034401, 82.930934 55.036037, 82.929911 55.034975, 82.931243 55.034499, 82.928349 55.03397, 82.927302 55.03688, 82.92857 55.03743, 82.925948 55.03844, 82.924286 55.03777, 82.92301 55.039006, 82.9193 55.039119, 82.919365 55.04025, 82.917372 55.040366, 82.916988 55.038681, 82.912653 55.03742, 82.912635 55.037346, 82.913036 55.0371, 82.913169 55.0367, 82.913723 55.036404, 82.912119 55.036234, 82.91022 55.033512, 82.904231 55.034434, 82.906005 55.035844, 82.902682 55.034859, 82.899358 55.035724, 82.898401 55.035047, 82.901851 55.032901, 82.903512 55.033642, 82.911038 55.031669, 82.91188 55.02977, 82.909282 55.02971, 82.909162 55.03107, 82.907834 55.03107, 82.906888 55.029231, 82.898331 55.024862, 82.903156 55.024225, 82.902549 55.025851, 82.903512 55.026002, 82.90809 55.022835, 82.918519 55.020715, 82.919363 55.020175, 82.916808 55.018706, 82.911441 55.019953, 82.914516 55.018305, 82.912999 55.017352, 82.915146 55.017025, 82.915977 55.017925, 82.919478 55.016502, 82.919942 55.015338, 82.921813 55.015435, 82.92127 55.016576, 82.918306 55.017829, 82.921025 55.019294, 82.922753 55.018305, 82.923498 55.013993), (82.929272 55.020605, 82.929521 55.021973, 82.930182 55.022071, 82.930195 55.022592, 82.927788 55.022218, 82.928522 55.023545, 82.926779 55.024534, 82.927504 55.020687, 82.929272 55.020605), (82.914315 55.032537, 82.914476 55.034975, 82.913484 55.035065, 82.911735 55.03307, 82.914315 55.032537), (82.931764 55.030155, 82.931856 55.031218, 82.929206 55.031203, 82.929217 55.030181, 82.931764 55.030155), (82.934257 55.029671, 82.935558 55.030213, 82.933426 55.031274, 82.933321 55.029737, 82.934257 55.029671), (82.920131 55.029712, 82.920131 55.030251, 82.915328 55.030317, 82.91342 55.031166, 82.913484 55.03018, 82.920131 55.029712), (82.922624 55.033495, 82.92271 55.034548, 82.920892 55.034539, 82.920909 55.033516, 82.922624 55.033495), (82.918469 55.032075, 82.918527 55.033104, 82.916737 55.033111, 82.91675 55.032085, 82.918469 55.032075), (82.917638 55.034909, 82.917728 55.035979, 82.916676 55.036003, 82.915815 55.034975, 82.917638 55.034909), (82.935088 55.02632, 82.935455 55.027832, 82.934257 55.027888, 82.934143 55.026403, 82.935088 55.02632), (82.921793 55.035382, 82.921924 55.036479, 82.920046 55.035977, 82.920061 55.035411, 82.921793 55.035382), (82.920962 55.024942, 82.920962 55.025479, 82.918421 55.02545, 82.918469 55.024943, 82.920962 55.024942), (82.915977 55.027329, 82.916019 55.029261, 82.915146 55.029289, 82.914255 55.028784, 82.915977 55.027329), (82.921793 55.021114, 82.921841 55.021667, 82.920085 55.021666, 82.920081 55.021135, 82.921793 55.021114), (82.922624 55.031605, 82.922685 55.032629, 82.921793 55.032643, 82.920895 55.031642, 82.922624 55.031605)), ((82.898051 55.023341, 82.898226 55.023545, 82.898194 55.023736, 82.898174 55.023819, 82.898147 55.024021, 82.898143 55.024241, 82.898264 55.024347, 82.898271 55.024498, 82.898007 55.024676, 82.897696 55.024645, 82.897523 55.024597, 82.897438 55.024498, 82.897107 55.024359, 82.896865 55.024325, 82.89651 55.024225, 82.896334 55.024021, 82.896331 55.023851, 82.896331 55.023715, 82.896327 55.023545, 82.896505 55.023339, 82.896865 55.023237, 82.897162 55.023239, 82.897399 55.023239, 82.897696 55.023241, 82.898051 55.023341)))",
"start_point": {"lat": 55.02826810606327,
"lon": 82.91853901076006
},
"transport": "public_transport"
},
{"attract_points": [{"lat": 55.02826810606327,
"lon": 82.91853901076006
}
],
"duration": 600,
"geometry": "MULTIPOLYGON(((82.919616 55.020982, 82.920131 55.021882, 82.923609 55.022028, 82.923114 55.023069, 82.926096 55.02346, 82.926587 55.024608, 82.929605 55.02383, 82.927817 55.025927, 82.930694 55.027832, 82.928441 55.029356, 82.926591 55.029153, 82.928025 55.029737, 82.926945 55.030308, 82.924921 55.030101, 82.923987 55.030689, 82.924897 55.031166, 82.920767 55.03153, 82.920131 55.032524, 82.917785 55.031166, 82.920297 55.030308, 82.920131 55.029684, 82.913355 55.030139, 82.913606 55.031642, 82.911561 55.032268, 82.912002 55.029737, 82.909005 55.029551, 82.908434 55.03025, 82.907243 55.028784, 82.909124 55.028308, 82.908036 55.027832, 82.908859 55.027355, 82.907096 55.026879, 82.908755 55.026403, 82.90649 55.025927, 82.909569 55.025111, 82.91016 55.023649, 82.913674 55.023654, 82.913406 55.022592, 82.91777 55.022668, 82.916584 55.021988, 82.919616 55.020982), (82.915977 55.027295, 82.916065 55.029261, 82.915146 55.02933, 82.914109 55.028784, 82.915977 55.027295), (82.920962 55.024877, 82.920962 55.025521, 82.918355 55.02545, 82.918469 55.024888, 82.920962 55.024877), (82.911822 55.025315, 82.912746 55.02598, 82.910849 55.026008, 82.910776 55.025327, 82.911822 55.025315)))",
"start_point": {"lat": 55.02826810606327,
"lon": 82.91853901076006
},
"transport": "public_transport"
}
],
"status": "OK",
"transport": "public_transport"
}

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