GET
/
search
curl --request GET \
  --url https://geo.fluximmo.io/search
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "label": "10 Rue Nationale 75013 Paris 13e Arrondissement",
        "id": "test-id",
        "postcode": "75013",
        "city": "Paris",
        "district": "Paris 13e Arrondissement",
        "street": "Rue Nationale",
        "housenumber": "10",
        "citycode": "75113",
        "x": 2.369063,
        "y": 48.822409,
        "score": 0.6515151515151515,
        "_score": 0.6515151515151515,
        "name": "10 Rue Nationale",
        "type": "housenumber",
        "_type": "address",
        "contexte": "75, Paris",
        "importance": "0.6"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          2.03648539635326,
          44.3492508045369
        ]
      }
    }
  ]
}

Query Parameters

​
q
string

chaîne décrivant la localisation à rechercher

Exemples de requêtes:

  • /search?q=73 Avenue de Paris Saint-Mandé
  • /search?q=cimetière Vincennes
  • /search?q=75056104AE0003

Note: L'absence de valeur est autorisée sur le type parcel pour réaliser une recherche structurée. Par exemple: /search?q=&index=parcel&departmentcode=75&municipalitycode=056&section=AV

​
autocomplete
enum<string>
default:1

indique si la recherche doit être effectuée en mode auto-complétion (comportement par défaut).

Available options:
1,
0
​
index
enum<string>
default:address

index(es) de recherche :

  • <b>address</b> pour la recherche par adresse
  • <b>parcel</b> pour la recherche par parcelle cadastrale
  • <b>poi</b> pour la recherche par lieu et unité administrative

Il est possible de spécifier plusieurs indexes séparés par une virgule.

Exemples:

  • /search?index=parcel
  • /search?index=poi,address
Available options:
address,
poi,
parcel
​
limit
integer
default:10

Nombre maximum de résultats retournés. La valeur ne peut pas dépasser 50. Dans le cas où returntruegeometry est activé, la valeur est automatiquement ramenée à 20.

​
lat
number

latitude d'un localisant pour favoriser les candidats les plus proches.

​
lon
number

longitude d'un localisant pour favoriser les candidats les plus proches.

​
returntruegeometry
boolean
default:false

indique si la vraie géométrie doit être retournée

​
postcode
string

Filtre pour les index address et poi. Il permet de filtrer les résultats par code postal.

Required string length: 5
​
citycode
string

Filtre pour les index address et poi. Il permet de filtrer les résultats par code INSEE.

Required string length: 2 - 5
​
type
enum<string>

Filtre pour l'index address. Il permet de filtrer par type de données adresse : numéro de maison, rue, commune, ...

Available options:
housenumber,
street,
locality,
municipality
​
city
string

Filtre pour les index address et poi. Il permet de filtrer par nom de commune.

​
category
string

Filtre pour l'index poi. Il permet de filtrer par catégorie de poi. Les valeurs possibles sont listées dans le getCapabilities du service de géocodage.

​
departmentcode
string

Filtre pour l'index parcel. Il permet de filtrer par code de département.

​
municipalitycode
string

Filtre pour l'index parcel. Il permet de filtrer par code de commune.

​
oldmunicipalitycode
string

Filtre pour l'index parcel. Il permet de filtrer par code d'ancienne commune.

​
districtcode
string

Filtre pour l'index parcel. Il permet de filtrer par code d'arrondissement.

​
section
string

Filtre pour l'index parcel. Il permet de filtrer par section.

​
number
string

Filtre pour l'index parcel. Il permet de filtrer par numéro.

​
sheet
string

Filtre pour l'index parcel. Il permet de filtrer par feuille.

Response

200
application/json
successful operation
​
type
string
Example:

"FeatureCollection"

​
features
object[]

Was this page helpful?