Skip to main content

POST /isochrone/1.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"

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": [
    • {
      },
    • {
      }
    ],
  • "status": "OK",
  • "transport": "walking"
}