spatial

Spatial references

List each zone for a given level with their datasets count

get

/spatial/coverage/{level}//

Path parameters

levelstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/coverage/{level}/'

200

200

[
  {
    "type": "FeatureCollection",
    "features": [
      {
        "geometry": {
          "type": "Point",
          "coordinates": [
            {}
          ]
        },
        "id": "text",
        "properties": {},
        "type": "Feature"
      }
    ]
  }
]

Success

List all known spatial granularities

get

/spatial/granularities/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/granularities/'

200

200

[
  {
    "id": "text",
    "name": "text"
  }
]

Success

List all known levels

get

/spatial/levels/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/levels/'

200

200

[
  {
    "id": "text",
    "name": "text"
  }
]

Success

Fetch a zone

get

/spatial/zone/{id}//

Path parameters

idstringrequired

A zone identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/zone/{id}/'

200

200

No body

Success

Fetch datasets for a given zone

get

/spatial/zone/{id}/datasets/

Path parameters

idstringrequired

A zone identifier

Query parameters

dynamicboolean

Append dynamic datasets

sizeinteger · default: 25

The amount of datasets to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/zone/{id}/datasets/'

200

200

{
  "class": "text",
  "id": "text",
  "acronym": "text",
  "page": "text",
  "title": "text",
  "uri": "text"
}

Success

Geospatial zones suggest endpoint using mongoDB contains

get

/spatial/zones/suggest/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizeinteger · default: 10

The amount of suggestion to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/zones/suggest/?q=text'

200

200

[
  {
    "code": "text",
    "id": "text",
    "level": "text",
    "name": "text",
    "uri": "text"
  }
]

Success

Fetch a zone list as GeoJSON

get

/spatial/zones/{ids}//

Path parameters

idsstringrequired

A zone identifiers list (comma separated)

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/spatial/zones/{ids}/'

200

200

{
  "type": "FeatureCollection",
  "features": [
    {
      "geometry": {
        "type": "Point",
        "coordinates": [
          {}
        ]
      },
      "id": "text",
      "properties": {},
      "type": "Feature"
    }
  ]
}

Success