# API reference

> Documentation index: [llms.txt](https://westkite.com/docs/llms.txt). Every page is also at its URL plus `.md`.

Every endpoint of the developer API with its parameters, every `find` type with the fields `where` takes, and the values that need explaining. This page is generated from the API's own [OpenAPI document](https://api.westkite.com/v1/openapi.json), so it always matches what the API serves. The guides in this section explain how to use each endpoint.

All paths are under `https://api.westkite.com/v1`. Send your key as `Authorization: Bearer $WESTKITE_API_KEY` unless an endpoint says no key is needed.

## Meta

### Index

```endpoint
GET /v1/
```

Links to the docs, this document and the rate card.

Price: Free. No key needed.

### This document

```endpoint
GET /v1/openapi.json
```

OpenAPI 3.1.

Price: Free. No key needed.

### Try it (no key)

```endpoint
GET /v1/try
```

The marketing site's try-it box: the top match for an address as a short record (owner of record, size, last sale), never contacts. No key; browsers may call it from westkite.com only. Ten a minute and 50 a day per IP; identical queries are cached 5 minutes. Fields a record does not carry are listed in missing.

Price: Free. No key needed.

| Parameter | In | Type | Description |
|---|---|---|---|
| `q` (required) | query | string | An address, e.g. 550 Madison Ave, New York. |

Response:

| data field | Type | Description |
|---|---|---|
| `property` | object or null |  |
| `more` | string |  |

### Coverage

```endpoint
GET /v1/coverage
```

What West Kite holds for a state or county: summary (counties and properties served), and per county the properties served and the share of rows carrying each field. A county not listed is not covered yet.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `state` | query | string | Two-letter code or FIPS. |
| `county` | query | string | A five-digit county FIPS code, or a county name with its state ("Travis County, TX", or Travis with state=TX). |

Response:

| data field | Type | Description |
|---|---|---|
| `summary` | object |  |
| `counties` | list of object |  |
| `note` | string |  |

### Source catalog

```endpoint
GET /v1/sources
```

Every data source West Kite serves, holds or has looked at and left out: the publisher, the dataset and its link, what it provides and where, how we get it (ArcGIS, Socrata, bulk file, API, records request), how often we look for a new copy, the publisher's terms, and its status. Each source appears once, with the manifest that defines it. A served source carries the release that last loaded it; registered means listed in a manifest with no load citing it yet. Terms are shown as the publisher states them, never more: open (Open licence or public domain); attribution (Open, with attribution); unclear (Terms unclear, attribution given); permission (Permission recorded); licensed (Commercial licence); held (Held: terms restrict redistribution); paid (Paid source, not acquired); not-recorded (Terms not yet recorded). Held and not-covered sources are listed with the reason and are never served. format=csv returns every match as one CSV file for due diligence. No key needed.

Price: Free. No key needed.

| Parameter | In | Type | Description |
|---|---|---|---|
| `status` | query | one of `served`, `registered`, `held`, `not-covered` | Only sources with this status. |
| `state` | query | string | Only sources covering this state (two-letter code); nationwide sources always match. |
| `dataset` | query | string | Only sources feeding this dataset id (the datasets list in the answer). |
| `licence` | query | one of `open`, `attribution`, `unclear`, `permission`, `licensed`, `held`, `paid`, `not-recorded` | Only sources whose terms have this status. |
| `q` | query | string | Text in the id, name, publisher or what it provides. |
| `limit` | query | integer (from 1 to 1000) | Sources per page, 1 to 1000. Default 100. |
| `offset` | query | integer (from 0) | Skip this many matches (next_offset from the previous page). |
| `format` | query | one of `json`, `csv` | csv: every match as a CSV file instead of a JSON page. |

Response:

| data field | Type | Description |
|---|---|---|
| `total` (required) | integer |  |
| `offset` (required) | integer |  |
| `limit` (required) | integer |  |
| `next_offset` (required) | integer or null |  |
| `counts` (required) | object |  |
| `sources` (required) | list of CatalogSource |  |
| `datasets` (required) | list of object |  |
| `notes` (required) | list of string |  |

### One source

```endpoint
GET /v1/sources/{id}
```

One source from the catalog, by its id (GET /sources lists them). No key needed.

Price: Free. No key needed.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | The source's id, e.g. FL-MDC-PERMITS. |

`data` is a `CatalogSource`; its fields are in the OpenAPI document.

### Ask for data

```endpoint
POST /v1/requests
```

Ask for data West Kite does not have yet: say what you need in note, and where in place. kind is optional.

Price: Free.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `note` (required) | string |  |
| `place` | string |  |
| `kind` | one of `place`, `field`, `source`, `other` |  |
| `field` | string |  |

Response:

| data field | Type | Description |
|---|---|---|
| `id` | string |  |
| `status` | string |  |


## Properties

### Search

```endpoint
GET /v1/search
```

An address, APN, building, owner or company name to options, as West Kite's search box shows them: up to ten ranked results for an address, each with why it matched (match; reason: exact, suffix_variant, direction_variant, range, alternate, spelling, geocoded, prefix), a confidence from 0 to 1, its city and state, and exact. Act on the first result alone only at confidence 0.9 or more. Street suffix variants (Pkwy for a record filed PY), misspelled streets and ordinals ("1 Markt St", "350 Fith Ave") find the building. An address West Kite does not hold returns no results with note "No match" (warning appears only when the search could not answer). Text with no house number that names an owner lists that owner's properties first; places the text names come back in places (pass one as in). When nothing matches exactly, the closest records held come back with exact: false and corrected_query, never an empty guess. in or lat and lng prefer options there. A point alone (lat and lng without q) returns the parcel whose outline contains it (stacked parcels: all of them); with none, the nearest property within about 500 m, with nearest: true.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `q` | query | string | Words to search. |
| `in` | query | string | With q: a place to prefer, e.g. San Francisco, CA. |
| `lat` | query | number | Latitude: alone with lng, the parcel there; with q, prefer options near it. |
| `lng` | query | number | Longitude. |
| `limit` | query | integer | Results, up to 50. Default 20. |

Response:

| data field | Type | Description |
|---|---|---|
| `results` | list of SearchHit |  |
| `places` | list of object |  |
| `corrected_query` | string | What the closest options were read as, when nothing matched exactly. |
| `note` | string |  |
| `warning` | string | The search could not answer in time: an empty answer is not evidence of no match. |

### A property record

```endpoint
GET /v1/properties/{id}
```

property:<uuid> or a bare UUID. All parts are one price. sales, assessments, permits, zoning, planning and events are typed lists (SalesPart, AssessmentsPart, PermitsPart, ZoningPart, PlanningPart, EventsPart): every item names its source_ids, and a part's sources are exactly the ones its items cite. more_available says when the property's record holds more than it returned. events are the violations, inspections, enforcement orders, licences and other dated records on the property that no other part serves (code and building violations, unsafe-structure cases, facade, boiler and elevator filings, food inspections), each with the publisher's status. An empty part is listed in missing with the reason (not_on_record, not_published, or not_covered where West Kite holds no such records for the county). loans are the debt on public record; owner returns saved research without person contacts. outline is the parcel outline as a GeoJSON Feature (OutlinePart), null with a missing entry when none is on record.

Price: $0.01 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | Property ID. |
| `parts` | query | string | Comma-separated: overview, sales, assessments, zoning, permits, planning, events, fields, owner, loans, outline, or all for every part. Default overview. The price is the same whatever parts you ask for. |
| `events_cursor` | query | string | With parts=events: the part's next_cursor, for the next page of events. Each page reads on in both the violations and the other records; null next_cursor is the end. |
| `event_category` | query | one of `violation`, `inspection`, `planning`, `ownership`, `other` | With parts=events: only events of this category. violation reads the violations alone; the other categories are filtered from the rest, so a page can hold fewer events than it read. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

`data` is a `PropertyRecord`; its fields are in the OpenAPI document.

### Many property records

```endpoint
POST /v1/properties/batch
```

The typed record of up to 100 properties in one call (property_ids from search or find). Each record found costs the property price; an ID with no published record costs nothing and is listed in not_found.

Price: $0.01 per call per record found.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `property_ids` (required) | list of string |  |
| `max_cost_usd` | number |  |

Response:

| data field | Type | Description |
|---|---|---|
| `properties` (required) | list of Property |  |
| `not_found` (required) | list of string |  |

### Aerial photo with the lot outlined

```endpoint
GET /v1/properties/{id}/image
```

A JPEG crop from public-domain or openly licensed imagery, or imagery its publisher granted West Kite to serve (license permission, e.g. NYC's aerials back to 1924; the permission field names the grant), with the parcel outline drawn on it. Headers X-Imagery-Source, X-Imagery-Year, X-Imagery-Credit and X-Imagery-License name it; format=json returns the same as JSON with the outline and years: every year with a photo of this lot, newest first, each naming the source, publisher, resolution and license that year's photo comes from (available_years is the same years as plain numbers). One list decides every photo: without year the photo is the first entry in years, and year=Y is the entry for Y. year is null when the flight cannot be dated. invalid_request lists the years when the asked year has none. not_found when no public imagery West Kite serves was flown over the lot (Alaska, for one); service_unavailable when a publisher did not answer.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | Property ID. |
| `size` | query | integer | Pixels square: 256, 512, 768, 1024. Default 1024. |
| `format` | query | string | jpeg (default) or json. |
| `year` | query | integer | Flight year, 1990 or later: one of years. Default: the first entry in years, the newest photo. |

`data` is a `PropertyImage`; its fields are in the OpenAPI document.

### Site report

```endpoint
GET /v1/properties/{id}/site
```

Land diligence for one property from public sources: environmental (Superfund, brownfields, leaking tanks, hazardous waste and chemical releases within ASTM Phase I distances, air quality nonattainment and transportation noise), hazards (FEMA flood zone, National Risk Index, wildfire, sea level rise, the nearest high or significant hazard dams within 5 mi, FEMA map revisions and amendments, drought, hail reports and radar-estimated maximum hail size, and the county's flood insurance claims and disaster declarations), incentives (Opportunity Zones of 2018 and 2027, New Markets Tax Credit, LIHTC QCT and DDA, HUBZone, state enterprise zones, IRA energy communities, foreign trade zones and their sites), buildability (soils, wetlands, protected land, critical habitat, karst, radon zone, slope, controlled airspace, drone ceilings and airport noise contours, rail lines, gas pipelines and the county's pipeline miles, and jurisdiction: tribal land at the site and military installations within 2 mi, flagging bases on Treasury's CFIUS list for foreign purchases) and location (walkability, tree canopy, climate normals and snow days, solar resource, shale plays, water stress, undersea cable landings, state DOT projects and planned transit where published, electric tariffs, fiber reported in the area and modelled 5G, and the county's power outages and new business applications), measured over the parcel outline where one is published, plus the published zoning (district, FAR, buildable area where the county or city gives them). Sources that did not answer are in missing: unknown, not clear. A screen, not a Phase I.

Price: $0.05 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | Property ID. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `environmental` | ScreenTopic |  |
| `hazards` | ScreenTopic |  |
| `incentives` | ScreenTopic |  |
| `buildability` | ScreenTopic |  |
| `location` | ScreenTopic |  |
| `zoning` | object or null |  |
| `screened_parcel` | boolean |  |
| `sources` | list of object |  |

### Similar properties

```endpoint
GET /v1/properties/{id}/similar
```

Properties of the same use and size band (building area within about 40% when known), nearest first, up to 8. When few are close, the search reaches further (up to 50 km). Charged per property returned.

Price: $1.00 per 1,000 rows.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | Property ID. |
| `radius_m` | query | number | 200 to 50,000 m. Default 5,000. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `properties` | list of PropertySummary |  |
| `criteria` | object |  |


## Find

### Find records

```endpoint
GET /v1/find/{type}
```

One type of record filtered by where clauses, the same grammar as MCP find. Pages are whole: an answer can hold a few rows more than limit, but the charge is at most limit rows, so the extra rows are free. count is free.

Price: $1.00 per 1,000 rows.

| Parameter | In | Type | Description |
|---|---|---|---|
| `type` (required) | path | one of `properties`, `sales`, `permits`, `tax_notices`, `distress_filings`, `recorded_loans`, `cmbs_loans`, `reit_properties`, `sba_loans`, `sba_lenders`, `warn_notices`, `listings`, `facilities`, `establishments`, `government_comps` | One of properties, sales, permits, tax_notices, distress_filings, recorded_loans, cmbs_loans, reit_properties, sba_loans, sba_lenders, warn_notices, listings, facilities, establishments, government_comps. Underbuilt sites are properties with where=building_to_lot_ratio <= 0.5; property activity (building permits) is permits; reit_properties are equity REITs' 10-K Schedule III lines from SEC EDGAR (REIT, property, state, encumbrances, cost, depreciation; not matched to properties); distress_filings are court and lien filings on a parcel (where=kind = foreclosure, foreclosure_registration, sheriff_sale, tax_lien, eviction or probate; filed_on; status = open or any), each property once with its newest filing (filedOn is the filing's date, or a sale's own day, and null where the publisher gives none; amounts differ in meaning by kind and are never totalled), in the counties whose courts or recorders publish them (with no match, filingsCoverage is checked, and filingsLoadedFor then lists where they are loaded in the states searched, or unavailable when the scope names no state or that check did not finish, which is also listed in missing: zero matches is then not evidence that none exist); facilities are schools and health facilities matched to their lots; establishments are named operators at an address from national public registers (where=kind = bank_branch, liquor_license, care_facility, tower, ...), each with the property it matched (a bank_branch row's details.bank_condition is its bank's latest FDIC Call Report: total assets, real-estate loans by type, 30–89 and 90+ days past due, nonaccrual, the noncurrent share this quarter and last, CRE to equity, and the failed banks it acquired; bank-wide figures in dollars, never the branch's); government_comps are San Francisco document comparables near a property ID. |
| `where` | query | list of string | Repeat for each clause, e.g. `where=last_sale_price >= 1000000`. Operators: =, ~, >=, <=, between a and b, in a,b,c, is known, is unknown. |
| `in` | query | string | A place: a city ("Austin, TX"; for properties, a city West Kite holds is searched as its own records, not its whole county, and resolved_scope says which), a city id (place:tx:austin), a county by name ("Travis County, TX", or the name /v1/coverage lists, e.g. "Virginia Beach city, VA"), a county by FIPS (county:48453), a ZIP code, or a neighborhood of New York City or San Francisco ("Upper West Side"). Elsewhere a neighborhood is not a place: send a ZIP code, lat and lng with radius_m, or within. |
| `near` | query | string | A property ID, or longitude,latitude (longitude first). Or send lat and lng instead. |
| `lat` | query | number (from -90 to 90) | Latitude of the point to search around, -90 to 90. Send with lng, instead of near. |
| `lng` | query | number (from -180 to 180) | Longitude of the point to search around, -180 to 180. Send with lat, instead of near. |
| `radius_m` | query | number | Radius around near or lat and lng, 50 to 50,000 m. Default 1609. |
| `sort` | query | string | A field this type sorts on, with - for largest or newest first. GET /v1/fields lists them per type: sales take sale_date or -sale_date in a place (not last_sale_date), and permits take no sort. |
| `limit` | query | integer | Rows in this page, up to 100 (properties and sales in a place in one read; other types up to 50 a read). Default 25. |
| `cursor` | query | string | next_cursor from the previous page. |
| `count` | query | boolean | properties and sales: the number of matches and the statistics of one field (stats, default building_sqft) instead of rows (free). Other types refuse it: page their rows with cursor. |
| `stats` | query | string | With count: the field to summarize. |
| `group_by` | query | string | properties: owner. |

Response:

| data field | Type | Description |
|---|---|---|
| `properties` | list of PropertySummary | Property rows (properties, and beside the property family's own rows). |
| `next_cursor` | string or null | Pass as cursor for the next page, which starts right after this page's last row; null at the end. |
| `has_more` | boolean | Whether more rows match after this page. |
| `resolved_scope` | ResolvedScope |  |
| `establishments` | list of Establishment | type=establishments: one row per named operator at an address. With no kind named, a place search leaves out campground, library, mobile_home_park, oil_gas_well, water_well, water_tower, cannabis_license, vehicle_dealer, contractor, consumer_lender, lottery_retailer, lodging, billboard, water_right, workplace, layoff_notice, federal_contractor, ppp_loan, visa_employer_worksite, motor_carrier, drug_establishment, sales_tax_permit, subsidized_housing: name one with where=kind = <kind>. A search by property_id reads every kind. The largest need a place or a property. ppp_loan, workplace, federal_contractor, motor_carrier, visa_employer_worksite, layoff_notice, drug_establishment have no map point: search them by county, city or property_id, not by radius, ZIP code or neighbourhood. |
| `coverage` | list of EstablishmentCoverage | type=establishments: per kind asked and state in scope, whether a source is loaded. not_covered means no data, not zero. |

### Find records (JSON)

```endpoint
POST /v1/find/{type}
```

The same as GET, as a JSON body, plus within for properties: a GeoJSON Polygon or MultiPolygon (or a Feature holding one) to search inside, instead of in or near. Up to 8 polygons of up to 40 vertices each, outer rings only, longitude first. A within page's next_cursor goes back with the same within.

Price: $1.00 per 1,000 rows.

| Parameter | In | Type | Description |
|---|---|---|---|
| `type` (required) | path | one of `properties`, `sales`, `permits`, `tax_notices`, `distress_filings`, `recorded_loans`, `cmbs_loans`, `reit_properties`, `sba_loans`, `sba_lenders`, `warn_notices`, `listings`, `facilities`, `establishments`, `government_comps` | One of properties, sales, permits, tax_notices, distress_filings, recorded_loans, cmbs_loans, reit_properties, sba_loans, sba_lenders, warn_notices, listings, facilities, establishments, government_comps. Underbuilt sites are properties with where=building_to_lot_ratio <= 0.5; property activity (building permits) is permits; reit_properties are equity REITs' 10-K Schedule III lines from SEC EDGAR (REIT, property, state, encumbrances, cost, depreciation; not matched to properties); distress_filings are court and lien filings on a parcel (where=kind = foreclosure, foreclosure_registration, sheriff_sale, tax_lien, eviction or probate; filed_on; status = open or any), each property once with its newest filing (filedOn is the filing's date, or a sale's own day, and null where the publisher gives none; amounts differ in meaning by kind and are never totalled), in the counties whose courts or recorders publish them (with no match, filingsCoverage is checked, and filingsLoadedFor then lists where they are loaded in the states searched, or unavailable when the scope names no state or that check did not finish, which is also listed in missing: zero matches is then not evidence that none exist); facilities are schools and health facilities matched to their lots; establishments are named operators at an address from national public registers (where=kind = bank_branch, liquor_license, care_facility, tower, ...), each with the property it matched (a bank_branch row's details.bank_condition is its bank's latest FDIC Call Report: total assets, real-estate loans by type, 30–89 and 90+ days past due, nonaccrual, the noncurrent share this quarter and last, CRE to equity, and the failed banks it acquired; bank-wide figures in dollars, never the branch's); government_comps are San Francisco document comparables near a property ID. |

JSON body:

| Body field | Type | Description |
|---|---|---|
| `where` | list of string |  |
| `in` | string |  |
| `near` | string |  |
| `lat` | number (from -90 to 90) |  |
| `lng` | number (from -180 to 180) |  |
| `radius_m` | number |  |
| `sort` | string |  |
| `limit` | integer (to 100) |  |
| `cursor` | string |  |
| `count` | boolean |  |
| `stats` | string |  |
| `group_by` | string |  |
| `max_cost_usd` | number |  |
| `within` | Within |  |

Response:

| data field | Type | Description |
|---|---|---|
| `properties` | list of PropertySummary | Property rows (properties, and beside the property family's own rows). |
| `next_cursor` | string or null | Pass as cursor for the next page, which starts right after this page's last row; null at the end. |
| `has_more` | boolean | Whether more rows match after this page. |
| `resolved_scope` | ResolvedScope |  |
| `establishments` | list of Establishment | type=establishments: one row per named operator at an address. With no kind named, a place search leaves out campground, library, mobile_home_park, oil_gas_well, water_well, water_tower, cannabis_license, vehicle_dealer, contractor, consumer_lender, lottery_retailer, lodging, billboard, water_right, workplace, layoff_notice, federal_contractor, ppp_loan, visa_employer_worksite, motor_carrier, drug_establishment, sales_tax_permit, subsidized_housing: name one with where=kind = <kind>. A search by property_id reads every kind. The largest need a place or a property. ppp_loan, workplace, federal_contractor, motor_carrier, visa_employer_worksite, layoff_notice, drug_establishment have no map point: search them by county, city or property_id, not by radius, ZIP code or neighbourhood. |
| `coverage` | list of EstablishmentCoverage | type=establishments: per kind asked and state in scope, whether a source is loaded. not_covered means no data, not zero. |

### Where fields

```endpoint
GET /v1/fields
```

Every field a where clause on /v1/find takes, per record type: its type (string, number, integer, boolean, date or enum), unit, the operators it takes, its listed values, whether sort takes it, where it comes from and, for properties, the share of served records that carry it (nationwide, or in county). Read from the definitions find validates against: a field not listed is refused, and every operator listed is one find applies to that field. Free.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `type` | query | string | One of properties, sales, permits, tax_notices, distress_filings, recorded_loans, cmbs_loans, reit_properties, sba_loans, sba_lenders, warn_notices, listings, facilities, establishments, government_comps. Default: every type. |
| `county` | query | string | Coverage for one county: a five-digit FIPS code, county:<FIPS>, or a name with its state ("Travis County, TX"). Default: every county West Kite serves. |

Response:

| data field | Type | Description |
|---|---|---|
| `types` (required) | list of FieldCatalogType |  |
| `operators` (required) | list of string |  |
| `grammar` (required) | string |  |
| `coverage_scope` (required) | string |  |

### Export properties as CSV or NDJSON

```endpoint
POST /v1/exports
```

Every property matching where in a market, up to 100,000 rows, as a signed file link with the exact total and sources. format csv (default) is a header row then one row per property; ndjson is one JSON object per line with the same columns as keys (file.columns), numbers as numbers and an unstated value as null. Charged when prepared for the rows the file holds; the balance, max_cost_usd, max_rows or the key's spend cap size the file. The link works for 24 hours and stops when the key is revoked.

Price: $1.00 per 1,000 rows.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `type` | `properties` |  |
| `where` | list of string |  |
| `in` | string |  |
| `within` | Within |  |
| `format` | one of `csv`, `ndjson` |  |
| `max_rows` | integer (to 100000) |  |
| `max_cost_usd` | number |  |

Response:

| data field | Type | Description |
|---|---|---|
| `status` | one of `ready`, `empty` |  |
| `total` | integer |  |
| `scope` | string |  |
| `resolved_scope` | ResolvedScope |  |
| `file` | object or null |  |
| `rows_left_out` | integer |  |
| `limit_note` | string |  |
| `sources` | list of object |  |
| `preview` | list of object |  |

### Download an export

```endpoint
GET /v1/exports/download/{file}
```

The file link from POST /exports; it carries its own token.

Price: Free (charged when prepared). No key needed.

| Parameter | In | Type | Description |
|---|---|---|---|
| `file` (required) | path | string | File name. |
| `token` (required) | query | string | From the link. |


## Places

### Anything nearby

```endpoint
GET /v1/nearby
```

Every infrastructure kind and brands near a property or point, nearest first with straight-line distance and source. The domains also have their own endpoints: /power, /transport, /utilities and /brands. Asking for any power kind charges the power report's price. Each source is searched to its own distance (substations 10 mi, power plants 15 mi, ports 100 mi…): searched says how far, and radius_m only narrows it.

Price: $0.01 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `kinds` | query | list of one of `substations`, `transmission_lines`, `power_plants`, `electric_utilities`, `power_capacity`, `interconnection_queues`, `gas_pipelines`, `gas_utilities`, `water_systems`, `sewer_service`, `wastewater_plants`, `local_roads`, `highways`, `interstates`, `highway_ramps`, `truck_routes`, `rail_lines`, `rail_sidings`, `rail_crossings`, `intermodal_terminals`, `airports`, `ports`, `obstructions`, `elevation`, `brands` | Comma-separated: substations, transmission_lines, power_plants, electric_utilities, power_capacity, interconnection_queues, gas_pipelines, gas_utilities, water_systems, sewer_service, wastewater_plants, local_roads, highways, interstates, highway_ramps, truck_routes, rail_lines, rail_sidings, rail_crossings, intermodal_terminals, airports, ports, obstructions, elevation, brands. Default interstates,highways,rail_lines,airports,ports,gas_pipelines,water_systems. |
| `radius_m` | query | number | The radius read, up to 8047 m (default 1609). |
| `limit` | query | integer | Features per kind, 1 to 50. Default 10. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `point` | object |  |
| `features` | list of NearbyFeature |  |
| `searched` | list of object |  |
| `headlines` | object |  |
| `brands` | object or null |  |
| `sources` | list of object |  |

### Power report

```endpoint
GET /v1/power
```

Power for a site: power plants (operating, planned and retiring capacity, from EIA-860M), substations (voltage, operator, generation queued to connect there), transmission lines (voltage), the electric utilities serving the point (commercial and industrial rates, reliability), the county's interconnection queue (interconnection_queues, from Berkeley Lab), and published hosting or load capacity where the utility maps it (power_capacity). Each with straight-line distance and source; substations are searched to 10 mi, lines to 5 mi, plants to 15 mi.

Price: $0.05 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `kinds` | query | list of one of `power_plants`, `substations`, `transmission_lines`, `electric_utilities`, `power_capacity`, `interconnection_queues` | Comma-separated: power_plants, substations, transmission_lines, electric_utilities, power_capacity, interconnection_queues. Default power_plants,substations,transmission_lines,electric_utilities,power_capacity,interconnection_queues. |
| `radius_m` | query | number | Keep features within this many meters (50 to 200,000); never wider than each source is searched. |
| `limit` | query | integer | Features per kind, 1 to 50. Default 10. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `point` | object |  |
| `features` | list of NearbyFeature |  |
| `searched` | list of object |  |
| `headlines` | object |  |
| `brands` | object or null |  |
| `sources` | list of object |  |

### Transport

```endpoint
GET /v1/transport
```

Interstates, highways and their ramps, truck routes, local roads, rail lines, rail sidings (sidings, industry track and yards: where a railroad can set out cars), highway-rail crossings (FRA inventory: position, trains a day, timetable speed, road traffic), intermodal terminals, airports, ports and tall structures filed in the FAA Digital Obstacle File (height above ground and sea level) near a site, nearest first with straight-line distance and source. Sidings are searched to 3 mi, crossings to 1 mi and tall structures to 2 mi.

Price: $0.01 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `kinds` | query | list of one of `interstates`, `highways`, `highway_ramps`, `truck_routes`, `local_roads`, `rail_lines`, `rail_sidings`, `rail_crossings`, `intermodal_terminals`, `airports`, `ports`, `obstructions` | Comma-separated: interstates, highways, highway_ramps, truck_routes, local_roads, rail_lines, rail_sidings, rail_crossings, intermodal_terminals, airports, ports, obstructions. Default interstates,highways,highway_ramps,truck_routes,local_roads,rail_lines,rail_sidings,rail_crossings,intermodal_terminals,airports,ports,obstructions. |
| `radius_m` | query | number | Keep features within this many meters (50 to 200,000); never wider than each source is searched. |
| `limit` | query | integer | Features per kind, 1 to 50. Default 10. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `point` | object |  |
| `features` | list of NearbyFeature |  |
| `searched` | list of object |  |
| `headlines` | object |  |
| `brands` | object or null |  |
| `sources` | list of object |  |

### Utilities

```endpoint
GET /v1/utilities
```

Public water systems, sewer service areas and wastewater plants, gas transmission pipelines and gas utilities near a site. A service area at 0 m covers the point; its provider confirms service to the parcel.

Price: $0.01 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `kinds` | query | list of one of `water_systems`, `sewer_service`, `wastewater_plants`, `gas_pipelines`, `gas_utilities` | Comma-separated: water_systems, sewer_service, wastewater_plants, gas_pipelines, gas_utilities. Default water_systems,sewer_service,wastewater_plants,gas_pipelines,gas_utilities. |
| `radius_m` | query | number | Keep features within this many meters (50 to 200,000); never wider than each source is searched. |
| `limit` | query | integer | Features per kind, 1 to 50. Default 10. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `point` | object |  |
| `features` | list of NearbyFeature |  |
| `searched` | list of object |  |
| `headlines` | object |  |
| `brands` | object or null |  |
| `sources` | list of object |  |

### Brands nearby

```endpoint
GET /v1/brands
```

National and regional chains and the tenant mix within radius_m (up to 8047 m, default 1609) of a property or point, from stored Overture Maps places (CDLA Permissive 2.0) where West Kite stores them; elsewhere missing says not_covered. Live Google Maps listings stay in the app (Google's terms keep them on Google's map).

Price: $0.01 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `radius_m` | query | number | The radius read, up to 8047 m (default 1609). |
| `limit` | query | integer | Features per kind, 1 to 50. Default 10. |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `point` | object |  |
| `features` | list of NearbyFeature |  |
| `searched` | list of object |  |
| `headlines` | object |  |
| `brands` | object or null |  |
| `sources` | list of object |  |

### Demographics report

```endpoint
GET /v1/demographics
```

People and economy for a named area (area) or a ring around a property or point (property_id or lat and lng, with radius_m): Census ACS population, households, income, age, rent, home values, tenure and commuting with a trend; BLS jobs, industries, wages and unemployment; LODES workplace jobs; HMDA home-purchase loans; permits, house prices, population change and the mortgage rate. rents are HUD Fair Market Rents by bedroom count: a ZIP code takes its Small Area FMR, and a ring around a property or point takes the Small Area FMR of the ZIP code at its centre (the site's own), else its county's. Each section names its scope (the area, or the counties that stand in for it) and year; sections that could not be filled are in missing. Distribution rows over a numeric range carry low (inclusive) and high (exclusive) beside the label; a null bound is an open end, and category lists (commute mode, industries, mobility) have neither.

Price: $0.05 per call.

| Parameter | In | Type | Description |
|---|---|---|---|
| `area` | query | string | state-06, metro-12420, county-48453, place-0644000 or zip-94105. GET /demographics/areas finds one. |
| `property_id` | query | string | A property ID, for a ring around it. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `radius_m` | query | number | Ring radius, 100 to 16093 m. Default 1609 (one mile). |
| `max_cost_usd` | query | number | Refuse the call if it costs more. |

Response:

| data field | Type | Description |
|---|---|---|
| `area` | object |  |
| `acs` | object or null |  |
| `jobs` | object or null |  |
| `workplace` | object or null |  |
| `home_buying` | object or null |  |
| `sources` | list of object |  |

### Zoning district

```endpoint
GET /v1/zoning
```

The zoning district at a property or a point, from West Kite's national zoning map: the city or county's own published zone code and name, a broad class read from them (residential, multifamily, commercial, office, mixed, industrial, agricultural, open, public, planned, other), the jurisdiction, and the published layer it comes from. 5,139 cities and counties in 50 states and DC are on the map. Where the map does not cover a place yet, district is null and missing says not_covered; a property's zoning code from the assessor roll is still in GET /properties/{id}?parts=zoning. A reading of the published map, not a zoning determination: overlays, conditions and recent rezonings are not included. Free.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `property_id` | query | string | A property ID. Or send lat and lng. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |

Response:

| data field | Type | Description |
|---|---|---|
| `id` | string |  |
| `coordinates` (required) | object |  |
| `district` (required) | MapZoningDistrict or object or null |  |
| `other_districts` | list of MapZoningDistrict | Present only where the jurisdiction's own layer overlaps itself at the point. |
| `note` (required) | string |  |

### Area layers

```endpoint
GET /v1/layers
```

Every area layer GET /layers/{layer} reads: what it is, its geometry, default radius, coverage, publisher, vintage and terms. The same layers are the map's Site data layers and feed the site report. Free.

Price: Free.

Response:

| data field | Type | Description |
|---|---|---|
| `layers` (required) | list of object |  |

### Area layer by point or area

```endpoint
GET /v1/layers/{layer}
```

One shape for every area layer (dams: Dams in the USACE National Inventory of Dams. hazard_potential is what a failure would cost downstream (High: probable loss of life), not the dam's condition; condition is the state's own assessment where it publishes one. lomr: FEMA Letters of Map Revision in effect: areas whose flood zones FEMA revised after the printed map. effective_on is when the revision took effect; case_number finds the letter at FEMA's Map Service Center. loma: FEMA Letters of Map Amendment and related determinations for single lots and structures. outcome says whether FEMA removed the property or structure from the special flood hazard area; a LOMA is tied to the lot it names, so a nearby letter is evidence, not a ruling for another lot. drought: This week's US Drought Monitor map: category D0 (abnormally dry) to D4 (exceptional drought), with the week it describes. The categories nest, so a point in D2 is also inside the D0 and D1 areas; the API returns each and the report takes the most severe. hail: Severe hail reports in NOAA's Storm Prediction Center database since 1955: the date, local time (CST), state and hailstone size in inches. Reports are observations where someone saw and reported hail, so they cluster near towns and roads; a place with none may still have been hit. hail-swaths: Radar-estimated maximum hail size by UTC day, 2020-10-14 to 2026-11-21, on MRMS's 0.01 degree grid (about 1 km): hits of 1 in and up with their dates (hits), largest_in and largest_date, days_1in_and_up, days_clear and days_unknown. An estimate filtered by lightning (Wendt and Jirak 2021, Weather and Forecasting 36, section 3a: kept only within 40 km of a cloud-to-ground flash in that hour), never damage. It reads high on some days, reads low for the largest stones because values over 5 in are removed, and can't tell a radar dropout from no hail. days_clear are days read in full with no radar-estimated hail of 1 in or more on record; a removed value or a missing hour is days_unknown, never no hail. A point answers its own cell; a radius or bbox answers only cells with a hit. No swaths are held before October 2020, and NOAA's radar series has a gap from January 2012 to mid-August 2019. Known residue: four cells near Peterborough, Ontario (44.555,-78.195; 44.545,-78.175; 44.575,-78.225; 44.585,-78.245) keep 29 hit days that look like a radio emitter passing the filter. disaster-declarations: Federal disaster declarations for the county under the point since 2000, from OpenFEMA's Disaster Declarations Summaries: each declaration's number, type (major disaster, emergency, fire management), incident type, title and date. Statewide declarations that name no county are not included. Updated daily. This product uses the OpenFEMA API but is not endorsed by FEMA. flood-claims: National Flood Insurance Program claims by county and year of loss from OpenFEMA (redacted: no addresses), with the amount paid (building, contents and increased cost of compliance). Claims count insured losses only, so places with little flood insurance show fewer. This product uses OpenFEMA data but is not endorsed by FEMA. nonattainment: EPA Green Book areas that do not meet, or recently met and are maintaining, a national air quality standard, one row per pollutant and standard. classification is the severity EPA assigned (for ozone: marginal to extreme). air-monitors: EPA AirNow monitoring sites with their latest hourly readings: the AQI for ozone, PM2.5 and PM10 where the site measures them, the reading time and the agency that runs it. Readings are preliminary and change hourly; EPA's AQS holds the certified record. energy-community: Areas that qualify as IRA energy communities for the clean energy bonus credit, from DOE NETL's 2024 maps: coal closure census tracts (kind coal) and statistical areas meeting the fossil fuel employment test (kind employment). Treasury's notices are the legal list; DOE says the maps may not be relied on for a tax position. foreign-trade-zones: Foreign trade zones from the FTZ Board's OFIS list (as of March 2024): zone number, grantee, port of entry and the counties the zone serves. The point marks the grantee's city, not site boundaries; a business inside a zone's service area can apply for a usage-driven site. ftz-sites: Foreign trade zone and subzone sites from the FTZ Board's OFIS site pages: zone, grantee, site name, type, status, acres and address. Points are the Board's coordinates where it publishes them (address_match published), otherwise geocoded from the street address (location_approximate, address_match), not site boundaries. Absent: sites OFIS shows as ended, unactivated ASF sites past their sunset, and sites that could not be placed. A listed site is not proof of authority: sunset_passed marks a past sunset date that use may have extended. Credit the FTZ Board / ITA. critical-habitat: Final critical habitat designated by the US Fish & Wildlife Service. A federal permit, loan or grant for work inside triggers consultation under the Endangered Species Act; the Federal Register rule (federal_register) is the legal boundary. airspace: FAA Class B, C and D airspace and Class E surface areas. floor_ft and ceiling_ft are the published limits (MSL unless the unit says AGL; ceiling -9998 means unlimited). Tall structures near airports also need an FAA Form 7460-1 review under Part 77, which this layer does not decide. uas-grid: FAA UAS Facility Map grid cells near controlled airports: the highest altitude (ceiling_ft, above ground) to which drone flights can be authorized automatically through LAANC. No cell means no facility map there, not unrestricted airspace. karst: USGS's national karst map (Weary and Doctor 2014): areas underlain by soluble rock (carbonates, evaporites) or by pseudokarst, where sinkholes, caves and sudden ground collapse are possible. karst_type is the map unit; a site inside one needs a geotechnical investigation, not a refusal. radon: EPA's map of radon zones by county: zone 1 has the highest predicted average indoor radon (over 4 pCi/L), zone 3 the lowest. A county-level prediction; only a test measures a building. county_fips is today's county and published_county_fips is EPA's 1993 code: where that county has no single successor (Connecticut, two in Alaska) county_fips is null. airport-noise: Airport noise contours (Part 150 noise exposure maps and land-use plans) where the airport, county or city publishes them as GIS: LAX and the Los Angeles County airports, Dallas Love Field, Houston, Sacramento-region airports, SFO, King County, Portland, Dulles and Leesburg. db is the contour level (DNL, or CNEL in California). Elsewhere the read names the nearest airport on FAA's Part 150 list and says no contour is published as GIS; BTS aviation noise is the national fallback. rail-lines: The FRA's North American Rail Network lines via USDOT NTAD: owner, trackage rights, network type (main line, major or minor industrial lead, passing siding, yard), main line track count, passenger service and strategic (STRACNET) flag. Abandoned, removed and out-of-service lines, trails on former right-of-way and ferries are left out. Track class is not published in this layer. gas-pipelines: Interstate and intrastate natural gas pipelines from EIA, with operator and status. Approximate routes: PHMSA's National Pipeline Mapping System is the regulator's record and is not published for queries; hazardous liquid lines have no public map here. dot-projects: Projects in state DOT programs (STIP, five- or six-year programs, capital and highway plans) from 20 states that publish them as GIS, as project id, name, description, year, status and cost_usd (null where the state does not state a unit) or cost_range. Finished, cancelled and off-program projects are left out where the state marks them. The state's own program document is the authority. planned-transit: Planned transit lines and stations where an agency or city publishes them as GIS: Charlotte's LYNX Silver Line and the corridors LA Metro listed as planned in October 2023. FTA's Capital Investment Grants pipeline is not published as GIS. pipeline-miles: Active transmission pipeline miles in each county from PHMSA's National Pipeline Mapping System summary: gas transmission and hazardous liquid. PHMSA does not publish the pipeline routes for queries; the gas pipelines layer (EIA) shows approximate gas routes. walkability: EPA's National Walkability Index by census block group (1 to 20): street intersection density, transit proximity and the mix of jobs and housing, ranked nationally. EPA's bands: least walkable up to 5.75, below average to 10.5, above average to 15.25, most walkable above. climate: NOAA's 1991–2020 climate normals at weather stations: annual average, high and low temperature (°F), precipitation and snowfall (inches), snow_days (days a year with 1 inch or more of snowfall), snow_cover_days (days with 1 inch or more on the ground), and heating and cooling degree days. 30-year averages, not forecasts. business-formation: Census Business Formation Statistics by county: applications for a new employer identification number (EIN) each year since 2005, a leading sign of new businesses. Census publishes county figures yearly; weekly and monthly figures exist only for states and the nation. power-outages: Power outages by county from ORNL's EAGLE-I, which records customers out every 15 minutes from utility outage maps: hours without power per customer each year (customer-hours out divided by the customers EAGLE-I counts), and the largest share of customers out at once, from 2018. A year is null where EAGLE-I covered under half the state's customers: unknown, not calm. EAGLE-I by Oak Ridge National Laboratory, CC BY 4.0. cables-telegeography: Undersea telecom cables and their landing points worldwide from TeleGeography's Submarine Cable Map, shared under CC BY-SA 4.0: kept as its own layer, credited, and not merged into other records. Cables carry their owners, length and ready-for-service year. cables-noaa: Submarine cables charted by NOAA in US waters (Marine Cadastre, February 2025, public domain), with the cable system, owner and status. Charted cables include power and telecom; landing points are in the TeleGeography layer. shale-plays: EIA's tight oil and shale gas plays in the lower 48 states, with the basin, the rock and its geologic age. Mineral rights and leasing are not in this layer. water-stress: WRI Aqueduct 4.0 baseline water stress by river sub-basin: the share of the renewable water supply that is withdrawn each year. Also drought risk and riverine flood risk labels for the same basin. Aqueduct by the World Resources Institute, CC BY 4.0. broadband-fiber: Fiber to the premises as internet providers reported it to the FCC (Broadband Data Collection, June 30 2026), by hexagon of about 0.74 km2 (h3, resolution 8): provider_count, the highest advertised max_down_mbps and max_up_mbps, whether any reports business service (business_service), and providers with each one's own figures. It means reported in this area, never at one building; no feature means none reported, not proof of no service. Uses FCC data and is not endorsed by the FCC. mobile-5g: 5G-NR coverage as mobile providers modelled it for the FCC (Broadband Data Collection, June 30 2026), all providers together, from hexagons of about 0.1 km2: outdoor_7_1 and outdoor_35_3 (at least that many Mbps down/up, stationary outdoors) and vehicle_7_1 (in a moving vehicle). 35/3 in a vehicle is not in the FCC's file, so it is not served. A model, not a measurement, and nothing about indoor reception; no feature means none modelled, not proof of no service. Features are patches of hexagons with the same values, so count is not a count of sites. Uses FCC data and is not endorsed by the FCC. seismic: The seismic design category and design accelerations at a point from the USGS ASCE 7-22 web service, for risk category II on site class D (stiff soil, the code default when soil is not tested): sdc runs A (lowest) to F, sds and sd1 are the short- and one-second design spectral accelerations in g. The map shows USGS's 2014 peak ground acceleration hazard (2% in 50 years). landslide: USGS's national landslide susceptibility map, drawn as map tiles. The publisher's tiles carry no values, so a point read is not offered yet; the 2024 USGS data release (10.5066/P13KAGU3) is the source of record. tree-canopy: NLCD tree canopy cover (USDA Forest Service via MRLC), 30 m: canopy_percent is the share of the 30 m cell under tree canopy, 2021. cropland: USDA NASS Cropland Data Layer (2025, 30 m), drawn as map tiles from NASS's CropScape service: the crop or land cover grown in each field that season, in NASS's own colours. Display only for now: CropScape's point-value service is down, so values are not read at a point. greenness: MODIS Terra 8-day NDVI (vegetation greenness) from NASA GIBS, drawn as map tiles. Display only: the imagery carries colours, not values. night-lights: NASA Black Marble night lights from VIIRS (2016 composite) via NASA GIBS, drawn as map tiles: a proxy for development and light pollution. Display only. solar-resource: Average daily solar resource at the point from NLR's (formerly NREL's) National Solar Radiation Database: global horizontal (ghi), direct normal (dni) and latitude-tilt irradiance in kWh per square metre per day, annual and by month. Long-term averages, not a production estimate. noise: Road, rail and aviation noise combined from the BTS National Transportation Noise Map (2022 aviation and rail, 2023 road; 24-hour equivalent level, LAeq, 30 m), in 5 dBA bands from 45 dBA. Modelled for national trends, not a measurement at a site; FAA Part 150 contours, where an airport publishes them, are the airport's own study. noise-aviation: Aviation noise from the BTS National Transportation Noise Map (2022), drawn from BTS's own map tiles: the national fallback where no airport publishes Part 150 contours. Display only; the combined noise layer gives a value at a point. noise-road: Road noise from the BTS National Transportation Noise Map (2023), drawn from BTS's own map tiles. Display only. noise-rail: Rail noise from the BTS National Transportation Noise Map (2022), drawn from BTS's own map tiles. Display only. utility-rates: Commercial and industrial electric tariffs in force from the OpenEI Utility Rate Database for the utility whose retail territory covers the point (HIFLD territories, EIA utility id): each tariff's name, sector, start date, fixed charge ($/month), first energy rate ($/kWh) and first demand rate ($/kW), with the URDB page and the utility's own source. URDB is crowd-maintained, so check a tariff against the utility before relying on it. CC0.) Send a point (property_id, or lat and lng) for the features that cover it (distance_m 0) or lie within radius_m of it, nearest first; or bbox for the features inside a box. Each feature is the layer's own record plus geometry_type, and lat and lng for point features; geometry=true adds each feature's shape as GeoJSON, to draw it on a map. A raster layer answers a point with one feature (geometry_type Raster) holding its value there; one that is map imagery only says not_published. count is every feature found and more_available says limit cut the list. A publisher that did not answer is in missing as temporarily_unavailable: unknown, never none. Free.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `layer` (required) | path | one of `dams`, `lomr`, `loma`, `drought`, `hail`, `hail-swaths`, `disaster-declarations`, `flood-claims`, `nonattainment`, `air-monitors`, `energy-community`, `foreign-trade-zones`, `ftz-sites`, `critical-habitat`, `airspace`, `uas-grid`, `karst`, `radon`, `airport-noise`, `rail-lines`, `gas-pipelines`, `dot-projects`, `planned-transit`, `pipeline-miles`, `walkability`, `climate`, `business-formation`, `power-outages`, `cables-telegeography`, `cables-noaa`, `shale-plays`, `water-stress`, `broadband-fiber`, `mobile-5g`, `seismic`, `landslide`, `tree-canopy`, `cropland`, `greenness`, `night-lights`, `solar-resource`, `noise`, `noise-aviation`, `noise-road`, `noise-rail`, `utility-rates` | An area layer id from GET /layers. |
| `property_id` | query | string | A property ID. Or send lat and lng, or bbox. |
| `lat` | query | number | Latitude. |
| `lng` | query | number | Longitude. |
| `geometry` | query | boolean | true adds each feature's GeoJSON geometry (coordinates to six places). Default false. |
| `radius_m` | query | number | Search radius around the point, 0 to 16000 m. Default: the layer's default_radius_m. 0 returns only features covering the point. A radius that holds more features than one read takes (about 2,000 for live layers) answers invalid_request: send a smaller one, or bbox. |
| `bbox` | query | string | west,south,east,north in decimal degrees, at most 0.5 degrees each way. Instead of a point. |
| `limit` | query | integer | Features returned, 1 to 500. Default 100. |

Response:

| data field | Type | Description |
|---|---|---|
| `layer` (required) | one of `dams`, `lomr`, `loma`, `drought`, `hail`, `hail-swaths`, `disaster-declarations`, `flood-claims`, `nonattainment`, `air-monitors`, `energy-community`, `foreign-trade-zones`, `ftz-sites`, `critical-habitat`, `airspace`, `uas-grid`, `karst`, `radon`, `airport-noise`, `rail-lines`, `gas-pipelines`, `dot-projects`, `planned-transit`, `pipeline-miles`, `walkability`, `climate`, `business-formation`, `power-outages`, `cables-telegeography`, `cables-noaa`, `shale-plays`, `water-stress`, `broadband-fiber`, `mobile-5g`, `seismic`, `landslide`, `tree-canopy`, `cropland`, `greenness`, `night-lights`, `solar-resource`, `noise`, `noise-aviation`, `noise-road`, `noise-rail`, `utility-rates` |  |
| `label` | string |  |
| `source` | object or null |  |
| `id` | string |  |
| `coordinates` | object |  |
| `radius_m` | number |  |
| `bbox` | list of number |  |
| `count` | integer or null |  |
| `more_available` | boolean |  |
| `features` (required) | list of object |  |

### Find a demographics area

```endpoint
GET /v1/demographics/areas
```

A state, metro, county, city or ZIP code by name, with the area id GET /demographics takes.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `q` (required) | query | string | A name, e.g. Austin or 78704. |

Response:

| data field | Type | Description |
|---|---|---|
| `areas` | list of object |  |


## Markets

### Market series

```endpoint
GET /v1/markets
```

Published market series, one row per period, as MCP find market. Each metric has its own period, fixed by its source: snapshot: records-properties, records-market-value, records-building-size, development-pipeline, pipeline-housing-units, pipeline-commercial-sf; annual: records-sales, records-sale-price, records-year-built, housing-completions, employment, establishments, weekly-wage, population, housing-stock, jobs-construction, jobs-manufacturing, jobs-retail, jobs-logistics, jobs-information, jobs-professional, jobs-healthcare, jobs-hospitality, cbp-employment, cbp-establishments, workplace-jobs, commercial-vacancy-filings, commercial-space-filings; quarterly: recorded-transfers, deal-count, sales-volume, sales-volume-12mo, average-sale-price, price-per-sf, inventory; monthly: bart-activity, bart-exits. range sets how far back the rows go, not their period. Every answer names its areas (areas, with the subject first) and each metric's unit and frequency (metrics), and each series row carries area_label and frequency. Unsupported periods come back missing, never zero. The place is area (market area ids); in is not taken here and answers 400.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `in` | query | string | The subject place as find takes it: "Travis County, TX", county:48453, a state (TX), or a market area id. area then lists the comparisons. |
| `metric` (required) | query | list of one of `records-properties`, `records-sales`, `records-sale-price`, `records-market-value`, `records-building-size`, `records-year-built`, `recorded-transfers`, `deal-count`, `sales-volume`, `sales-volume-12mo`, `average-sale-price`, `price-per-sf`, `inventory`, `development-pipeline`, `pipeline-housing-units`, `pipeline-commercial-sf`, `housing-completions`, `employment`, `establishments`, `weekly-wage`, `population`, `housing-stock`, `jobs-construction`, `jobs-manufacturing`, `jobs-retail`, `jobs-logistics`, `jobs-information`, `jobs-professional`, `jobs-healthcare`, `jobs-hospitality`, `cbp-employment`, `cbp-establishments`, `workplace-jobs`, `bart-activity`, `bart-exits`, `commercial-vacancy-filings`, `commercial-space-filings` | Comma-separated metric ids (up to 12), e.g. sales-volume,deal-count,price-per-sf. One of records-properties, records-sales, records-sale-price, records-market-value, records-building-size, records-year-built, recorded-transfers, deal-count, sales-volume, sales-volume-12mo, average-sale-price, price-per-sf, inventory, development-pipeline, pipeline-housing-units, pipeline-commercial-sf, housing-completions, employment, establishments, weekly-wage, population, housing-stock, jobs-construction, jobs-manufacturing, jobs-retail, jobs-logistics, jobs-information, jobs-professional, jobs-healthcare, jobs-hospitality, cbp-employment, cbp-establishments, workplace-jobs, bart-activity, bart-exits, commercial-vacancy-filings, commercial-space-filings. |
| `area` | query | string | Comma-separated market area ids; the first is the subject, up to two more compare. Market series cover California today: san-francisco and the market catalog's ids. county-<5-digit FIPS> and state-<2-digit FIPS> ids are accepted elsewhere and answer unavailable until their series are published. Default san-francisco. |
| `property_type` | query | one of `all`, `office`, `retail`, `industrial`, `multifamily`, `hospitality` | all, office, retail, industrial, multifamily, hospitality. Default all. Quarterly sales metrics take retail, office or industrial. |
| `range` | query | one of `1y`, `3y`, `5y`, `10y`, `all` | How far back: 1y, 3y, 5y, 10y, all (1, 3, 5 or 10 years, or everything published). Default 5y. |

Response:

| data field | Type | Description |
|---|---|---|
| `areas` | list of object |  |
| `metrics` | list of object |  |
| `series` | list of object |  |


## Account

### Sign up from an agent (no key)

```endpoint
POST /v1/agent-signup
```

Gets the person you work for an API key, with no key of your own. Send their email; show them verification_uri and user_code (West Kite never emails the code). They open the link, sign in or sign up with the email filled in, check the code matches and approve. Keep claim_token to yourself and poll POST /agent-signup/token every interval seconds until expires_in (600 s) runs out. verification_uri carries the email after # so the sign-in form is filled in; show it as given. At most 5 open sign-ups per email; on 429, stop and tell the person.

Price: Free. No key needed.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `email` (required) | string | The person's email. |
| `key_name` | string | The new key's name on the dashboard. |
| `client_name` | string | Your name, shown to the person ("Claude Code wants an API key"). |

### Collect the agent's key

```endpoint
POST /v1/agent-signup/token
```

One poll of a sign-up. Every answer while it is not done is 200 with status: pending (keep polling), slow_down (polled faster than interval: add 5 s to your interval), expired (start again) or denied (the person said no; stop). approved carries the key, exactly once: keep it, it is not shown again here (it stays on the dashboard). A claim_token that is unknown or already collected is 400 invalid_request.

Price: Free. No key needed.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `claim_token` (required) | string |  |

### Balance

```endpoint
GET /v1/balance
```

The team's plan and balance.

Price: Free.

Response:

| data field | Type | Description |
|---|---|---|
| `plan` | one of `free`, `starter`, `growth`, `pro` |  |
| `balance_usd` | number |  |
| `available_usd` | number |  |
| `included_resets_at` | string or null |  |
| `limits` | Limits |  |
| `key` | object |  |

### Usage

```endpoint
GET /v1/usage
```

Calls and charges per day and by operation.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `days` | query | integer | 1 to 30. Default 7. |


## Research

### The team's research runs

```endpoint
GET /v1/research
```

Every run, newest first, with the same status as GET /research/{id}: queued runs say their place in the queue, running ones their stage, what they are doing and about how long is left. open counts the team's queued and running runs.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `status` | query | string | queued, running, complete or failed. |
| `limit` | query | integer | 1 to 100 (default 25). |
| `cursor` | query | string | next_cursor from the previous page. |

Response:

| data field | Type | Description |
|---|---|---|
| `runs` | list of ResearchRun |  |
| `open` | object |  |
| `next_cursor` | string or null |  |

### Research owners

```endpoint
POST /v1/research
```

Background research into who owns and runs each property (1 to 100). Answers 202 with run ids at once. A run usually takes about 5 minutes; the team runs its plan's research_concurrent at once and queues the rest (they never fail for it). Each run's status_url shows its stage and about how long is left. Each run holds $0.10; a run that names no person costs nothing. Unattended: the key's spend cap stands in for an approval. With webhook_url, each run's status is POSTed there when it finishes (complete, no person, or failed): the body is { event: "research.finished", data, missing }, data and missing as GET /research/{id} answers them, signed in the West-Kite-Signature header as t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>"> keyed by the lowercase hex SHA-256 of the API key that asked (as text). West-Kite-Delivery is the run id. A 2xx answer within 10 s is a delivery; otherwise West Kite retries after 1, 5, 30, 120 and 360 minutes. Redirects are not followed.

Price: $0.10 per property.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `property_ids` (required) | list of string |  |
| `webhook_url` | string | An https:// URL on a public host (no credentials in it) to POST each finished run to. |

Response:

| data field | Type | Description |
|---|---|---|
| `runs` | list of ResearchRun |  |
| `webhook_url` | string |  |

### A research run

```endpoint
GET /v1/research/{id}
```

Status and, once complete, the people and companies found, without person contacts. While open, progress says the stage, what it is doing, sources read, people found, elapsed time and about how long is left, and poll_after_seconds when to look again. wait holds the request up to 60 s for the run to finish. Free, and never refused for the team's requests in flight.

Price: Free.

| Parameter | In | Type | Description |
|---|---|---|---|
| `id` (required) | path | string | Run id. |
| `wait` | query | integer | Seconds, up to 60. |

`data` is a `ResearchRun`; its fields are in the OpenAPI document.

### Reveal a contact

```endpoint
POST /v1/contacts
```

A person's email, phone or LinkedIn from a research result, or channel all for the full contact: all three in one call, answered as email, phone and linkedin (null where none was found). A lookup that finds nothing costs nothing; fetching the same contact again is free for a year, and a full contact never costs more than its price however its channels were bought.

Price: Email $0.50, phone $1.00, LinkedIn $0.50; all: $1.00 with a phone, $0.50 without.

JSON body:

| Body field | Type | Description |
|---|---|---|
| `person_id` (required) | string |  |
| `channel` (required) | one of `email`, `phone`, `linkedin`, `all` |  |


## Find types and fields

What `where` takes for each type of [GET /v1/find/{type}](https://westkite.com/docs/api/find.md). [GET /v1/fields](https://westkite.com/docs/api/fields.md) returns the same list as data, with each field's coverage.

### properties

Properties (parcels and buildings) by location, type, size, sale, value, zoning, owner and site facts.

Source: County assessor rolls and recorder records as each county publishes them; site facts measured by West Kite over the parcel outline.

Sorts: `updated_at`, `held_years`, `market_value`, `assessed_value`, `last_sale_price`, `building_sqft`, `lot_sqft`, `year_built`, `last_sale_date`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `property_type` | enum | `=` `!=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` | != leaves one type out |
| `owner_type` | enum | `=` `!=` | `government`, `nonprofit`, `llc`, `corporation`, `trust`, `estate`, `individual` | Leaves one class out; repeat for several |
| `owner` | string | `=` `~` |  | (owner of record contains) or = (a company with its affiliated entities, e.g. Blackstone; needs in) |
| `last_sale_date` | date | `=` `>=` `<=` `between` `is known` `is unknown` |  | YYYY-MM-DD |
| `building_to_lot_ratio` | number, ratio | `<=` |  | Building area over lot area, for underbuilt sites (0.5 is a common screen) |
| `public_owners` | boolean | `=` |  | = false leaves out government, housing-authority, religious, cemetery, university and hospital owners and civic buildings (default: every owner, as count and export) |
| `building_sqft` | number, sqft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `lot_sqft` | number, sqft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `year_built` | integer, year | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `held_years` | integer, years | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `last_sale_price` | number, usd | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `zoning` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `signal` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `market_value` | number, usd | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `assessed_value` | number, usd | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `tax_amount` | number, usd | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `units` | integer, units | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `stories` | number, stories | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `bedrooms` | number | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `bathrooms` | number | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `flood_zone` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `subtype` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `street` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `buildable_sqft` | number, sqft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `unused_buildable_sqft` | number, sqft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_land` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_parking_spaces` | integer, spaces | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_loading_docks` | integer, docks | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_building_pct` | number, percent | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_vegetation_pct` | number, percent | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_roof` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `aerial_feature` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `wetland_pct` | number, percent | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `floodplain_pct` | number, percent | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `upland_acres` | number, acres | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `largest_upland_acres` | number, acres | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `road_frontage_ft` | number, ft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `water_frontage_ft` | number, ft | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `site_access` | enum | `=` `~` `>=` `<=` `between` `is known` `is unknown` | `landlocked`, `road access` |  |
| `waterfront` | string | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `owner_occupied` | boolean | `=` `~` `>=` `<=` `between` `is known` `is unknown` |  |  |
| `zoning_class` | enum | `=` `~` `>=` `<=` `between` `is known` `is unknown` | `commercial`, `industrial`, `residential`, `mixed use` |  |
| `flood_sfha_pct` | number, percent | `=` `>=` `<=` `between` `is known` `is unknown` |  | The same as floodplain_pct: >=, <=, =, between, is known |
| `landlocked` | boolean | `=` |  | The same as site_access: = true (landlocked) or = false (has road access) |
| `waterfront_type` | enum | `=` | `bay`, `canal`, `coast`, `lake`, `pond`, `river`, `stream`, `swamp` | The same as waterfront: = bay, canal, coast, lake, pond, river, stream or swamp |

### sales

Recorded sales. near a property: closed-sale comparables from deeds, nominal deeds left out and portfolio deeds flagged. in a place: every recorded sale, one row per sale per property, with its price, buyers, sellers and document number, where the state's deed history is loaded; elsewhere each property's latest sale, and the note says so.

Source: County recorder deeds and state sales files.

Sorts: `sale_date`, `-sale_date`, `distance`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `sale_date` | date | `=` `>=` `<=` `between` |  | Near: from that date; in: also <=, on the sale's first possible day, so a sale known only to its month is found by that month |
| `price` | number, usd | `>=` `<=` `between` |  | (in only): this property's price, not a portfolio deed's total unless portfolio = true |
| `property_type` | enum | `=` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |
| `units` | integer, units | `>=` `<=` `between` |  |  |
| `lot_sqft` | number, sqft | `>=` `<=` `between` |  |  |
| `building_sqft` | number, sqft | `>=` `<=` `between` |  |  |
| `portfolio` | boolean | `=` |  | = false drops multi-parcel deeds; in: = true also lets a portfolio deed's total match a price clause (by default portfolio deeds are listed with their deedTotal apart) |
| `other_transfers` | boolean | `=` |  | = true (in only): also list recorded transfers that are not sales (corrections, related-party and other non-market deeds) |
| `implausible` | boolean | `=` |  | = true (in only): also list records with no price, a nominal one ($1,000 or less) or an impossible date |

### permits

Building permits linked to properties.

Source: City and county building permit records.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `date` | date | `=` `>=` `<=` `between` |  | Defaults to the last 12 months |
| `date_kind` | enum | `=` | `activity`, `filed`, `issued`, `completed` | Activity, filed, issued or completed |
| `description` | string | `~` |  | Keyword or permit number |
| `status` | string | `=` |  |  |
| `valuation` | number, usd | `>=` |  |  |
| `property_type` | enum | `=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |

### tax_notices

Parcels on published tax-distress notices (delinquent taxes advertised, tax sales, lands available). Dated: taxes may have been paid since.

Source: County tax-sale and delinquency lists.

Sorts: `-amount`, `-notice_date`, `-times_listed`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `kind` | enum | `=` `in` | `delinquent`, `tax_sale`, `lands_available` |  |
| `tax_year` | integer | `=` |  |  |
| `all_years` | boolean | `=` |  | = true |
| `amount` | number, usd | `>=` |  |  |
| `times_listed` | integer | `>=` |  |  |
| `property_type` | enum | `=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |

### distress_filings

Parcels with distress filings on public record: foreclosures and lis pendens, registered foreclosures, sheriff's sales, tax liens, evictions, probate. Dated: a filing may have been resolved since.

Source: Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.

Sorts: `-filed_on`, `-amount`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `kind` | enum | `=` `in` | `foreclosure`, `foreclosure_registration`, `sheriff_sale`, `tax_lien`, `eviction`, `probate` |  |
| `filed_on` | date | `>=` `<=` `between` |  |  |
| `status` | enum | `=` | `open`, `any` |  |
| `amount` | number, usd | `>=` |  |  |
| `property_type` | enum | `=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |

### recorded_loans

New York City only: each building's latest recorded financing (mortgage, CEMA, consolidation) with lender and amount. Records carry no maturity date.

Source: Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).

Sorts: `recorded_on`, `-recorded_on`, `-amount`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `recorded_on` | date | `>=` `<=` `between` |  |  |
| `amount` | number, usd | `>=` |  |  |
| `lender` | string | `~` |  |  |
| `lender_kind` | enum | `=` `in` | `bank`, `insurer`, `nonbank`, `private`, `government` |  |
| `satisfied` | boolean | `=` |  | = true includes satisfied loans |
| `stale` | boolean | `=` |  | = true includes stale ones |
| `lots` | integer | `<=` |  | Drops blanket loans |
| `property_type` | enum | `=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |

### cmbs_loans

CMBS loans from servicer filings, for maturity walls and refinancing risk.

Source: CMBS loan-level disclosures filed with the SEC (Form ABS-EE).

Sorts: `maturity`, `-balance`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `maturity` | date | `>=` `<=` `between` |  | Default: the next 24 months |
| `state` | string | `=` |  |  |
| `city` | string | `=` `in` |  |  |
| `property_type` | enum | `=` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` | Office, retail, multifamily, industrial, warehouse, hotel, mixed use, self storage, manufactured housing or healthcare |
| `balance` | number, usd | `>=` |  |  |

### reit_properties

Properties on equity REITs' 10-K Schedule III (SEC EDGAR): encumbrances, cost, gross carrying amount and accumulated depreciation. Rows are the REIT's own lines, not matched to West Kite properties.

Source: Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.

Sorts: `-gross_carrying_amount`, `-encumbrances`, `-debt_to_gross`.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `reit` | string | `~` |  | REIT name contains |
| `property` | string | `~` |  | Property name contains |
| `state` | string | `=` `in` |  |  |
| `encumbrances` | number, usd | `>=` |  |  |
| `gross_carrying_amount` | number, usd | `>=` |  |  |

### sba_loans

Published SBA 7(a) and 504 loans.

Source: SBA 7(a) and 504 loan records.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `borrower` | string | `~` |  |  |
| `lender` | string | `~` |  |  |
| `date` | date | `>=` `<=` `between` |  |  |
| `amount` | number, usd | `>=` |  |  |
| `program` | string | `=` |  | 7a or 504 |
| `status` | string | `=` |  |  |
| `signal` | enum | `=` | `recent`, `financed`, `fixed-assets`, `purchase` | Recent, financed, fixed-assets or purchase |
| `property_id` | string | `=` |  |  |

### sba_lenders

SBA lenders ranked by their published loan activity.

Source: SBA 7(a) and 504 loan records, by lender.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `borrower` | string | `~` |  |  |
| `lender` | string | `~` |  |  |
| `date` | date | `>=` `<=` `between` |  |  |
| `amount` | number, usd | `>=` |  |  |
| `program` | string | `=` |  | 7a or 504 |
| `status` | string | `=` |  |  |
| `signal` | enum | `=` | `recent`, `financed`, `fixed-assets`, `purchase` | Recent, financed, fixed-assets or purchase |
| `property_id` | string | `=` |  |  |

### warn_notices

California WARN layoff, closure and relocation notices: possible space givebacks, not confirmed vacancy.

Source: State WARN Act layoff notices.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `employer` | string | `~` |  |  |
| `date` | date | `>=` `<=` `between` |  |  |
| `signal` | enum | `=` | `recent`, `large`, `closure`, `repeat` | Recent, large, closure or repeat |
| `property_id` | string | `=` |  |  |

### listings

Advertised spaces for sale or lease, with source evidence and broker contacts.

Source: Rights-cleared broker listings.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `transaction` | string | `=` |  | Sale or lease |
| `use` | string | `=` |  | E.g. office, retail, industrial |
| `sqft` | number, sqft | `>=` `<=` `between` |  |  |
| `keyword` | string | `~` |  |  |
| `property_id` | string | `=` |  |  |
| `contacts` | boolean | `=` |  | = true adds broker contacts |

### facilities

Schools (US Department of Education, nationwide) and health facilities (New York State only) in an area, each matched to its lot and that lot's owner, with whether the operator owns its building.

Source: State licensing and federal registries of schools and health facilities, matched to their lots.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `kind` | enum | `=` `in` | `private_school`, `public_school`, `nursing_home`, `hospital`, `clinic` | Default: private schools, nursing homes, hospitals and clinics |
| `owner_operates` | boolean | `=` |  | = true keeps facilities whose operator's name matches the lot's owner |
| `property_type` | enum | `=` `in` | `Office`, `Industrial`, `Retail`, `Multifamily`, `Land`, `Residential`, `Hospitality`, `Mixed use`, `Civic / institutional` |  |

### establishments

Named operators at an address from national public registers (bank branches, liquor licences, care facilities, radio sites and more), each with the property it stands on when one matches, its published facts and source. coverage says per kind and state whether a source is loaded; not covered is not zero. Without a kind, a place search leaves out campground, library, mobile_home_park, oil_gas_well, water_well, water_tower, cannabis_license, vehicle_dealer, contractor, consumer_lender, lottery_retailer, lodging, billboard, water_right, workplace, layoff_notice, federal_contractor, ppp_loan, visa_employer_worksite, motor_carrier, drug_establishment, sales_tax_permit, subsidized_housing: name those to read them.

Source: National public registers of named operators at an address: banks, licences, care facilities, radio sites, energy and transport facilities and more. Each answer's coverage says where a kind's source is loaded.

| Field | Type | Operators | Values | Notes |
|---|---|---|---|---|
| `kind` | enum | `=` `in` | `bank_branch`, `credit_union`, `liquor_license`, `snap_retailer`, `pharmacy`, `medical_practice`, `care_facility`, `health_center`, `child_care`, `school`, `post_office`, `government_facility`, `nonprofit`, `industrial_facility`, `ev_charger`, `fuel_station`, `airport`, `port_terminal`, `refinery`, `gas_storage`, `petroleum_terminal`, `wind_turbine`, `solar_farm`, `stream_gauge`, `wic_vendor`, `casino`, `short_term_rental`, `short_term_rental_market`, `campground`, `library`, `mobile_home_park`, `oil_gas_well`, `water_well`, `water_tower`, `cannabis_license`, `vehicle_dealer`, `contractor`, `consumer_lender`, `lottery_retailer`, `lodging`, `billboard`, `water_right`, `workplace`, `layoff_notice`, `federal_contractor`, `ppp_loan`, `visa_employer_worksite`, `motor_carrier`, `drug_establishment`, `sales_tax_permit`, `subsidized_housing` |  |
| `name` | string | `=` `~` |  | (business or operator name contains) or = |
| `category` | string | `=` |  | As published: main_office, on_premise, nursing_home |
| `status` | string | `=` |  | As published: open, active, pending |
| `opened_on` | date | `>=` `<=` `between` |  | YYYY-MM-DD |
| `property_id` | string | `=` |  | Establishments matched to this property |
| `linked` | boolean | `=` |  | = true (matched to one property) or = false |

### government_comps

San Francisco only: purchase-price and appraised-value evidence quoted from public government financing packets and Board legislation, near one property. Each keeps its document's status (proposed, requested, approved or completed).

Source: San Francisco recorded documents and assessor records.

This type takes no where fields.

## Values and what they mean

### Establishment.kind

| Value | What it is |
|---|---|
| `bank_branch` | An office of an FDIC-insured bank (FDIC BankFind) |
| `credit_union` | A credit union office (NCUA) |
| `liquor_license` | A retail alcohol licence at a premises (state alcohol boards) |
| `snap_retailer` | A store authorized to take SNAP (USDA) |
| `pharmacy` | A pharmacy |
| `medical_practice` | A medical, dental or therapy practice location (NPPES, CMS) |
| `care_facility` | A nursing home, hospital, dialysis, home health, hospice or surgery centre (CMS) |
| `health_center` | A federally qualified health centre site (HRSA) |
| `child_care` | A licensed child-care centre or Head Start site |
| `school` | A college campus or private school (NCES) |
| `post_office` | A post office |
| `government_facility` | A government site: a federal prison or detention centre, courthouse, DMV office, VA benefits office, Vet Center or national cemetery |
| `nonprofit` | A tax-exempt organization's filing address (IRS) |
| `industrial_facility` | An EPA-regulated or greenhouse-gas reporting facility, with its parent company where reported (EPA ECHO, GHGRP) |
| `ev_charger` | A public electric-vehicle charging station (DOE AFDC) |
| `fuel_station` | An alternative-fuel station: CNG, LPG, E85, hydrogen and so on (DOE AFDC) |
| `airport` | An airport or heliport, with its owner where that is an organisation (FAA) |
| `port_terminal` | A port facility: dock, terminal or marina (USACE) |
| `refinery` | A petroleum refinery, with its operator and capacity (EIA) |
| `gas_storage` | An underground natural gas storage field (EIA) |
| `petroleum_terminal` | A bulk fuel terminal approved by the IRS (IRS) |
| `wind_turbine` | A utility-scale wind turbine, with its project, model and capacity (USGS USWTDB) |
| `solar_farm` | A large ground-mounted or rooftop solar facility of 1 MW or more, with its capacity (USGS USPVDB) |
| `stream_gauge` | A USGS stream gauge, with its drainage area |
| `wic_vendor` | A store authorized to take WIC (state health departments) |
| `casino` | A licensed casino (state gaming regulators) |
| `short_term_rental` | A short-term rental listing, with price, availability, reviews, licence number and estimated nights booked and revenue (Inside Airbnb) |
| `short_term_rental_market` | A neighbourhood's short-term rentals: listing count and median nightly price, nights booked and revenue by bedrooms (Inside Airbnb, derived) |
| `campground` | A federal campground or recreation site (Recreation.gov RIDB), or a licensed RV park or campground |
| `library` | A public library branch, with its building size (IMLS) |
| `mobile_home_park` | A mobile home or RV park, with its lot count where published |
| `oil_gas_well` | An oil or gas well: permits, status, operator and production where published (state regulators, USGS orphaned wells) |
| `water_well` | A groundwater well with its depth (USGS, state water agencies) |
| `water_tower` | A water tower or elevated tank (FAA obstacle file) |
| `cannabis_license` | A licensed cannabis dispensary, grower, processor or lab (state cannabis regulators) |
| `vehicle_dealer` | A licensed motor vehicle dealer (state motor vehicle agencies) |
| `contractor` | A licensed contractor business (state licensing boards) |
| `consumer_lender` | A licensed payday, consumer-finance or pawn lender, or a check casher (state financial regulators) |
| `lottery_retailer` | A state lottery retailer, with its sales where published |
| `lodging` | A hotel or other lodging business with a state hotel-tax permit |
| `billboard` | A permitted outdoor advertising sign, with its owner (state DOTs) |
| `water_right` | A surface or groundwater right at its point of diversion, with priority and amount (state water agencies) |
| `workplace` | An establishment inspected by OSHA, with its industry, headcount and inspection history |
| `layoff_notice` | A WARN Act layoff or closure notice at an employer's site, with the workers affected (state labor agencies) |
| `federal_contractor` | A federal contractor or SAM.gov-registered entity at its address, with obligations and NAICS (SAM.gov, USAspending) |
| `ppp_loan` | An SBA Paycheck Protection Program loan to a business or individual, at the borrower's published address (it may be a home and is not evidence of a tenant) |
| `visa_employer_worksite` | An employer's H-1B or PERM worksite, with case counts (DOL disclosure files). Street, job titles and wages only at the employer's own address or where one filing has two or more workers; other worksites are city and ZIP only |
| `motor_carrier` | A motor carrier's base, with power units and drivers (FMCSA census) |
| `drug_establishment` | An FDA-registered drug establishment (FDA) |
| `sales_tax_permit` | A sales-tax permit at an outlet location (state tax agencies) |
| `subsidized_housing` | A HUD-assisted multifamily property, public housing development or public housing building, with its units. Don't sum units across public_housing_development and public_housing_building: they count the same units |
