Single Line Service
Full Address
The Full Address endpoint parses a complete address written as a single free-text string and returns a list of normalized candidate addresses.
Headers & authentication
Required request headers and their expected values.
| Field | Type | Description |
|---|---|---|
tokenreq | String | Authentication token sent in the |
Request
Single-line query string, country context, and parsing options.
| Field | Type | Description |
|---|---|---|
parreq | Object | |
iso3req | String | ISO 3166-1 alpha-3 country code |
output | String | Output language. Allowed values: |
datareq | Object | |
queryreq | String | Free-text query containing the complete address |
restrict_id | Number | Identifier of the territorial restriction. Required when |
restrict_level | String | Territorial level used for the restriction. Required when |
Response
Structured address candidates, matching confidence scores, and system status.
| Field | Type | Description |
|---|---|---|
data | Object | |
results | Array | Array of candidate matching addresses |
iso3 | String | ISO 3166-1 alpha-3 country code |
id | Number | Street identifier |
country | String | Country name |
state | String | State name |
region | String | Region name |
province | String | Province name |
province_code | String | Province code |
city | String | City name |
district1 | String | First-level district name |
district2 | String | Second-level district name |
district3 | String | Third-level district name |
zipcode | String | Postal or ZIP code |
street | String | Street name |
hn_num | String | Numeric portion of the house number |
hn_exp | String | House-number suffix or exponent |
system | Object | System error and execution status |
ret_code | Number | Code: 0 no blocking error, <> 0 blocking error code |
des_ret_code | String | Description |
curl -X POST "https://{host}:{port}/Egon/api/single-line/full-address" \
-H "token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"par": {
"iso3": "ITA"
},
"data": {
"query": "Via Pacinotti 4b, Verona"
}
}'