Skip to main content
GET
/
address
Autocomplete addresses
curl --request GET \
  --url https://api.geoscale.io/v1/address \
  --header 'Authorization: Bearer <token>'
{
  "hits": [
    {
      "id": "jp1p2kJ5yXvAwnMp",
      "type": "be_street_address",
      "street": "Rue de la Loi",
      "house_number": "16",
      "postal_code": "7170",
      "municipality": "Manage",
      "arrondissement": "Arrondissement de Soignies",
      "province": "Province du Hainaut",
      "region": "Région wallonne",
      "country": "Belgique",
      "location": {
        "latitude": 50.475721,
        "longitude": 4.236087
      },
      "single_line": "Rue de la Loi 16, 7170 Manage",
      "lines": [
        "Rue de la Loi 16",
        "7170 Manage",
        "Belgique"
      ]
    },
    {
      "id": "1i7jNnDAaTevq7abmi",
      "type": "be_street_address",
      "street": "Rue de la Loi",
      "house_number": "16",
      "box_number": "0002",
      "postal_code": "4020",
      "municipality": "Liège",
      "arrondissement": "Arrondissement de Liège",
      "province": "Province de Liège",
      "region": "Région wallonne",
      "country": "Belgique",
      "location": {
        "latitude": 50.642752,
        "longitude": 5.585497
      },
      "single_line": "Rue de la Loi 16 0002, 4020 Liège",
      "lines": [
        "Rue de la Loi 16 0002",
        "4020 Liège",
        "Belgique"
      ]
    },
    {
      "id": "jp1p2kJ5zAnjBzoJ",
      "type": "be_street_address",
      "street": "Rue de la Loi",
      "house_number": "16",
      "postal_code": "7100",
      "municipality": "La Louvière",
      "arrondissement": "Arrondissement de La Louvière",
      "province": "Province du Hainaut",
      "region": "Région wallonne",
      "country": "Belgique",
      "location": {
        "latitude": 50.478136,
        "longitude": 4.186106
      },
      "single_line": "Rue de la Loi 16, 7100 La Louvière",
      "lines": [
        "Rue de la Loi 16",
        "7100 La Louvière",
        "Belgique"
      ]
    },
    {
      "id": "jp1p2kJ5yXvAwnMo",
      "type": "be_street_address",
      "street": "Rue de la Loi",
      "house_number": "160",
      "postal_code": "7170",
      "municipality": "Manage",
      "arrondissement": "Arrondissement de Soignies",
      "province": "Province du Hainaut",
      "region": "Région wallonne",
      "country": "Belgique",
      "location": {
        "latitude": 50.476678,
        "longitude": 4.231801
      },
      "single_line": "Rue de la Loi 160, 7170 Manage",
      "lines": [
        "Rue de la Loi 160",
        "7170 Manage",
        "Belgique"
      ]
    },
    {
      "id": "jp1p2kJ5yXvAwnMn",
      "type": "be_street_address",
      "street": "Rue de la Loi",
      "house_number": "164",
      "postal_code": "7170",
      "municipality": "Manage",
      "arrondissement": "Arrondissement de Soignies",
      "province": "Province du Hainaut",
      "region": "Région wallonne",
      "country": "Belgique",
      "location": {
        "latitude": 50.476666,
        "longitude": 4.231588
      },
      "single_line": "Rue de la Loi 164, 7170 Manage",
      "lines": [
        "Rue de la Loi 164",
        "7170 Manage",
        "Belgique"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.geoscale.io/llms.txt

Use this file to discover all available pages before exploring further.

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,
FR,
LU,
NL
​
q
string
required

Partial address input. Must contain at least one character.

Required string length: 1 - 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.

​
hits
(Belgian street address · object | French street address · object | Luxembourg street address · object | Dutch street address · object)[]
required
Maximum array length: 10

Structured Belgian street address.