Skip to main content

Suggest Services

Suggest Country

The Suggest Country endpoint provides predictive autocomplete and search over world countries, with names in many languages, ISO codes, and Egon IDs.

Endpoint​

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

Headers & authentication​

Required request headers and their expected values.

FieldTypeDescription
tokenreq
String

Authentication token sent in the token request header.

Request​

Processing options, extraction limits, and country query.

FieldTypeDescription
par
Object

Processing parameters and output language for country search

max_candidates
Number

Maximum number of candidates to extract

Default value: 10

lngout
String

Language code ISO 3166-1 numeric

datareq
Object

Query container holding the input search string

queryreq
String

Query string

Response​

Matching country candidates, ISO codes, and system status.

FieldTypeDescription
data
Object
results
Array

Array of candidate matches returned by the suggestion engine

iso3
String

Country code ISO 3166-1 alpha-3

lngout
String

Language code ISO 3166-1 numeric

country
String

Country name

country_id
Number

ID of the country

system
Object

System error and execution status

ret_code
Number

Code: 0 no blocking error, <> 0 blocking error code

des_ret_code
String

Description

Request Example
curl -X POST "https://{host}:{port}/Egon/api/suggest/country" \
-H "token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": {
"query": "Ital"
}
}'