Skip to content

Calculate an isochrone from a point

$client->routing->isochrone(float lat, float lng, float time, ?string format, ?string mode, ?string outputFields, ?bool outputGeometry, ?string outputInclude, ?int outputPrecision, ?float outputSimplify): RoutingIsochroneResponse

GET/api/v1/isochrone

Calculate an isochrone from a point

ParametersExpand Collapse

lat: float

Latitude

lng: float

Longitude

time: float

Travel time in seconds (1-7200)

format?:optional string

Response format: json (default), geojson, csv, ndjson

mode?:optional string

Travel mode (auto, foot, bicycle)

outputFields?:optional string

Comma-separated property fields to include

outputGeometry?:optional bool

Include geometry (default true)

outputInclude?:optional string

Extra computed fields: bbox, center

outputPrecision?:optional int

Coordinate decimal precision (1-15, default 7)

outputSimplify?:optional float

Simplify geometry tolerance in meters

ReturnsExpand Collapse

RoutingIsochroneResponse

?list<GeoJsonFeature> features

Array of isochrone polygon Features (multi-contour only)

?GeoJsonGeometry geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

?Properties properties

Isochrone metadata

?Type type

Feature for single contour, FeatureCollection for multiple contours

Calculate an isochrone from a point

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$response = $client->routing->isochrone(
  lat: 0,
  lng: 0,
  time: 0,
  format: 'format',
  mode: 'mode',
  outputFields: 'output[fields]',
  outputGeometry: true,
  outputInclude: 'output[include]',
  outputPrecision: 0,
  outputSimplify: 0,
);

var_dump($response);

{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "area_m2": 0,
    "max_cost_s": 0,
    "mode": "auto",
    "time_seconds": 0,
    "vertices_reached": 0
  },
  "type": "Feature"
}

Returns Examples

{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "area_m2": 0,
    "max_cost_s": 0,
    "mode": "auto",
    "time_seconds": 0,
    "vertices_reached": 0
  },
  "type": "Feature"
}