The advanced query endpoint is accessible at /ogmapi/zone/query/ via a POST query.
The swagger documentation of the endpoint is available here: https://api.ogmapi.fr/schema/swagger/#/ogmapi/ogmapi_zone_query_create.
The "query" parameter is a JSON as described below.
import requests
url = 'https://api.ogmapi.fr/ogmapi/zone/query/'
headers = {'Authorization': 'Token <token_value>'}
print(requests.post(url, json={
"query": {
"instance": "ign_admin_express_commune_20250202_123622",
"area": {
"area" {
"type":"BoundingBox",
"north":-1.5583419799804688,
"west":48.14226521928136,
"south":-1.8021011352539065,
"east":48.0809461118917
}
},
"labels": null
}
}, headers=headers))
Define how to query a dataset. Filters labels of a dataset instance within a given area.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| instance | str | Dataset instance ID | Required |
| area | Intersects | Area filters. Query the whole world if not provided. | Optional |
| labels | And, Or, Equals | Label filters. Get all elements within the area if not provided | Optional |
Get all elements with at least one part of their geometry within an area.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| area | BoundingBox, SubQuery | The area. | Required |
A rectangle (in WGS-84).
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| north | float | Northen boundaries | Required |
| south | float | Southen boundaries | Required |
| east | float | Eastern boundaries | Required |
| west | float | Western boundaries | Required |
Get all elements within the geographical areas occupied by the objects returned by a sub-query.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| query | Query | The sub query | Required |
Filters zones matching all of the related filters.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| filters | List[Label filters] | List of label filters | Required with at least 2 filters. |
Filters zones matching at least one of the related filters.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| filters | List[Label filters] | List of label filters | Required with at least 2 filters. |
Filters zones with a label equals (exactly) to a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key | Required |
| value | str | Value | Required |
Filters zones with a label different to a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key | Required |
| value | str | Value | Required |
Filters zones with a number label strictly below a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key. | Required. The label must be of the NUMBER type. |
| value | str | Value. | Required. |
Filters zones with a number label below or equal to a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key. | Required. The label must be of the NUMBER type. |
| value | str | Value. | Required. |
Filters zones with a number label strictly above a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key. | Required. The label must be of the NUMBER type. |
| value | str | Value. | Required. |
Filters zones with a number label above or equal to a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| mode | str | "z" to query the zone labels, "l" to query the extension labels. | Required, ["z", "l"] |
| label | str | Label JSON key. | Required. The label must be of the NUMBER type. |
| value | str | Value. | Required. |
This query will retrieve all the Communes (municipalities) from the last instance (at the time of writing) without any further filtering.
import requests
url = 'https://api.ogmapi.fr/ogmapi/zone/query/'
headers = {'Authorization': 'Token <token_value>'}
print(requests.post(url, json={
"query": {
"instance": "ign_admin_express_commune_20250202_123622",
"area": {
"area" {
"type": "BoundingBox",
"north": -1.5583419799804688,
"west": 48.14226521928136,
"south": -1.8021011352539065,
"east": 48.0809461118917
}
},
"labels": null
}
}, headers=headers))