Skip to content Skip to sidebar Skip to footer
Inloggen

Search – France

Close

Search API - France

Introduction

For France postal codes, and numbers are NOT unique to an address. So read the below endpoints carefully.

Supported search endpoints:

City

URL parameters:

  • name (required)
  • limit (optional, number (default=25))
Example request:

GET https://api.apicheck.nl/search/v1/city/fr?name=Rouen

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "Rouen",
                "city_id": 23736,
                "Postalcodes": [
                    {
                        "name": "76000",
                        "postalcode_id": 3958
                    },
                    {
                        "name": "76100",
                        "postalcode_id": 3959
                    },
                    {
                        "name": "76600",
                        "postalcode_id": 3960
                    }
                ]
            }
        ]
    },
    "count": 1
}
Postalcode

URL parameters:

  • name (required)
  • limit (optional, number (default=25))

Note: postalcodes are not unique in France. You can use this endpoint to refine searches to specific areas.

Example request:

GET https://api.apicheck.nl/search/v1/postalcode/{{country_code}}?name=1000

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "10000",
                "postalcode_id": 460,
                "City": {
                    "name": "Troyes",
                    "city_id": 3209
                }
            }
        ]
    },
    "count": 1
}
Street

URL parameters:

  • name (required)
  • city_id (optional)
  • postalcode_id (optional)
  • limit (optional, number (default=25))
Note: city_id and postalcode_id are both optional parameters. However to refine your search within a specified city you can provide a city_id and/or postalcode_id. If you provide both your query will have better results as the search area is smaller. To obtain these IDs you can use the above City or Postalcode search endpoint.
 
Example request:

GET https://api.apicheck.nl/search/v1/street/fr?name=Rue&city_id=23736&postalcode_id=3958

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "name": "Rue du 74e Regiment d’Infanterie",
                "street_id": 362722,
                "City": {
                    "name": "Rouen",
                    "city_id": 23736
                }
            },
            {
                "name": "Rue du 11 Novembre 1918",
                "street_id": 362723,
                "City": {
                    "name": "Rouen",
                    "city_id": 23736
                }
            },
        ]
    },
    "count": 25
}
Verify / lookup full address

This endpoint is used to validate the full given address. All parameters are optional. The results will show as an array, as there can be multiple results.

URL parameters:

  • number (optional)
  • numberAddition (optional)
  • street_id (optional)
  • city_id (optional)
  • limit (optional, number (default=25))
Example request:

GET https://api.apicheck.nl/search/v1/address/fr?number=7&city_id=23736&postalcode_id=3958&street_id=362722

{
    "error": false,
    "data": {
        "Country": {
            "name": "Frankrijk",
            "code": "FR",
            "nameInt": "France"
        },
        "Results": [
            {
                "street": "Rue du 74e Regiment d’Infanterie",
                "number": "7",
                "numberAddition": null,
                "postalcode": "76000",
                "city": "Rouen",
                "municipality": "Rouen",
                "region": null,
                "formattedAddress": "7 Rue du 74e Regiment d’Infanterie 76000 Rouen, France",
                "Location": {
                    "Coordinates": {
                        "latitude": "49.432917",
                        "longitude": "1.081816"
                    }
                }
            }
        ]
    },
    "count": 1
}

Run and try out in Postman: