curl --request GET \
--url https://api.homelogs.io/v1/signals/permit/leads \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.homelogs.io/v1/signals/permit/leads"
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/signals/permit/leads', 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/signals/permit/leads",
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/signals/permit/leads"
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/signals/permit/leads")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.homelogs.io/v1/signals/permit/leads")
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{
"geo_id": "<string>",
"geo_type": "jurisdiction",
"scope": "permit",
"signal_keys": [
"<string>"
],
"max_freshness_days": 1825,
"count": 1,
"next_cursor": "<string>",
"group_by": "none",
"leads": [
{
"lead_id": "<string>",
"signal_key": "<string>",
"event_date_used": "2023-12-25",
"signal_basis": "<string>",
"confidence": 123,
"reason_codes": [
"<string>"
],
"freshness_lag_days": 1,
"permit_number": "<string>",
"jurisdiction": "<string>",
"location": {
"full_address": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"county": "<string>",
"city_norm": "<string>",
"zipcode_norm": "<string>",
"county_norm": "<string>"
},
"maps_url": "<string>"
}
],
"groups": [
{
"key": "<string>",
"count": 1,
"leads": [
{
"lead_id": "<string>",
"signal_key": "<string>",
"event_date_used": "2023-12-25",
"signal_basis": "<string>",
"confidence": 123,
"reason_codes": [
"<string>"
],
"freshness_lag_days": 1,
"permit_number": "<string>",
"jurisdiction": "<string>",
"location": {
"full_address": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"county": "<string>",
"city_norm": "<string>",
"zipcode_norm": "<string>",
"county_norm": "<string>"
},
"maps_url": "<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"
}
}Permit Signal Leads
Fetch permit-scoped lead rows for a geo_id
curl --request GET \
--url https://api.homelogs.io/v1/signals/permit/leads \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.homelogs.io/v1/signals/permit/leads"
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/signals/permit/leads', 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/signals/permit/leads",
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/signals/permit/leads"
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/signals/permit/leads")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.homelogs.io/v1/signals/permit/leads")
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{
"geo_id": "<string>",
"geo_type": "jurisdiction",
"scope": "permit",
"signal_keys": [
"<string>"
],
"max_freshness_days": 1825,
"count": 1,
"next_cursor": "<string>",
"group_by": "none",
"leads": [
{
"lead_id": "<string>",
"signal_key": "<string>",
"event_date_used": "2023-12-25",
"signal_basis": "<string>",
"confidence": 123,
"reason_codes": [
"<string>"
],
"freshness_lag_days": 1,
"permit_number": "<string>",
"jurisdiction": "<string>",
"location": {
"full_address": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"county": "<string>",
"city_norm": "<string>",
"zipcode_norm": "<string>",
"county_norm": "<string>"
},
"maps_url": "<string>"
}
],
"groups": [
{
"key": "<string>",
"count": 1,
"leads": [
{
"lead_id": "<string>",
"signal_key": "<string>",
"event_date_used": "2023-12-25",
"signal_basis": "<string>",
"confidence": 123,
"reason_codes": [
"<string>"
],
"freshness_lag_days": 1,
"permit_number": "<string>",
"jurisdiction": "<string>",
"location": {
"full_address": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"county": "<string>",
"city_norm": "<string>",
"zipcode_norm": "<string>",
"county_norm": "<string>"
},
"maps_url": "<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"
}
}geo_id.
It returns the current page of leads, trust fields (event_date_used, signal_basis, confidence, reason_codes), freshness metadata, and the cursor for the next page.
Use include_stale=true if you need rows older than the default freshness window.
Supported permit-pack keys are documented in Signals Catalog.
See also Permit Signal Stats.
Required input
geo_id(query, required, non-property geo)
Optional input
signal_keys(CSV list)from_date,to_date(YYYY-MM-DD)min_confidence(0..1)max_freshness_days(1..3650)include_stale(true|false)sort(event_date_descorconfidence_desc)group_by(none,city,zip)limit(1..100)cursor(opaque pagination token)
Example request
curl -sS "$API_BASE_URL/v1/signals/permit/leads?geo_id=geo_county_6973f63e37a900040c0d&signal_keys=site_prep_issued_nowcast,new_construction_issued_nowcast&sort=event_date_desc&group_by=none&limit=25" \
-H "x-api-key: $HOMELOGS_API_KEY"
Response shape
geo_id,geo_type,scope=permitsignal_keys[]max_freshness_dayscountnext_cursorleads[](orgroups[]when grouped)
Authorizations
Query Parameters
Location identity token for a non-property geo scope.
"geo_county_6973f63e37a900040c0d"
Optional CSV list of customer-facing permit signal keys. Allowed values: site_prep_issued_nowcast, new_construction_issued_nowcast, framing_nowcast_early, framing_window_late, rough_in_nowcast_early, rough_in_window_late.
"site_prep_issued_nowcast,new_construction_issued_nowcast"
Optional lower bound in YYYY-MM-DD format.
Optional upper bound in YYYY-MM-DD format.
Optional minimum confidence between 0 and 1.
0 <= x <= 1Optional freshness window in days, between 1 and 3650. Defaults to 60 when include_stale is false.
1 <= x <= 3650When true, disables the default freshness filter.
Cursor sort order for the returned page.
event_date_desc, confidence_desc Optional grouping for the returned page.
none, city, zip Maximum rows to return.
1 <= x <= 100Opaque cursor from the previous page.
Response
Permit-scoped lead rows and pagination metadata.
jurisdiction, city, zip, county, state, null permit 1 <= x <= 3650x >= 0none, city, zip Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

