Suggest Services

Suggest Zipcode All

The Suggest Zipcode All endpoint returns every house-number range for a city, street, or house number, with its parity and range type.

Endpoint

POSThttps://{host}:{port}/Egon/api/suggest/zipcodeAll

Headers & authentication

Required request headers and their expected values.

Field	Type	Description
`token`req	String	Authentication token sent in the `token` request header.

Request

Processing options, entity ID, and house-number parameters.

Field	Type	Description
`par`req	Object	Processing parameters, candidate limits, and country context
`iso2`	String	Country code, ISO 3166-1 alpha-2. One of `iso2` or `iso3` is required.
`iso3`	String	Country code, ISO 3166-1 alpha-3. One of `iso2` or `iso3` is required.
`max_candidates`	Number	Maximum number of candidates to extract Default value: `10`
`data`req	Object	Search criteria for full postal code lookup
`city_id`	Number	ID of the city
`street_id`	Number	ID of the street
`hn`	Number	House number
`zipcode`	String	Postal code

Response

House-number range results, parity codes, postal codes, and system status.

Field	Type	Description
`data`	Object
`results`	Array	Array of candidate matches returned by the suggestion engine
`zipcode`	String	Postal code
`hn_start`	String	Range starting house number
`hn_end`	String	Range ending house number
`exp_start`	String	Range starting exponent
`exp_end`	String	Range ending exponent
`parity`	String	Parity: `E` for even and `O` for odd
`range_type`	String	Range type: `0` for house number and `2` for kilometer indication
`system`	Object	System error and execution status
`ret_code`	Number	Code: 0 no blocking error, <> 0 blocking error code
`des_ret_code`	String	Description

On this page

Endpoint
Headers & authentication
Request
Response

Request Example

curl -X POST "https://{host}:{port}/Egon/api/suggest/zipcodeAll" \
  -H "token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "par": {
    "iso3": "ITA"
  },
  "data": {
    "street_id": "38000093621"
  }
}'

Endpoint​

Headers & authentication​

Request​

Response​

Endpoint

Headers & authentication

Request

Response