GeoplateformeOptions ​
Reference documentation: https://cartes.gouv.fr/aide/fr/guides-utilisateur/utiliser-les-services-de-la-geoplateforme/geocodage/
Properties ​
| Property | Type | Description |
|---|---|---|
category? | string[] | Poi category filter (up to 10 values); applies to the poi index only; searches all categories when omitted; see https://data.geopf.fr/geocodage/getCapabilities for the full list of values |
cityCode? | string[] | Filter by INSEE city code(s); applies to the poi/address indexes |
depCode? | string[] | Filter by department code(s); applies to the poi/address indexes |
index? | ("address" | "parcel" | "poi")[] | Indexes to search; the service defaults to "address" when omitted |
limit? | number | Maximum number of results |
postCode? | string[] | Filter by postal code(s); applies to the poi/address indexes |
returnTrueGeometry? | boolean | Include the true feature geometry in properties.truegeometry; geom always stays the service's own (simplified) geometry. Has no effect on the address index (no true geometry available) |
type? | ("street" | "housenumber" | "locality" | "municipality")[] | Address result type filter; applies to the address index only |