1. Home
  2. Developer API information
  3. Nearby DE

Nearby DE

Return German postal codes within range of a given postal code

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

This will return all postal codes within a range of a given postal code or city.

  • Either the postalCode or settlement is required

Required parameters

    Optional parameters

    • postalCode (string): The address's postal code which can be up to five digits long
    • settlement (string): The address's settlement (city, town, village, or hamlet)
    • searchRange (integer): The range to search, in meters. Maximum 100000.
    • maxResults (integer): The amount of results returned, a number between 0 and 999.


    authKey: This is the Authorization key. You have to add it as a GET parameter. Your auth key can be found on the CMS.