Skip to main content
GET
/
address
Find an address
curl --request GET \
  --url https://api.geoscale.io/v1/address \
  --header 'Authorization: Bearer <token>'
{ "country": "BE", "language": "nl", "hits": [ { "single_line": "Rue de la Loi 16, 7170 Manage", "lines": [ "Rue de la Loi 16", "7170 Manage", "België" ], "record": { "type": "be_street_address", "street": "Rue de la Loi", "house_number": 16, "postal_code": 7170, "municipality": "Manage", "arrondissement": "Arrondissement Zinnik", "province": "Provincie Henegouwen", "region": "Waals Gewest", "country": "België" }, "location": { "latitude": 50.475721, "longitude": 4.236087 } }, { "single_line": "Rue de la Loi 16 0002, 4020 Luik", "lines": [ "Rue de la Loi 16 0002", "4020 Luik", "België" ], "record": { "type": "be_street_address", "street": "Rue de la Loi", "house_number": 16, "box_number": 2, "postal_code": 4020, "municipality": "Luik", "arrondissement": "Arrondissement Luik", "province": "Provincie Luik", "region": "Waals Gewest", "country": "België" }, "location": { "latitude": 50.642752, "longitude": 5.585497 } }, { "single_line": "Rue de la Loi 16, 7100 La Louvière", "lines": [ "Rue de la Loi 16", "7100 La Louvière", "België" ], "record": { "type": "be_street_address", "street": "Rue de la Loi", "house_number": 16, "postal_code": 7100, "municipality": "La Louvière", "arrondissement": "Arrondissement La Louvière", "province": "Provincie Henegouwen", "region": "Waals Gewest", "country": "België" }, "location": { "latitude": 50.478136, "longitude": 4.186106 } }, { "single_line": "Rue de la Loi 160, 7170 Manage", "lines": [ "Rue de la Loi 160", "7170 Manage", "België" ], "record": { "type": "be_street_address", "street": "Rue de la Loi", "house_number": 160, "postal_code": 7170, "municipality": "Manage", "arrondissement": "Arrondissement Zinnik", "province": "Provincie Henegouwen", "region": "Waals Gewest", "country": "België" }, "location": { "latitude": 50.476678, "longitude": 4.231801 } }, { "single_line": "Rue de la Loi 164, 7170 Manage", "lines": [ "Rue de la Loi 164", "7170 Manage", "België" ], "record": { "type": "be_street_address", "street": "Rue de la Loi", "house_number": 164, "postal_code": 7170, "municipality": "Manage", "arrondissement": "Arrondissement Zinnik", "province": "Provincie Henegouwen", "region": "Waals Gewest", "country": "België" }, "location": { "latitude": 50.476666, "longitude": 4.231588 } } ], "limit": 5 }

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
country
enum<string>
required

Two-letter country code (ISO 3166-1 alpha-2).

Available options:
BE,
LU,
NL
​
q
string
required

Partial address input.

Maximum string length: 128
​
lang
string

BCP 47 language tag used for localization of the response. Does not affect search matching or ranking.

​
limit
integer
default:5

Maximum number of suggestions to return.

Note: Results are ranked for the requested limit. Requesting a higher limit and then truncating the result list client-side may lead to suboptimal ranking of the remaining results.

Required range: 1 <= x <= 10

Response

Autocomplete suggestions returned successfully.

Address autocomplete result set.

​
country
enum<string>
required

ISO 3166-1 alpha-2 country code.

Available options:
BE,
LU,
NL
​
language
string
required

BCP 47 language tag used for localization of the response. Does not affect search matching or ranking.

​
hits
object[]
required
​
limit
integer
required

Maximum number of results requested.