iCherche Géocode
Recherche et géocode une adresse, un lieu et plusieurs autres territoires.
GET https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode
Cette recherche accepte les options suivantes:
Option | Type | Description | Valeurs possibles |
---|---|---|---|
type | [texte] |
Obligatoire Type de territoire recherché. Possible de séparer plusieurs types par une virgule. Il est également permis d'utiliser un sous-type comme 'education' ou 'cpe'. | adresses, anciennes-adresses, anciennes-municipalites, bornes-cn, bornes-gcc, bornes-km, bornes-sumi, entreprises, routes, codes-postaux, intersections, municipalites, mrc, province, regadmin, regmsp, sorties-autoroute, zones-postales, lieux.toponyme.bati, lieux.toponyme.geographie, lieux.toponyme.hydro, lieux.toponyme.parc, lieux.toponyme.secteur, lieux.toponyme.localite, lieux.education.service-garde, lieux.education.public, lieux.education.prive, lieux.education.gouvernemental, lieux.education.colleges, lieux.education.universites, lieux.osm.buildings, lieux.sante.aine, lieux.sante.ambulance, lieux.sante.clinique, lieux.sante.etabl, lieux.sante.gmf, lieux.sante.naissance, lieux.sante.pharmacie, lieux.securite.casernes, lieux.securite.correctionnel, lieux.securite.organisme, lieux.securite.palais-justice, lieux.securite.penitencier-fed, lieux.securite.penitencier-prov, lieux.securite.polices, lieux.sepaq.batiment, lieux.sepaq.camping, lieux.sepaq.equipement, lieux.transport.commun, mern.zones-chasse, mern.sous-zones-chasse, haltes_cyclables, haltes_routieres |
q | Texte |
Obligatoire Recherche textuelle sur les champs prédéfinis. La recherche est
insensible aux accents et aux majuscules.
Possible de limiter les types de territoires recherchés avec un hashtag: #type |
|
sort | [propriété] |
Tri les résultats selon une ou plusieurs propriétés. Pour inverser
le tri, ajouter - devant le nom de la propriété.
Les propriétés triables sont indiquées dans la page de chaque type.
|
code, -code, name, -name, score, -score, index, -index |
field | [propriété] |
Retourne les propriétés optionnelles demandées. Mettez * pour les retourner toutes. | |
limit | Nombre |
Limite le nombre de territoires retournés. | 0 - 100 (défaut: 10) |
page | Nombre |
Obtenir une autre page de résultat | 1 (défaut) - 10 |
ecmax | Nombre (pourcentage) |
Écart maximum entre le score maximum et le score minimum | 0 - 100 (défaut: 30) |
geometry | Booléen / string |
Indique si la géométrie doit être retournée. |
0 (false): ne renvoie rien 1 (true): renvoie la géométrie complète null: renvoie null center: renvoie le centre du BBOX centroid: renvoie le centroïde de l'entité pointOnFeature: renvoie un point à l'intérieur du polygone |
bbox | Booléen |
Indique si le bbox doit être retourné | 0 (false), 1 (true) |
extent | xMin, yMin, xMax, yMax |
Retourne seulement les territoires se trouvant à l'intérieur de l'extent. Le système de coordonnées doit être en WGS84. | |
loc | [x,y] |
Retourne seulement les territoires intersectant la géométrie passée en paramètre. Le système de coordonnées doit être WGS84. Si l'intrant est une seule paire de coordonnées, il est considéré comme un point. Si l'intrant est constitué d'au moins 4 paires de coordonnées, il est interprété comme un polygone. Le polygone doit être fermé (4ème point = premier, séparés par des points virgules, ex: x1,y1;x2,y2;x3y3;x1,y1). |
|
buffer | Nombre (mètres) |
Ajoute un buffer (en mètres) autour de la géométrie passée par le paramètre 'loc'. | 0-10000 |
[field] | Texte |
Permet de filtrer le résultat selon une colonne (field). Les propriétés filtrables sont indiquées dans la page de chaque type. Possible d'utiliser * comme caractère générique (wildcard). |
Exemple de requête
# Requête pour obtenir les adresses qui correspondent à "2525 laurier".
https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=2525 laurier
Réponse
-
features
: Une liste d’objets feature -
maxScore
: Score maximum obtenu -
count
: Nombre de résultats obtenus
feature
-
index
: Type de territoire trouvé. -
score
: Score relatif de correspondance avec le texte recherché -
properties
: Les propriétés associées au territoire. Chaque type de territoire aura des propriétés différentes.
Voir les sections de chaque type de territoire pour le détail. -
highlight
: Surligne la partie des champs 'texte' respectant le critère de rercherche textuel -
bbox
: Contiendra un objet bbox. Cette section n’est présente que lorsque le paramètre bbox est défini -
geometry
: Contiendra un objet geometry. Cette section n’est présente que lorsque le paramètre geometry est défini
bbox
[ xmin, ymin, xmax, ymax ]
geometry
Cette section de la réponse est conforme au Geometry Objects du standard
geojson.
http://geojson.org/geojson-spec.html#geometry-objects
properties
code
: Code du territoire.nom
: Nom du territoire.
Exemple de réponse
{
"features": [
{
"index": adresses,
"score": 17.8211,
"properties": {
"code": "1cbe225a8fda36bee05358f2298ed5feG1V2L2",
"nom": "2525 Boulevard Laurier, Québec G1V2L2"
},
"highlight": {
"title": "2525 Boulevard Laurier, Québec G1V2L2"
},
"type": "Feature"
}
],
"maxScore": 17.8211,
"type": "FeatureCollection"
}
Liste d'exemples
# Requête avec hashtags. Si vous copiez-collez l'url, le hashtag (#) doit être remplacé par %23. https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=lieux&q=St-Laurent #parc,cpe # Adresses ressemblant à 2525 Laurier dans un polygone. https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=2525 laurier&loc=-71.3,46.8;-71.2,46.9;-71.1,46.9;-71.1,46.8;-71.3,46.8 # Adresses ressemblant à 2525 Laurier proche d’un point X,Y (dans un rayon de 5km) https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=2525 laurier&loc=-71.3,46.8&buffer=5000 # L'adresse du 2525 Laurier avec ses coordonnées https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=2525 laurier&code=1cbe225a8fda36bee05358f2298ed5feG1V2L2&geometry=true # Municipalités ressemblant à « qué » intersectant le point X,Y https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=municipalites&q=qué&loc=-71.3,46.8 # Adresses correspondant à un code postal et à un no civique (limite de 100 retours) https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=g1v2l2,2525&limit=100 # Adresses (et toutes les propriétés optionnelles correspondant à un code postal et à un no civique (limite de 100 retours) https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=adresses&q=g1v2l2,2525&field=numero;route;municipalite&limit=100 # Parcs ressemblant à « gouin » appartenant à la municipalité de Montréal https://geoegl.msp.gouv.qc.ca/apis/icherche/geocode?type=lieux.toponyme.parc&q=gouin&municipalité=Montréal