1. Home
  2. Developer API information
  3. Suggest FR settlement

Suggest FR settlement

Suggest a French address.

Note: This is the documentation for the v2 API which is still in beta.

GET Example request:

https://api.pro6pp.nl/v2/suggest/fr/settlement/?authKey=YOUR_AUTH_KEY&settlement=Marsa

This application gives the following result:

200: Settlement suggestion(s) available
[
  {
    "commune": "Marsa",
    "department": "Aude",
    "lat": 42.820177,
    "lng": 2.135419,
    "region": "Occitanie",
    "settlement": "Marsa"
  },
  {
    "commune": "Marsac-en-Livradois",
    "department": "Puy-de-Dôme",
    "lat": 45.501266,
    "lng": 3.760745,
    "region": "Auvergne-Rhône-Alpes",
    "settlement": "Marsac-en-Livradois"
  },
  {
    "commune": "Marsac-sur-Don",
    "department": "Loire-Atlantique",
    "lat": 47.600395,
    "lng": -1.705824,
    "region": "Pays de la Loire",
    "settlement": "Marsac-sur-Don"
  },
  {
    "commune": "Marsac-sur-l'Isle",
    "department": "Dordogne",
    "lat": 45.175388,
    "lng": 0.652432,
    "region": "Nouvelle-Aquitaine",
    "settlement": "Marsac-sur-l'Isle"
  },
  {
    "commune": "Marsac",
    "department": "Charente",
    "lat": 45.730357,
    "lng": 0.09325,
    "region": "Nouvelle-Aquitaine",
    "settlement": "Marsac"
  },
  {
    "commune": "Marsainvilliers",
    "department": "Loiret",
    "lat": 48.222008,
    "lng": 2.28191,
    "region": "Centre-Val de Loire",
    "settlement": "Marsainvilliers"
  },
  {
    "commune": "Marsais-Sainte-Radégonde",
    "department": "Vendée",
    "lat": 46.536507,
    "lng": -0.883908,
    "region": "Pays de la Loire",
    "settlement": "Marsais-Sainte-Radégonde"
  },
  {
    "commune": "Marsais",
    "department": "Charente-Maritime",
    "lat": 46.124499,
    "lng": -0.635438,
    "region": "Nouvelle-Aquitaine",
    "settlement": "Marsais"
  },
  {
    "commune": "Marsal",
    "department": "Moselle",
    "lat": 48.783274,
    "lng": 6.644373,
    "region": "Grand Est",
    "settlement": "Marsal"
  },
  {
    "commune": "Marsalès",
    "department": "Dordogne",
    "lat": 44.70399,
    "lng": 0.875972,
    "region": "Nouvelle-Aquitaine",
    "settlement": "Marsalès"
  }
]

Error responses

401: Not authenticated
404: No results found