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": "25p8hdho2ucpbSc6g1QSythIGj3dzN",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "1012 JS",
"locality": "Amsterdam",
"municipality": "Amsterdam",
"province": "Noord-Holland",
"country": "Nederland",
"location": {
"latitude": 52.373293,
"longitude": 4.893718
},
"single_line": "Dam 1, Amsterdam",
"lines": [
"Dam 1",
"1012 JS Amsterdam",
"Nederland"
]
},
{
"id": "25p8hdho2ucRDBOUd62TKCOYqRjdXW",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "1506 BC",
"locality": "Zaandam",
"municipality": "Zaanstad",
"province": "Noord-Holland",
"country": "Nederland",
"location": {
"latitude": 52.439496,
"longitude": 4.825241
},
"single_line": "Dam 1, Zaandam",
"lines": [
"Dam 1",
"1506 BC Zaandam",
"Nederland"
]
},
{
"id": "25p8hdho2udLwV3DSfw84vE3hUvVtw",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "3111 BC",
"locality": "Schiedam",
"municipality": "Schiedam",
"province": "Zuid-Holland",
"country": "Nederland",
"location": {
"latitude": 51.917776,
"longitude": 4.395723
},
"single_line": "Dam 1, Schiedam",
"lines": [
"Dam 1",
"3111 BC Schiedam",
"Nederland"
]
},
{
"id": "25p8hdho2ucRKhDLQ09DIfnReDaY0B",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "2952 AB",
"locality": "Alblasserdam",
"municipality": "Alblasserdam",
"province": "Zuid-Holland",
"country": "Nederland",
"location": {
"latitude": 51.858704,
"longitude": 4.660075
},
"single_line": "Dam 1, Alblasserdam",
"lines": [
"Dam 1",
"2952 AB Alblasserdam",
"Nederland"
]
},
{
"id": "25p8hdho2udMc2spToi8mB7a3obaKu",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "4461 HV",
"locality": "Goes",
"municipality": "Goes",
"province": "Zeeland",
"country": "Nederland",
"location": {
"latitude": 51.501864,
"longitude": 3.890381
},
"single_line": "Dam 1, Goes",
"lines": [
"Dam 1",
"4461 HV Goes",
"Nederland"
]
}
]
}API reference
Autocomplete
Returns address suggestions for a partial address query.
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": "25p8hdho2ucpbSc6g1QSythIGj3dzN",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "1012 JS",
"locality": "Amsterdam",
"municipality": "Amsterdam",
"province": "Noord-Holland",
"country": "Nederland",
"location": {
"latitude": 52.373293,
"longitude": 4.893718
},
"single_line": "Dam 1, Amsterdam",
"lines": [
"Dam 1",
"1012 JS Amsterdam",
"Nederland"
]
},
{
"id": "25p8hdho2ucRDBOUd62TKCOYqRjdXW",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "1506 BC",
"locality": "Zaandam",
"municipality": "Zaanstad",
"province": "Noord-Holland",
"country": "Nederland",
"location": {
"latitude": 52.439496,
"longitude": 4.825241
},
"single_line": "Dam 1, Zaandam",
"lines": [
"Dam 1",
"1506 BC Zaandam",
"Nederland"
]
},
{
"id": "25p8hdho2udLwV3DSfw84vE3hUvVtw",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "3111 BC",
"locality": "Schiedam",
"municipality": "Schiedam",
"province": "Zuid-Holland",
"country": "Nederland",
"location": {
"latitude": 51.917776,
"longitude": 4.395723
},
"single_line": "Dam 1, Schiedam",
"lines": [
"Dam 1",
"3111 BC Schiedam",
"Nederland"
]
},
{
"id": "25p8hdho2ucRKhDLQ09DIfnReDaY0B",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "2952 AB",
"locality": "Alblasserdam",
"municipality": "Alblasserdam",
"province": "Zuid-Holland",
"country": "Nederland",
"location": {
"latitude": 51.858704,
"longitude": 4.660075
},
"single_line": "Dam 1, Alblasserdam",
"lines": [
"Dam 1",
"2952 AB Alblasserdam",
"Nederland"
]
},
{
"id": "25p8hdho2udMc2spToi8mB7a3obaKu",
"type": "nl_street_address",
"street": "Dam",
"house_number": "1",
"postal_code": "4461 HV",
"locality": "Goes",
"municipality": "Goes",
"province": "Zeeland",
"country": "Nederland",
"location": {
"latitude": 51.501864,
"longitude": 3.890381
},
"single_line": "Dam 1, Goes",
"lines": [
"Dam 1",
"4461 HV Goes",
"Nederland"
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Two-letter country code (ISO 3166-1 alpha-2).
Available options:
NL, BE, LU, DE, AT, CH, FR Partial address input. Must contain at least one character.
Required string length:
1 - 128BCP 47 language tag used for localization of the response. Does not affect search matching or ranking.
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 <= 10Response
Autocomplete suggestions returned successfully.
Address autocomplete result set.
hits
(Dutch street address · object | Belgian street address · object | Luxembourg street address · object | German street address · object | Austrian street address · object | Swiss street address · object | French street address · object)[]
required
Maximum array length:
10Structured Dutch street address.
- Dutch street address
- Belgian street address
- Luxembourg street address
- German street address
- Austrian street address
- Swiss street address
- French street address
Show child attributes
Show child attributes