Resolve user input to ranked geo candidates
curl --request GET \
--url https://api.homelogs.io/v1/locations/resolve \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.homelogs.io/v1/locations/resolve"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.homelogs.io/v1/locations/resolve', 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.homelogs.io/v1/locations/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.homelogs.io/v1/locations/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.homelogs.io/v1/locations/resolve")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.homelogs.io/v1/locations/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"query": "<string>",
"count": 1,
"candidates": [
{
"geo_id": "<string>",
"geo_type": "property",
"display_name": "<string>",
"score": 123,
"confidence": 123,
"match_method": "<string>",
"decision": "<string>",
"reasons": [
"<string>"
],
"state": "<string>",
"county": "<string>",
"city": "<string>",
"zipcode": "<string>",
"jurisdiction": "<string>"
}
]
}{
"message": "<string>"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}{
"message": "<string>"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}Core Endpoints
Resolve Location
Resolves text input to ranked location candidates across supported geo scopes.
GET
/
v1
/
locations
/
resolve
Resolve user input to ranked geo candidates
curl --request GET \
--url https://api.homelogs.io/v1/locations/resolve \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.homelogs.io/v1/locations/resolve"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.homelogs.io/v1/locations/resolve', 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.homelogs.io/v1/locations/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.homelogs.io/v1/locations/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.homelogs.io/v1/locations/resolve")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.homelogs.io/v1/locations/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"query": "<string>",
"count": 1,
"candidates": [
{
"geo_id": "<string>",
"geo_type": "property",
"display_name": "<string>",
"score": 123,
"confidence": 123,
"match_method": "<string>",
"decision": "<string>",
"reasons": [
"<string>"
],
"state": "<string>",
"county": "<string>",
"city": "<string>",
"zipcode": "<string>",
"jurisdiction": "<string>"
}
]
}{
"message": "<string>"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}{
"message": "<string>"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "state must be a 2-letter code",
"request_id": "req-123"
}
}Use this endpoint to turn user-entered text into candidate
Use the returned
geo_id values.
Typical input is a partial location string such as city, ZIP, county, or jurisdiction name.Use the returned
geo_id in downstream permit and signal endpoints.Authorizations
Query Parameters
Free-form text input (aliases: q, address, text).
Required string length:
1 - 200Optional two-letter state filter.
Pattern:
^[A-Za-z]{2}$Example:
"WA"
Optional scope filter.
Available options:
property, jurisdiction, city, zip, county, state Maximum candidates to return.
Required range:
1 <= x <= 20Was this page helpful?

