API description: Argument based Queries

This page provides information on our application programming interface (API). The API allows you to connect directly to our data and maps and is intended for software developers and researchers. For the latter group we specifically provide an R package 'nlgis', a convenience wrapper around the API that allows you to download and map our data or your own in R.

API Data Services

Output: service data with variables, years and values in JSON format

Input point:
http://127.0.0.1:8080/api/data

Request Format

Requests support the following parameters:

• cbsnr - CBS code
• naam - city name
• year - year from dataset
• code - indicator code
• indicator - full indicator name
• value - value from dataset
• amsterdam_code - Amsterdam code
• format – output format. API supports JSON format by defaut (XML and JSONP reserved)

Examples

http://127.0.0.1:8080/api/data?code=TXCU
http://127.0.0.1:8080/api/data?indicator=TK
http://127.0.0.1:8080/api/data?amsterdam_code=10996

Response Format

By default, all requests will respond with valid JSON. To receive the response in other format, you may provide format=xml in any request (reserved).

Example of response

{
    "data": [
        {
            "amsterdam_code": "10996", 
            "cbsnr": "1", 
            "code": "TXCU", 
            "id": 1, 
            "indicator": "TK", 
            "naam": "ADORP", 
            "value": 89.0, 
            "year": 1937
        }, 
        {
            "amsterdam_code": "10999", 
            "cbsnr": "2", 
            "code": "TXCU", 
            "id": 209, 
            "indicator": "TK", 
            "naam": "ADUARD", 
            "value": 49.0, 
            "year": 1937
        }

...

}

Geo API Service

Map polygons available via API for all years from 1812 to 1997.

Input point:

http://127.0.0.1:8080/api/maps

Request Format

Requests support the following parameters:

• year: selects polygons for specific year
• format: output in geojson or topojson (default)

Examples of requests
http://127.0.0.1:8080/api/maps?year=1812
http://127.0.0.1:8080/api/maps?year=1942

http://127.0.0.1:8080/api/maps?year=1812&format=geojson

Response Format

By default, all requests will respond with valid JSON. To receive the response in other format, you may provide format=xml in any request (reserved).

Example of response

{"type":"FeatureCollection","features":[{"type":"Feature","id":"gemeenten.108655","geometry":{"type":"MultiPolygon","coordinates":[[[[3.5378534987727446,51.5541452800982],[3.5419386180420016,51.542342274725364],[3.536470532134391,51.5420759645756],[3.536343434625422,51.53811807982241],[3.522467693849322,51.535469929865606],[3.521884248501696,51.539146780784534],[3.51331369012684,51.537211479633946],[3.50694851636763,51.53773854574695],[3.503038660892862,51.54163145028888],[3.496330257646924,51.539994640731386],[3.491301902075456,51.54647636167254],[3.4961339652014587,51.54817300194589],[3.493955435007488,51.55200372185726],[3.5109972179312443,51.55839226983125],[3.513698328871488,51.562841028098205],[3.5253554737040034,51.55646417654532],[3.5230306216118112,51.553370293446626],[3.5378534987727446,51.5541452800982]]]]},"geometry_name":"geog","properties":{"name":"Aagtekerke","cbscode":1000,"amsterdamcode":10531,"id":108655}},{"type":"Feature","id":"gemeenten.153652",