Walkalytics API

API change history

Walk-time Analysis done right.

isochrone

Calculates the walking isochrone for a source location. The result is a base64-encoded raster file, containing 4 classes (as PNG file, this is default) or the actual travel times in seconds for every pixel (as a gzipped Esri ASCII grid).

If a set of points-of-interests (POIs) is given in the request body, the duration time for walking from the source location to each POI is calculated.

Try it

Request URL

Request parameters

number

x-coordinate of the source location (coordinate system is "WGS/84 Pseudo Mercator", default EPSG:3857)

number

y-coordinate of the source location (coordinate system is "WGS/84 Pseudo Mercator", default EPSG:3857)

(optional)
number

EPSG code for coordinate ssystem of the x- and y-coordinate.

(optional)
number

Maximum number of minutes for the isochrone.

(optional)
boolean

If true, return only an annotated list of points-of-interest (POIs), based on the GeoJSON FeatureCollection in the request body. No isochrone raster will be included in the response.

(optional)
boolean

if true, return a gzipped Esri ASCII grid with traveltimes for every pixel. if false, it returns a PNG file with classified isochrones.

(optional)
string

list of break values for the classification of the PNG result, default is [0, 3, 6, 9, 13]

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

A GeoJSON object with coordinate system EPSG:3857. This object is optional.

{ "type": "FeatureCollection",
   "crs": {"type": "EPSG", "properties": {"code": 3857}},
  "features": [
      { "type": "Feature",
        "geometry": {"type": "Point", "coordinates": [828895,5932832]},
        "properties": {"id": "Hello!"}
      },
      { "type": "Feature",
        "geometry": {"type": "Point", "coordinates": [827894,5934204]},
        "properties": {"id": "Is it me you're looking for?"}
      }
  ]
}

Response 200

returns a JSON object.

{
    "status": "success",
    "service_area": 2189727.3908267035,
    "ncols": 512,
    "img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAYAAAD0[...]",
    "pois": {},
    "cellsize": 8,
    "nrows": 512,
    "xllcorner": 949776,
    "yllcorner": 5999784,
    "nodata_value": -1
}

Response 400

Wrong parameter set.

{"status": "Error", "message" : "Input parameters are incorrect."}

Code samples

@ECHO OFF

curl -v -X POST "https://api.walkalytics.com/v1/isochrone?x={x}&y={y}?epsg=3857&max_min=15&only_pois=false&raw_data=false&break_values=0, 3, 6, 9, 13"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["epsg"] = "3857";
            queryString["max_min"] = "15";
            queryString["only_pois"] = "false";
            queryString["raw_data"] = "false";
            queryString["break_values"] = "0, 3, 6, 9, 13";
            var uri = "https://api.walkalytics.com/v1/isochrone?x={x}&y={y}&" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.walkalytics.com/v1/isochrone?x={x}&y={y}");

            builder.setParameter("epsg", "3857");
            builder.setParameter("max_min", "15");
            builder.setParameter("only_pois", "false");
            builder.setParameter("raw_data", "false");
            builder.setParameter("break_values", "0, 3, 6, 9, 13");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "epsg": "3857",
            "max_min": "15",
            "only_pois": "false",
            "raw_data": "false",
            "break_values": "0, 3, 6, 9, 13",
        };
      
        $.ajax({
            url: "https://api.walkalytics.com/v1/isochrone?x={x}&y={y}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.walkalytics.com/v1/isochrone?x={x}&y={y}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"epsg=3857",
                         @"max_min=15",
                         @"only_pois=false",
                         @"raw_data=false",
                         @"break_values=0, 3, 6, 9, 13",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.walkalytics.com/v1/isochrone?x={x}&y={y}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'epsg' => '3857',
    'max_min' => '15',
    'only_pois' => 'false',
    'raw_data' => 'false',
    'break_values' => '0, 3, 6, 9, 13',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'epsg': '3857',
    'max_min': '15',
    'only_pois': 'false',
    'raw_data': 'false',
    'break_values': '0, 3, 6, 9, 13',
})

try:
    conn = httplib.HTTPSConnection('api.walkalytics.com')
    conn.request("POST", "/v1/isochrone?x={x}&y={y}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'epsg': '3857',
    'max_min': '15',
    'only_pois': 'false',
    'raw_data': 'false',
    'break_values': '0, 3, 6, 9, 13',
})

try:
    conn = http.client.HTTPSConnection('api.walkalytics.com')
    conn.request("POST", "/v1/isochrone?x={x}&y={y}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.walkalytics.com/v1/isochrone?x={x}&y={y}')

query = URI.encode_www_form({
    # Request parameters
    'epsg' => '3857',
    'max_min' => '15',
    'only_pois' => 'false',
    'raw_data' => 'false',
    'break_values' => '0, 3, 6, 9, 13'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body