Autocomplete

Autocomplete addresses

curl --request GET \
  --url https://api.geoscale.io/v1/address \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.geoscale.io/v1/address"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.geoscale.io/v1/address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.geoscale.io/v1/address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.geoscale.io/v1/address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.geoscale.io/v1/address")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.geoscale.io/v1/address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
      ]
    }
  ]
}

GET

address

Autocomplete addresses

curl --request GET \
  --url https://api.geoscale.io/v1/address \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.geoscale.io/v1/address"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.geoscale.io/v1/address', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.geoscale.io/v1/address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.geoscale.io/v1/address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.geoscale.io/v1/address")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.geoscale.io/v1/address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
      ]
    }
  ]
}

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

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.

Belgian street address
French street address
Luxembourg street address
Dutch street address

Show child attributes

Rate limits Lookup

Getting started

Using the API

API reference

Authorizations

Query Parameters

Response