{"openapi":"3.1.0","info":{"title":"West Kite API","version":"1.0.0","description":"Sourced US commercial property records, owner research and contacts, priced per call. A call that fails, or a lookup that finds nothing, costs nothing. Missing fields are unavailable, never zero: each answer lists them in missing with a reason.","contact":{"url":"https://westkite.com/docs/api"}},"servers":[{"url":"https://api.westkite.com/v1"}],"x-find-types":[{"type":"properties","summary":"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.","sort":["updated_at","held_years","market_value","assessed_value","last_sale_price","building_sqft","lot_sqft","year_built","last_sale_date"],"fields":[{"name":"property_type","type":"enum","unit":null,"operators":["=","!=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in: Office, Industrial, Retail, Multifamily, Land, Residential, Hospitality, Mixed use, Civic / institutional; != leaves one type out","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"owner_type","type":"enum","unit":null,"operators":["=","!="],"values":["government","nonprofit","llc","corporation","trust","estate","individual"],"sortable":false,"description":"= or != (leaves one class out; repeat for several): government, nonprofit, llc, corporation, trust, estate, individual","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"owner","type":"string","unit":null,"operators":["=","~"],"values":null,"sortable":false,"description":"~ (owner of record contains) or = (a company with its affiliated entities, e.g. Blackstone; needs in)","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"last_sale_date","type":"date","unit":null,"operators":["=",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, is known: YYYY-MM-DD","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"building_to_lot_ratio","type":"number","unit":"ratio","operators":["<="],"values":null,"sortable":false,"description":"<=: building area over lot area, for underbuilt sites (0.5 is a common screen)","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"public_owners","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= false leaves out government, housing-authority, religious, cemetery, university and hospital owners and civic buildings (default: every owner, as count and export)","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"building_sqft","type":"number","unit":"sqft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"lot_sqft","type":"number","unit":"sqft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"year_built","type":"integer","unit":"year","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"held_years","type":"integer","unit":"years","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"last_sale_price","type":"number","unit":"usd","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"zoning","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"signal","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"market_value","type":"number","unit":"usd","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"assessed_value","type":"number","unit":"usd","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":true,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"tax_amount","type":"number","unit":"usd","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"units","type":"integer","unit":"units","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"stories","type":"number","unit":"stories","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"bedrooms","type":"number","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"bathrooms","type":"number","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"flood_zone","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"subtype","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"street","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"buildable_sqft","type":"number","unit":"sqft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"unused_buildable_sqft","type":"number","unit":"sqft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"aerial_land","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_parking_spaces","type":"integer","unit":"spaces","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_loading_docks","type":"integer","unit":"docks","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_building_pct","type":"number","unit":"percent","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_vegetation_pct","type":"number","unit":"percent","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_roof","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"aerial_feature","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"West Kite's readings of public aerial imagery.","coverage":null},{"name":"wetland_pct","type":"number","unit":"percent","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"USFWS National Wetlands Inventory, measured over the parcel outline.","coverage":null},{"name":"floodplain_pct","type":"number","unit":"percent","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"FEMA National Flood Hazard Layer, measured over the parcel outline.","coverage":null},{"name":"upland_acres","type":"number","unit":"acres","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"FEMA flood zones and USFWS wetlands, measured over the parcel outline.","coverage":null},{"name":"largest_upland_acres","type":"number","unit":"acres","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"FEMA flood zones and USFWS wetlands, measured over the parcel outline.","coverage":null},{"name":"road_frontage_ft","type":"number","unit":"ft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"Census TIGER and OpenStreetMap roads, measured along the parcel outline.","coverage":null},{"name":"water_frontage_ft","type":"number","unit":"ft","operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"USGS National Hydrography Dataset, measured along the parcel outline.","coverage":null},{"name":"site_access","type":"enum","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":["landlocked","road access"],"sortable":false,"description":">=, <=, =, between, ~, is known","source":"Census TIGER and OpenStreetMap roads, measured along the parcel outline.","coverage":null},{"name":"waterfront","type":"string","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"USGS National Hydrography Dataset, measured along the parcel outline.","coverage":null},{"name":"owner_occupied","type":"boolean","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"zoning_class","type":"enum","unit":null,"operators":["=","~",">=","<=","between","is known","is unknown"],"values":["commercial","industrial","residential","mixed use"],"sortable":false,"description":">=, <=, =, between, ~, is known","source":"County assessor rolls and recorder records as each county publishes them.","coverage":null},{"name":"flood_sfha_pct","type":"number","unit":"percent","operators":["=",">=","<=","between","is known","is unknown"],"values":null,"sortable":false,"description":"the same as floodplain_pct: >=, <=, =, between, is known","source":"FEMA National Flood Hazard Layer, measured over the parcel outline.","coverage":null},{"name":"landlocked","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"the same as site_access: = true (landlocked) or = false (has road access)","source":"Census TIGER and OpenStreetMap roads, measured along the parcel outline.","coverage":null},{"name":"waterfront_type","type":"enum","unit":null,"operators":["="],"values":["bay","canal","coast","lake","pond","river","stream","swamp"],"sortable":false,"description":"the same as waterfront: = bay, canal, coast, lake, pond, river, stream or swamp","source":"USGS National Hydrography Dataset, measured along the parcel outline.","coverage":null}]},{"type":"sales","summary":"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.","sort":["sale_date","-sale_date","distance"],"fields":[{"name":"sale_date","type":"date","unit":null,"operators":["=",">=","<=","between"],"values":null,"sortable":true,"description":">=, 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)","source":"County recorder deeds and state sales files.","coverage":null},{"name":"price","type":"number","unit":"usd","operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between (in only): this property's price, not a portfolio deed's total unless portfolio = true","source":"County recorder deeds and state sales files.","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["="],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"=","source":"County recorder deeds and state sales files.","coverage":null},{"name":"units","type":"integer","unit":"units","operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"County recorder deeds and state sales files.","coverage":null},{"name":"lot_sqft","type":"number","unit":"sqft","operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"County recorder deeds and state sales files.","coverage":null},{"name":"building_sqft","type":"number","unit":"sqft","operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"County recorder deeds and state sales files.","coverage":null},{"name":"portfolio","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= 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)","source":"County recorder deeds and state sales files.","coverage":null},{"name":"other_transfers","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true (in only): also list recorded transfers that are not sales (corrections, related-party and other non-market deeds)","source":"County recorder deeds and state sales files.","coverage":null},{"name":"implausible","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true (in only): also list records with no price, a nominal one ($1,000 or less) or an impossible date","source":"County recorder deeds and state sales files.","coverage":null}]},{"type":"permits","summary":"Building permits linked to properties.","source":"City and county building permit records.","sort":[],"fields":[{"name":"date","type":"date","unit":null,"operators":["=",">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, =, between (defaults to the last 12 months)","source":"City and county building permit records.","coverage":null},{"name":"date_kind","type":"enum","unit":null,"operators":["="],"values":["activity","filed","issued","completed"],"sortable":false,"description":"= activity, filed, issued or completed","source":"City and county building permit records.","coverage":null},{"name":"description","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~ keyword or permit number","source":"City and county building permit records.","coverage":null},{"name":"status","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"City and county building permit records.","coverage":null},{"name":"valuation","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":false,"description":">=","source":"City and county building permit records.","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in","source":"City and county building permit records.","coverage":null}]},{"type":"tax_notices","summary":"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.","sort":["-amount","-notice_date","-times_listed"],"fields":[{"name":"kind","type":"enum","unit":null,"operators":["=","in"],"values":["delinquent","tax_sale","lands_available"],"sortable":false,"description":"= or in: delinquent, tax_sale, lands_available","source":"County tax-sale and delinquency lists.","coverage":null},{"name":"tax_year","type":"integer","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"County tax-sale and delinquency lists.","coverage":null},{"name":"all_years","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true","source":"County tax-sale and delinquency lists.","coverage":null},{"name":"amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"County tax-sale and delinquency lists.","coverage":null},{"name":"times_listed","type":"integer","unit":null,"operators":[">="],"values":null,"sortable":true,"description":">=","source":"County tax-sale and delinquency lists.","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in","source":"County tax-sale and delinquency lists.","coverage":null}]},{"type":"distress_filings","summary":"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.","sort":["-filed_on","-amount"],"fields":[{"name":"kind","type":"enum","unit":null,"operators":["=","in"],"values":["foreclosure","foreclosure_registration","sheriff_sale","tax_lien","eviction","probate"],"sortable":false,"description":"= or in: foreclosure, foreclosure_registration, sheriff_sale, tax_lien, eviction, probate","source":"Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.","coverage":null},{"name":"filed_on","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":true,"description":">=, <=, between","source":"Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.","coverage":null},{"name":"status","type":"enum","unit":null,"operators":["="],"values":["open","any"],"sortable":false,"description":"=: open, any","source":"Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.","coverage":null},{"name":"amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in","source":"Court and lien filings: foreclosures and lis pendens, sheriff's sales, tax liens, evictions, probate.","coverage":null}]},{"type":"recorded_loans","summary":"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).","sort":["recorded_on","-recorded_on","-amount"],"fields":[{"name":"recorded_on","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":true,"description":">=, <=, between","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"lender","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"lender_kind","type":"enum","unit":null,"operators":["=","in"],"values":["bank","insurer","nonbank","private","government"],"sortable":false,"description":"= or in: bank, insurer, nonbank, private, government","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"satisfied","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true includes satisfied loans","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"stale","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true includes stale ones","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"lots","type":"integer","unit":null,"operators":["<="],"values":null,"sortable":false,"description":"<= (drops blanket loans)","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in","source":"Mortgages recorded with the county (New York City ACRIS, Maricopa County and other loaded recorders).","coverage":null}]},{"type":"cmbs_loans","summary":"CMBS loans from servicer filings, for maturity walls and refinancing risk.","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","sort":["maturity","-balance"],"fields":[{"name":"maturity","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":true,"description":">=, <=, between (default: the next 24 months)","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","coverage":null},{"name":"state","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","coverage":null},{"name":"city","type":"string","unit":null,"operators":["=","in"],"values":null,"sortable":false,"description":"= or in","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["="],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= office, retail, multifamily, industrial, warehouse, hotel, mixed use, self storage, manufactured housing or healthcare","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","coverage":null},{"name":"balance","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"CMBS loan-level disclosures filed with the SEC (Form ABS-EE).","coverage":null}]},{"type":"reit_properties","summary":"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.","sort":["-gross_carrying_amount","-encumbrances","-debt_to_gross"],"fields":[{"name":"reit","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~ (REIT name contains)","source":"Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.","coverage":null},{"name":"property","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~ (property name contains)","source":"Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.","coverage":null},{"name":"state","type":"string","unit":null,"operators":["=","in"],"values":null,"sortable":false,"description":"= or in","source":"Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.","coverage":null},{"name":"encumbrances","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.","coverage":null},{"name":"gross_carrying_amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":true,"description":">=","source":"Equity REITs' 10-K Schedule III properties: encumbrances, cost and depreciation.","coverage":null}]},{"type":"sba_loans","summary":"Published SBA 7(a) and 504 loans.","source":"SBA 7(a) and 504 loan records.","sort":[],"fields":[{"name":"borrower","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"lender","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"date","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":false,"description":">=","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"program","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= 7a or 504","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"status","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"signal","type":"enum","unit":null,"operators":["="],"values":["recent","financed","fixed-assets","purchase"],"sortable":false,"description":"= recent, financed, fixed-assets or purchase","source":"SBA 7(a) and 504 loan records.","coverage":null},{"name":"property_id","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"SBA 7(a) and 504 loan records.","coverage":null}]},{"type":"sba_lenders","summary":"SBA lenders ranked by their published loan activity.","source":"SBA 7(a) and 504 loan records, by lender.","sort":[],"fields":[{"name":"borrower","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"lender","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"date","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"amount","type":"number","unit":"usd","operators":[">="],"values":null,"sortable":false,"description":">=","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"program","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= 7a or 504","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"status","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"signal","type":"enum","unit":null,"operators":["="],"values":["recent","financed","fixed-assets","purchase"],"sortable":false,"description":"= recent, financed, fixed-assets or purchase","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null},{"name":"property_id","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"SBA 7(a) and 504 loan records, by lender.","coverage":null}]},{"type":"warn_notices","summary":"California WARN layoff, closure and relocation notices: possible space givebacks, not confirmed vacancy.","source":"State WARN Act layoff notices.","sort":[],"fields":[{"name":"employer","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"State WARN Act layoff notices.","coverage":null},{"name":"date","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"State WARN Act layoff notices.","coverage":null},{"name":"signal","type":"enum","unit":null,"operators":["="],"values":["recent","large","closure","repeat"],"sortable":false,"description":"= recent, large, closure or repeat","source":"State WARN Act layoff notices.","coverage":null},{"name":"property_id","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"State WARN Act layoff notices.","coverage":null}]},{"type":"listings","summary":"Advertised spaces for sale or lease, with source evidence and broker contacts.","source":"Rights-cleared broker listings.","sort":[],"fields":[{"name":"transaction","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= sale or lease","source":"Rights-cleared broker listings.","coverage":null},{"name":"use","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= e.g. office, retail, industrial","source":"Rights-cleared broker listings.","coverage":null},{"name":"sqft","type":"number","unit":"sqft","operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between","source":"Rights-cleared broker listings.","coverage":null},{"name":"keyword","type":"string","unit":null,"operators":["~"],"values":null,"sortable":false,"description":"~","source":"Rights-cleared broker listings.","coverage":null},{"name":"property_id","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"=","source":"Rights-cleared broker listings.","coverage":null},{"name":"contacts","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true adds broker contacts","source":"Rights-cleared broker listings.","coverage":null}]},{"type":"facilities","summary":"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.","sort":[],"fields":[{"name":"kind","type":"enum","unit":null,"operators":["=","in"],"values":["private_school","public_school","nursing_home","hospital","clinic"],"sortable":false,"description":"= or in: private_school, public_school, nursing_home, hospital, clinic (default: private schools, nursing homes, hospitals and clinics)","source":"State licensing and federal registries of schools and health facilities, matched to their lots.","coverage":null},{"name":"owner_operates","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true keeps facilities whose operator's name matches the lot's owner","source":"State licensing and federal registries of schools and health facilities, matched to their lots.","coverage":null},{"name":"property_type","type":"enum","unit":null,"operators":["=","in"],"values":["Office","Industrial","Retail","Multifamily","Land","Residential","Hospitality","Mixed use","Civic / institutional"],"sortable":false,"description":"= or in","source":"State licensing and federal registries of schools and health facilities, matched to their lots.","coverage":null}]},{"type":"establishments","summary":"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.","sort":[],"fields":[{"name":"kind","type":"enum","unit":null,"operators":["=","in"],"values":["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"],"sortable":false,"description":"= or 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","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.","coverage":null},{"name":"name","type":"string","unit":null,"operators":["=","~"],"values":null,"sortable":false,"description":"~ (business or operator name contains) or =","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.","coverage":null},{"name":"category","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= (as published: main_office, on_premise, nursing_home)","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.","coverage":null},{"name":"status","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= (as published: open, active, pending)","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.","coverage":null},{"name":"opened_on","type":"date","unit":null,"operators":[">=","<=","between"],"values":null,"sortable":false,"description":">=, <=, between: YYYY-MM-DD","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.","coverage":null},{"name":"property_id","type":"string","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= (establishments matched to this property)","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.","coverage":null},{"name":"linked","type":"boolean","unit":null,"operators":["="],"values":null,"sortable":false,"description":"= true (matched to one property) or = false","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.","coverage":null}]},{"type":"government_comps","summary":"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.","sort":[],"fields":[]}],"security":[{"bearer":[]},{"apiKey":[]}],"paths":{"/":{"get":{"operationId":"index","summary":"Index","description":"Links to the docs, this document and the rate card.","x-price":"Free","tags":["Meta"],"security":[],"responses":{"200":{"description":"OK"}}}},"/openapi.json":{"get":{"operationId":"openapi","summary":"This document","description":"OpenAPI 3.1.","x-price":"Free","tags":["Meta"],"security":[],"responses":{"200":{"description":"OK"}}}},"/search":{"get":{"operationId":"search","summary":"Search","description":"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.","x-price":"Free","tags":["Properties"],"parameters":[{"name":"q","in":"query","required":false,"description":"Words to search.","schema":{"type":"string"}},{"name":"in","in":"query","required":false,"description":"With q: a place to prefer, e.g. San Francisco, CA.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude: alone with lng, the parcel there; with q, prefer options near it.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Results, up to 50. Default 20.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchHit"}},"places":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"kind":{"type":"string"},"in":{"type":"string"},"county_fips":{"type":"array","items":{"type":"string"}}}}},"corrected_query":{"type":"string","description":"What the closest options were read as, when nothing matched exactly."},"note":{"type":"string"},"warning":{"type":"string","description":"The search could not answer in time: an empty answer is not evidence of no match."}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/find/{type}":{"get":{"operationId":"find","summary":"Find records","description":"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.","x-price":"$1.00 per 1,000 rows","tags":["Find"],"parameters":[{"name":"type","in":"path","required":true,"description":"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.","schema":{"enum":["properties","sales","permits","tax_notices","distress_filings","recorded_loans","cmbs_loans","reit_properties","sba_loans","sba_lenders","warn_notices","listings","facilities","establishments","government_comps"]}},{"name":"where","in":"query","required":false,"description":"Repeat for each clause, e.g. `where=last_sale_price >= 1000000`. Operators: =, ~, >=, <=, between a and b, in a,b,c, is known, is unknown.","schema":{"type":"array","items":{"type":"string"}}},{"name":"in","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"near","in":"query","required":false,"description":"A property ID, or longitude,latitude (longitude first). Or send lat and lng instead.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude of the point to search around, -90 to 90. Send with lng, instead of near.","schema":{"type":"number","minimum":-90,"maximum":90}},{"name":"lng","in":"query","required":false,"description":"Longitude of the point to search around, -180 to 180. Send with lat, instead of near.","schema":{"type":"number","minimum":-180,"maximum":180}},{"name":"radius_m","in":"query","required":false,"description":"Radius around near or lat and lng, 50 to 50,000 m. Default 1609.","schema":{"type":"number"}},{"name":"sort","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"next_cursor from the previous page.","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"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.","schema":{"type":"boolean"}},{"name":"stats","in":"query","required":false,"description":"With count: the field to summarize.","schema":{"type":"string"}},{"name":"group_by","in":"query","required":false,"description":"properties: owner.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"The rows under their type's key (properties, loans, notices, filings, …) with sources and notes.","properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/PropertySummary"},"description":"Property rows (properties, and beside the property family's own rows)."},"next_cursor":{"type":["string","null"],"description":"Pass as cursor for the next page, which starts right after this page's last row; null at the end."},"has_more":{"type":"boolean","description":"Whether more rows match after this page."},"resolved_scope":{"$ref":"#/components/schemas/ResolvedScope"},"establishments":{"type":"array","items":{"$ref":"#/components/schemas/Establishment"},"description":"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":{"type":"array","items":{"$ref":"#/components/schemas/EstablishmentCoverage"},"description":"type=establishments: per kind asked and state in scope, whether a source is loaded. not_covered means no data, not zero."}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"findPost","summary":"Find records (JSON)","description":"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.","x-price":"$1.00 per 1,000 rows","tags":["Find"],"parameters":[{"name":"type","in":"path","required":true,"description":"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.","schema":{"enum":["properties","sales","permits","tax_notices","distress_filings","recorded_loans","cmbs_loans","reit_properties","sba_loans","sba_lenders","warn_notices","listings","facilities","establishments","government_comps"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"where":{"type":"array","items":{"type":"string"}},"in":{"type":"string"},"near":{"type":"string"},"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"radius_m":{"type":"number"},"sort":{"type":"string"},"limit":{"type":"integer","maximum":100},"cursor":{"type":"string"},"count":{"type":"boolean"},"stats":{"type":"string"},"group_by":{"type":"string"},"max_cost_usd":{"type":"number"},"within":{"$ref":"#/components/schemas/Within"}}}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"The rows under their type's key (properties, loans, notices, filings, …) with sources and notes.","properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/PropertySummary"},"description":"Property rows (properties, and beside the property family's own rows)."},"next_cursor":{"type":["string","null"],"description":"Pass as cursor for the next page, which starts right after this page's last row; null at the end."},"has_more":{"type":"boolean","description":"Whether more rows match after this page."},"resolved_scope":{"$ref":"#/components/schemas/ResolvedScope"},"establishments":{"type":"array","items":{"$ref":"#/components/schemas/Establishment"},"description":"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":{"type":"array","items":{"$ref":"#/components/schemas/EstablishmentCoverage"},"description":"type=establishments: per kind asked and state in scope, whether a source is loaded. not_covered means no data, not zero."}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/properties/{id}":{"get":{"operationId":"getProperty","summary":"A property record","description":"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.","x-price":"$0.01 per call","tags":["Properties"],"parameters":[{"name":"id","in":"path","required":true,"description":"Property ID.","schema":{"type":"string"}},{"name":"parts","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"events_cursor","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"event_category","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["violation","inspection","planning","ownership","other"]}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"$ref":"#/components/schemas/PropertyRecord"},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/properties/batch":{"post":{"operationId":"getProperties","summary":"Many property records","description":"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.","x-price":"$0.01 per call per record found","tags":["Properties"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property_ids"],"properties":{"property_ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"max_cost_usd":{"type":"number"}}}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","required":["properties","not_found"],"properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/Property"}},"not_found":{"type":"array","items":{"type":"string"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/properties/{id}/image":{"get":{"operationId":"getPropertyImage","summary":"Aerial photo with the lot outlined","description":"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.","x-price":"Free","tags":["Properties"],"parameters":[{"name":"id","in":"path","required":true,"description":"Property ID.","schema":{"type":"string"}},{"name":"size","in":"query","required":false,"description":"Pixels square: 256, 512, 768, 1024. Default 1024.","schema":{"type":"integer"}},{"name":"format","in":"query","required":false,"description":"jpeg (default) or json.","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Flight year, 1990 or later: one of years. Default: the first entry in years, the newest photo.","schema":{"type":"integer"}}],"responses":{"200":{"description":"A JPEG, or the envelope with format=json.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-Imagery-Source":{"$ref":"#/components/headers/X-Imagery-Source"},"X-Imagery-Year":{"$ref":"#/components/headers/X-Imagery-Year"},"X-Imagery-Credit":{"$ref":"#/components/headers/X-Imagery-Credit"},"X-Imagery-License":{"$ref":"#/components/headers/X-Imagery-License"},"X-Charged-USD":{"$ref":"#/components/headers/X-Charged-USD"},"X-Balance-USD":{"$ref":"#/components/headers/X-Balance-USD"}},"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"$ref":"#/components/schemas/PropertyImage"},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/properties/{id}/site":{"get":{"operationId":"getPropertySite","summary":"Site report","description":"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.","x-price":"$0.05 per call","tags":["Properties"],"parameters":[{"name":"id","in":"path","required":true,"description":"Property ID.","schema":{"type":"string"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"environmental":{"$ref":"#/components/schemas/ScreenTopic"},"hazards":{"$ref":"#/components/schemas/ScreenTopic"},"incentives":{"$ref":"#/components/schemas/ScreenTopic"},"buildability":{"$ref":"#/components/schemas/ScreenTopic"},"location":{"$ref":"#/components/schemas/ScreenTopic"},"zoning":{"type":["object","null"],"additionalProperties":true},"screened_parcel":{"type":"boolean"},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/properties/{id}/similar":{"get":{"operationId":"getSimilarProperties","summary":"Similar properties","description":"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.","x-price":"$1.00 per 1,000 rows","tags":["Properties"],"parameters":[{"name":"id","in":"path","required":true,"description":"Property ID.","schema":{"type":"string"}},{"name":"radius_m","in":"query","required":false,"description":"200 to 50,000 m. Default 5,000.","schema":{"type":"number"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/PropertySummary"}},"criteria":{"type":"object"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nearby":{"get":{"operationId":"nearby","summary":"Anything nearby","description":"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.","x-price":"$0.01 per call","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"kinds","in":"query","required":false,"description":"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.","schema":{"type":"array","items":{"enum":["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"]}}},{"name":"radius_m","in":"query","required":false,"description":"The radius read, up to 8047 m (default 1609).","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Features per kind, 1 to 50. Default 10.","schema":{"type":"integer"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"point":{"type":"object"},"features":{"type":"array","items":{"$ref":"#/components/schemas/NearbyFeature"}},"searched":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"radius_m":{"type":"number"},"note":{"type":"string"}}}},"headlines":{"type":"object","additionalProperties":{"type":"string"}},"brands":{"type":["object","null"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/power":{"get":{"operationId":"power","summary":"Power report","description":"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.","x-price":"$0.05 per call","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"kinds","in":"query","required":false,"description":"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.","schema":{"type":"array","items":{"enum":["power_plants","substations","transmission_lines","electric_utilities","power_capacity","interconnection_queues"]}}},{"name":"radius_m","in":"query","required":false,"description":"Keep features within this many meters (50 to 200,000); never wider than each source is searched.","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Features per kind, 1 to 50. Default 10.","schema":{"type":"integer"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"point":{"type":"object"},"features":{"type":"array","items":{"$ref":"#/components/schemas/NearbyFeature"}},"searched":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"radius_m":{"type":"number"},"note":{"type":"string"}}}},"headlines":{"type":"object","additionalProperties":{"type":"string"}},"brands":{"type":["object","null"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/transport":{"get":{"operationId":"transport","summary":"Transport","description":"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.","x-price":"$0.01 per call","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"kinds","in":"query","required":false,"description":"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.","schema":{"type":"array","items":{"enum":["interstates","highways","highway_ramps","truck_routes","local_roads","rail_lines","rail_sidings","rail_crossings","intermodal_terminals","airports","ports","obstructions"]}}},{"name":"radius_m","in":"query","required":false,"description":"Keep features within this many meters (50 to 200,000); never wider than each source is searched.","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Features per kind, 1 to 50. Default 10.","schema":{"type":"integer"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"point":{"type":"object"},"features":{"type":"array","items":{"$ref":"#/components/schemas/NearbyFeature"}},"searched":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"radius_m":{"type":"number"},"note":{"type":"string"}}}},"headlines":{"type":"object","additionalProperties":{"type":"string"}},"brands":{"type":["object","null"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/utilities":{"get":{"operationId":"utilities","summary":"Utilities","description":"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.","x-price":"$0.01 per call","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"kinds","in":"query","required":false,"description":"Comma-separated: water_systems, sewer_service, wastewater_plants, gas_pipelines, gas_utilities. Default water_systems,sewer_service,wastewater_plants,gas_pipelines,gas_utilities.","schema":{"type":"array","items":{"enum":["water_systems","sewer_service","wastewater_plants","gas_pipelines","gas_utilities"]}}},{"name":"radius_m","in":"query","required":false,"description":"Keep features within this many meters (50 to 200,000); never wider than each source is searched.","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Features per kind, 1 to 50. Default 10.","schema":{"type":"integer"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"point":{"type":"object"},"features":{"type":"array","items":{"$ref":"#/components/schemas/NearbyFeature"}},"searched":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"radius_m":{"type":"number"},"note":{"type":"string"}}}},"headlines":{"type":"object","additionalProperties":{"type":"string"}},"brands":{"type":["object","null"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands":{"get":{"operationId":"brands","summary":"Brands nearby","description":"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).","x-price":"$0.01 per call","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"radius_m","in":"query","required":false,"description":"The radius read, up to 8047 m (default 1609).","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"Features per kind, 1 to 50. Default 10.","schema":{"type":"integer"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"point":{"type":"object"},"features":{"type":"array","items":{"$ref":"#/components/schemas/NearbyFeature"}},"searched":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"radius_m":{"type":"number"},"note":{"type":"string"}}}},"headlines":{"type":"object","additionalProperties":{"type":"string"}},"brands":{"type":["object","null"],"additionalProperties":true},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/demographics":{"get":{"operationId":"demographics","summary":"Demographics report","description":"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.","x-price":"$0.05 per call","tags":["Places"],"parameters":[{"name":"area","in":"query","required":false,"description":"state-06, metro-12420, county-48453, place-0644000 or zip-94105. GET /demographics/areas finds one.","schema":{"type":"string"}},{"name":"property_id","in":"query","required":false,"description":"A property ID, for a ring around it.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"radius_m","in":"query","required":false,"description":"Ring radius, 100 to 16093 m. Default 1609 (one mile).","schema":{"type":"number"}},{"name":"max_cost_usd","in":"query","required":false,"description":"Refuse the call if it costs more.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"area":{"type":"object"},"acs":{"type":["object","null"]},"jobs":{"type":["object","null"]},"workplace":{"type":["object","null"]},"home_buying":{"type":["object","null"]},"sources":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded, max_cost_too_low","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/zoning":{"get":{"operationId":"getZoning","summary":"Zoning district","description":"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.","x-price":"Free","tags":["Places"],"parameters":[{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","required":["coordinates","district","note"],"properties":{"id":{"type":"string"},"coordinates":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"district":{"oneOf":[{"$ref":"#/components/schemas/MapZoningDistrict"},{"type":"null"}]},"other_districts":{"type":"array","items":{"$ref":"#/components/schemas/MapZoningDistrict"},"description":"Present only where the jurisdiction's own layer overlaps itself at the point."},"note":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/layers":{"get":{"operationId":"listLayers","summary":"Area layers","description":"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.","x-price":"Free","tags":["Places"],"parameters":[],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","required":["layers"],"properties":{"layers":{"type":"array","items":{"type":"object","required":["id","label","topic","geometry","summary"],"properties":{"id":{"enum":["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":{"type":"string"},"topic":{"type":"string"},"geometry":{"enum":["point","polygon","line","raster"]},"summary":{"type":"string"},"reads":{"type":"array","items":{"enum":["point","radius","bbox"]},"description":"How the layer can be read: rasters answer a point, or are map imagery only (empty)."},"default_radius_m":{"type":"integer"},"coverage":{"type":"string"},"source":{"type":["object","null"]},"terms":{"type":["object","null"]}}}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/layers/{layer}":{"get":{"operationId":"readLayer","summary":"Area layer by point or area","description":"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.","x-price":"Free","tags":["Places"],"parameters":[{"name":"layer","in":"path","required":true,"description":"An area layer id from GET /layers.","schema":{"enum":["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"]}},{"name":"property_id","in":"query","required":false,"description":"A property ID. Or send lat and lng, or bbox.","schema":{"type":"string"}},{"name":"lat","in":"query","required":false,"description":"Latitude.","schema":{"type":"number"}},{"name":"lng","in":"query","required":false,"description":"Longitude.","schema":{"type":"number"}},{"name":"geometry","in":"query","required":false,"description":"true adds each feature's GeoJSON geometry (coordinates to six places). Default false.","schema":{"type":"boolean"}},{"name":"radius_m","in":"query","required":false,"description":"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.","schema":{"type":"number"}},{"name":"bbox","in":"query","required":false,"description":"west,south,east,north in decimal degrees, at most 0.5 degrees each way. Instead of a point.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Features returned, 1 to 500. Default 100.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","required":["layer","features"],"properties":{"layer":{"enum":["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":{"type":"string"},"source":{"type":["object","null"]},"id":{"type":"string"},"coordinates":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"radius_m":{"type":"number"},"bbox":{"type":"array","items":{"type":"number"}},"count":{"type":["integer","null"]},"more_available":{"type":"boolean"},"features":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"distance_m":{"type":"integer"},"geometry_type":{"type":["string","null"]},"lat":{"type":"number"},"lng":{"type":"number"}}}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/demographics/areas":{"get":{"operationId":"demographicAreas","summary":"Find a demographics area","description":"A state, metro, county, city or ZIP code by name, with the area id GET /demographics takes.","x-price":"Free","tags":["Places"],"parameters":[{"name":"q","in":"query","required":true,"description":"A name, e.g. Austin or 78704.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"areas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"detail":{"type":"string"},"population":{"type":["integer","null"]}}}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/markets":{"get":{"operationId":"markets","summary":"Market series","description":"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.","x-price":"Free","tags":["Markets"],"parameters":[{"name":"in","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"metric","in":"query","required":true,"description":"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.","schema":{"type":"array","maxItems":12,"items":{"enum":["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"]}}},{"name":"area","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"property_type","in":"query","required":false,"description":"all, office, retail, industrial, multifamily, hospitality. Default all. Quarterly sales metrics take retail, office or industrial.","schema":{"enum":["all","office","retail","industrial","multifamily","hospitality"]}},{"name":"range","in":"query","required":false,"description":"How far back: 1y, 3y, 5y, 10y, all (1, 3, 5 or 10 years, or everything published). Default 5y.","schema":{"enum":["1y","3y","5y","10y","all"]}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"areas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"kind":{"type":["string","null"]},"role":{"enum":["subject","comparison"]}}}},"metrics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"unit":{"type":["string","null"]},"frequency":{"enum":["monthly","quarterly","annual","snapshot",null]}}}},"series":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"metric_id":{"type":"string"},"area_id":{"type":"string"},"area_label":{"type":["string","null"]},"frequency":{"type":["string","null"]}}}}},"additionalProperties":true},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/try":{"get":{"operationId":"tryIt","summary":"Try it (no key)","description":"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.","x-price":"Free","tags":["Meta"],"security":[],"parameters":[{"name":"q","in":"query","required":true,"description":"An address, e.g. 550 Madison Ave, New York.","schema":{"type":"string","minLength":3,"maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"property":{"type":["object","null"],"properties":{"id":{"type":"string"},"address":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"property_type":{"type":["string","null"]},"building_sqft":{"type":["number","null"]},"year_built":{"type":["integer","null"]},"lot_sqft":{"type":["number","null"]},"units":{"type":["integer","null"]},"owner_of_record":{"type":["string","null"]},"mailing_city_state":{"type":["string","null"]},"last_sale":{"type":["object","null"],"properties":{"date":{"type":"string"},"price":{"type":["number","null"]}}}}},"more":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/agent-signup":{"post":{"operationId":"agentSignup","summary":"Sign up from an agent (no key)","description":"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.","x-price":"Free","tags":["Account"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"additionalProperties":false,"properties":{"email":{"type":"string","format":"email","maxLength":254,"description":"The person's email."},"key_name":{"type":"string","maxLength":60,"default":"Agent","description":"The new key's name on the dashboard."},"client_name":{"type":"string","maxLength":60,"description":"Your name, shown to the person (\"Claude Code wants an API key\")."}}}}}},"responses":{"200":{"description":"Show the link and code; poll with the claim token.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["claim_token","verification_uri","user_code","expires_in","interval"],"properties":{"claim_token":{"type":"string","description":"Keep it; never show it."},"verification_uri":{"type":"string","description":"https://app.westkite.com/developers/claim?code=<user_code>, with #login_hint=<email>."},"user_code":{"type":"string","pattern":"^[0-9]{6}$"},"expires_in":{"type":"integer","const":600},"interval":{"type":"integer","const":5}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited (reason agent_signups)","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/agent-signup/token":{"post":{"operationId":"agentSignupToken","summary":"Collect the agent's key","description":"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.","x-price":"Free","tags":["Account"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["claim_token"],"properties":{"claim_token":{"type":"string"}}}}}},"responses":{"200":{"description":"The claim's status; the key once approved.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["status"],"properties":{"status":{"enum":["pending","slow_down","expired","denied"]}}},{"type":"object","required":["status","api_key","key_id","key_name","balance_usd","dashboard_url"],"properties":{"status":{"const":"approved"},"api_key":{"type":"string","pattern":"^wk_live_[0-9A-Za-z]{32}$"},"key_id":{"type":"string"},"key_name":{"type":"string"},"balance_usd":{"type":"number","description":"The team's balance (new teams start with the sign-up credit)."},"dashboard_url":{"type":"string"}}}]}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/coverage":{"get":{"operationId":"coverage","summary":"Coverage","description":"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.","x-price":"Free","tags":["Meta"],"parameters":[{"name":"state","in":"query","required":false,"description":"Two-letter code or FIPS.","schema":{"type":"string"}},{"name":"county","in":"query","required":false,"description":"A five-digit county FIPS code, or a county name with its state (\"Travis County, TX\", or Travis with state=TX).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"summary":{"type":"object","properties":{"counties":{"type":"integer"},"properties":{"type":"integer"}}},"counties":{"type":"array","items":{"type":"object","additionalProperties":true}},"note":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sources":{"get":{"operationId":"listSources","summary":"Source catalog","description":"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.","x-price":"Free","tags":["Meta"],"security":[],"parameters":[{"name":"status","in":"query","required":false,"description":"Only sources with this status.","schema":{"enum":["served","registered","held","not-covered"]}},{"name":"state","in":"query","required":false,"description":"Only sources covering this state (two-letter code); nationwide sources always match.","schema":{"type":"string"}},{"name":"dataset","in":"query","required":false,"description":"Only sources feeding this dataset id (the datasets list in the answer).","schema":{"type":"string"}},{"name":"licence","in":"query","required":false,"description":"Only sources whose terms have this status.","schema":{"enum":["open","attribution","unclear","permission","licensed","held","paid","not-recorded"]}},{"name":"q","in":"query","required":false,"description":"Text in the id, name, publisher or what it provides.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Sources per page, 1 to 1000. Default 100.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"offset","in":"query","required":false,"description":"Skip this many matches (next_offset from the previous page).","schema":{"type":"integer","minimum":0}},{"name":"format","in":"query","required":false,"description":"csv: every match as a CSV file instead of a JSON page.","schema":{"enum":["json","csv"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["total","offset","limit","next_offset","counts","sources","datasets","notes"],"properties":{"total":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"next_offset":{"type":["integer","null"]},"counts":{"type":"object","properties":{"status":{"type":"object","additionalProperties":{"type":"integer"}},"licence":{"type":"object","additionalProperties":{"type":"integer"}}}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CatalogSource"}},"datasets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"group":{"type":"string"}}}},"notes":{"type":"array","items":{"type":"string"}}}}}}},"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sources/{id}":{"get":{"operationId":"getSource","summary":"One source","description":"One source from the catalog, by its id (GET /sources lists them). No key needed.","x-price":"Free","tags":["Meta"],"security":[],"parameters":[{"name":"id","in":"path","required":true,"description":"The source's id, e.g. FL-MDC-PERMITS.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CatalogSource"}}}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fields":{"get":{"operationId":"fields","summary":"Where fields","description":"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.","x-price":"Free","tags":["Find"],"parameters":[{"name":"type","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"county","in":"query","required":false,"description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","required":["types","operators","grammar","coverage_scope"],"properties":{"types":{"type":"array","items":{"$ref":"#/components/schemas/FieldCatalogType"}},"operators":{"type":"array","items":{"type":"string"}},"grammar":{"type":"string"},"coverage_scope":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/exports":{"post":{"operationId":"createExport","summary":"Export properties as CSV or NDJSON","description":"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.","x-price":"$1.00 per 1,000 rows","tags":["Find"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Send in (a market by name) or within (a GeoJSON polygon), not both.","properties":{"type":{"const":"properties"},"where":{"type":"array","items":{"type":"string"}},"in":{"type":"string"},"within":{"$ref":"#/components/schemas/Within"},"format":{"enum":["csv","ndjson"],"default":"csv"},"max_rows":{"type":"integer","maximum":100000},"max_cost_usd":{"type":"number"}}}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"status":{"enum":["ready","empty"]},"total":{"type":"integer"},"scope":{"type":"string"},"resolved_scope":{"$ref":"#/components/schemas/ResolvedScope"},"file":{"type":["object","null"],"properties":{"url":{"type":"string"},"format":{"enum":["csv","ndjson"]},"rows":{"type":"integer"},"columns":{"type":"array","items":{"type":"string"}},"expires_at":{"type":"string","format":"date-time"}}},"rows_left_out":{"type":"integer"},"limit_note":{"type":"string"},"sources":{"type":"array","items":{"type":"object"}},"preview":{"type":"array","items":{"type":"object"}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/exports/download/{file}":{"get":{"operationId":"downloadExport","summary":"Download an export","description":"The file link from POST /exports; it carries its own token.","x-price":"Free (charged when prepared)","tags":["Find"],"security":[],"parameters":[{"name":"file","in":"path","required":true,"description":"File name.","schema":{"type":"string"}},{"name":"token","in":"query","required":true,"description":"From the link.","schema":{"type":"string"}}],"responses":{"200":{"description":"The file, in the format it was prepared in. X-West-Kite-Total-Rows gives its row count.","content":{"text/csv":{"schema":{"type":"string"}},"application/x-ndjson":{"schema":{"type":"string"}}}},"404":{"description":"Expired or revoked"}}}},"/research":{"get":{"operationId":"listResearch","summary":"The team's research runs","description":"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.","x-price":"Free","tags":["Research"],"parameters":[{"name":"status","in":"query","required":false,"description":"queued, running, complete or failed.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 to 100 (default 25).","schema":{"type":"integer"}},{"name":"cursor","in":"query","required":false,"description":"next_cursor from the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/ResearchRun"}},"open":{"type":"object","properties":{"queued":{"type":"integer"},"running":{"type":"integer"}}},"next_cursor":{"type":["string","null"]}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"startResearch","summary":"Research owners","description":"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.","x-price":"$0.10 per property","tags":["Research"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property_ids"],"properties":{"property_ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"webhook_url":{"type":"string","format":"uri","maxLength":2000,"description":"An https:// URL on a public host (no credentials in it) to POST each finished run to."}}}}}},"responses":{"202":{"description":"Accepted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/ResearchRun"}},"webhook_url":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/research/{id}":{"get":{"operationId":"getResearch","summary":"A research run","description":"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.","x-price":"Free","tags":["Research"],"parameters":[{"name":"id","in":"path","required":true,"description":"Run id.","schema":{"type":"string"}},{"name":"wait","in":"query","required":false,"description":"Seconds, up to 60.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"$ref":"#/components/schemas/ResearchRun"},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts":{"post":{"operationId":"revealContact","summary":"Reveal a contact","description":"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.","x-price":"Email $0.50, phone $1.00, LinkedIn $0.50; all: $1.00 with a phone, $0.50 without","tags":["Research"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["person_id","channel"],"properties":{"person_id":{"type":"string"},"channel":{"enum":["email","phone","linkedin","all"]}}}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"insufficient_balance, spend_limit_exceeded","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/requests":{"post":{"operationId":"requestData","summary":"Ask for data","description":"Ask for data West Kite does not have yet: say what you need in note, and where in place. kind is optional.","x-price":"Free","tags":["Meta"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["note"],"properties":{"note":{"type":"string","maxLength":2000},"place":{"type":"string","maxLength":200},"kind":{"enum":["place","field","source","other"]},"field":{"type":"string","maxLength":120}}}}}},"responses":{"201":{"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/balance":{"get":{"operationId":"balance","summary":"Balance","description":"The team's plan and balance.","x-price":"Free","tags":["Account"],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","properties":{"plan":{"enum":["free","starter","growth","pro"]},"balance_usd":{"type":"number"},"available_usd":{"type":"number"},"included_resets_at":{"type":["string","null"]},"limits":{"$ref":"#/components/schemas/Limits"},"key":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["data","research","contacts"]}}}}}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usage":{"get":{"operationId":"usage","summary":"Usage","description":"Calls and charges per day and by operation.","x-price":"Free","tags":["Account"],"parameters":[{"name":"days","in":"query","required":false,"description":"1 to 30. Default 7.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","required":["data","missing","billing","request_id"],"properties":{"data":{"type":"object","additionalProperties":true},"missing":{"type":"array","items":{"$ref":"#/components/schemas/MissingField"}},"billing":{"$ref":"#/components/schemas/Billing"},"request_id":{"type":"string"}}}}}},"400":{"description":"invalid_request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"scope_missing","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"idempotency_conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"internal_error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"wk_live_ key"},"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Property":{"type":"object","required":["id","county_fips","property_type","updated_at"],"description":"One property as the property_fact contract states it. A null field is one the source does not state: never zero.","properties":{"id":{"type":"string","description":"property:<uuid>"},"address":{"type":["string","null"]},"city":{"type":["string","null"]},"neighborhood":{"type":["string","null"]},"state":{"type":["string","null"],"description":"Two-letter code."},"county":{"type":["string","null"]},"county_fips":{"type":"string"},"apn":{"type":["string","null"]},"coordinates":{"type":["array","null"],"items":{"type":"number"},"minItems":2,"maxItems":2,"description":"[longitude, latitude]"},"point_basis":{"type":["string","null"]},"property_kind":{"type":"string"},"property_type":{"type":"string"},"subtype":{"type":["string","null"]},"property_type_basis":{"type":"string"},"general_commercial":{"type":"boolean","description":"A commercial parcel whose roll records no specific use."},"building_sqft":{"type":["integer","null"]},"lot_sqft":{"type":["integer","null"]},"year_built":{"type":["integer","null"]},"stories":{"type":["number","null"]},"units":{"type":["integer","null"]},"derived_units":{"type":["integer","null"],"description":"Units the property's subtype names, from the assessor's use or class code (a duplex is 2, a single-family house or a condominium unit 1), given only where units is null and the building is no more than 10,000 sqft for each such unit. Derived, never the record's own count; filters and sorts on units do not read it."},"derived_units_basis":{"type":["string","null"],"description":"How derived_units was derived: the subtype it comes from."},"bedrooms":{"type":["number","null"]},"bathrooms":{"type":["number","null"]},"zoning_code":{"type":["string","null"]},"zoning_class":{"type":["string","null"],"enum":["commercial","industrial","residential","mixed use",null]},"flood_zone":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"owner_type":{"type":["string","null"],"enum":["government","nonprofit","llc","corporation","trust","estate","individual",null]},"owner_since":{"type":["string","null"],"format":"date"},"held_years":{"type":["integer","null"],"description":"Whole years since the current owner took title (owner_since)."},"last_sale_date":{"type":["string","null"],"format":"date"},"last_sale_date_precision":{"type":["string","null"],"enum":["day","month",null]},"last_sale_price":{"type":["number","null"]},"last_sale_portfolio_price":{"type":["number","null"],"description":"A portfolio total the last sale was recorded at: never this property's own price."},"market_value":{"type":["number","null"]},"assessed_value":{"type":["number","null"]},"taxable_value":{"type":["number","null"]},"tax_amount":{"type":["number","null"]},"valuation_year":{"type":["integer","null"]},"wetland_pct":{"type":["number","null"],"description":"Share of the parcel that is mapped wetland (USFWS NWI), 0 to 100. Unit: percent of parcel. find filters on it as wetland_pct. Absent when not measured; a measured 0 or false is a value."},"flood_sfha_pct":{"type":["number","null"],"description":"Share of the parcel in a FEMA special flood hazard area (the 1% annual chance floodplain), 0 to 100. Unit: percent of parcel. find filters on it as floodplain_pct (or flood_sfha_pct). Absent when not measured; a measured 0 or false is a value."},"upland_acres":{"type":["number","null"],"description":"Acres outside the floodplain, wetlands and water. Unit: acres. find filters on it as upland_acres. Absent when not measured; a measured 0 or false is a value."},"largest_upland_acres":{"type":["number","null"],"description":"The largest contiguous upland piece. Unit: acres. find filters on it as largest_upland_acres. Absent when not measured; a measured 0 or false is a value."},"landlocked":{"type":["boolean","null"],"description":"True when no public road lies within 20 m of the parcel; false when one does. find filters on it as site_access (or landlocked). Absent when not measured; a measured 0 or false is a value."},"road_frontage_ft":{"type":["number","null"],"description":"Parcel edge along public roads. Unit: feet. find filters on it as road_frontage_ft. Absent when not measured; a measured 0 or false is a value."},"water_frontage_ft":{"type":["number","null"],"description":"Parcel edge along water (USGS NHD). Unit: feet. find filters on it as water_frontage_ft. Absent when not measured; a measured 0 or false is a value."},"waterfront_type":{"type":["string","null"],"description":"Kind of water the parcel fronts: bay, canal, coast, lake, pond, river, stream or swamp. find filters on it as waterfront (or waterfront_type). Absent when not measured; a measured 0 or false is a value."},"assemblage":{"oneOf":[{"type":"object","required":["id","parcel_count","property_ids","more_available","combined_acres","basis"],"description":"Adjoining parcels held by the same owner: served properties whose parcel outlines touch or lie within 10 m (a road or alley between them still counts) and whose owner names share one normalized key, joined in a chain (A next to B next to C is one group). Derived by West Kite, never published by a source. Government owners, blank owners and condo units are never grouped, and parcels across a state line are not compared.","properties":{"id":{"type":"string","description":"assemblage:<uuid>, stable while the group's smallest member stays in it."},"parcel_count":{"type":"integer","minimum":2,"description":"Members, this property included."},"property_ids":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"property:<uuid> of every member, sorted, at most 100."},"more_available":{"type":"boolean","description":"property_ids lists fewer than parcel_count."},"combined_acres":{"type":["number","null"],"description":"Area of the union of the members' parcel outlines, acres (not the rolls' lot areas)."},"basis":{"type":"string","enum":["derived: adjoining parcels (touching or within 10 m) with the same normalized owner"]}}},{"type":"null"}],"description":"null when the property is in no assemblage. A state not computed yet, or a read that failed, is also null and is listed in missing (property.assemblage), so null without a missing entry means no adjoining parcel shares the owner."},"updated_at":{"type":"string","format":"date-time","description":"When West Kite last rebuilt this record from its sources."}}},"Fact":{"type":"object","required":["label","value","number","unit"],"description":"A fact as the record shows it, with its number read out when it is one.","properties":{"label":{"type":"string"},"value":{"type":"string","description":"As displayed: \"915,935 sf\"."},"number":{"type":["number","null"],"description":"The number (915935) when value is one number; null for codes, names and identifiers (\"0325031\")."},"unit":{"type":["string","null"],"enum":["sqft","acres","ft","usd","percent","units","stories","years",null]},"group":{"type":"string"},"source_ids":{"type":"array","items":{"type":"string"}}}},"CatalogSource":{"type":"object","additionalProperties":false,"description":"One source in the catalog. Null is not recorded, never zero.","required":["id","name","publisher","url","provides","datasets","coverage","method","method_label","delivery","cadence","licence","status","status_label","reason","last_load","last_check","last_run","manifest"],"properties":{"id":{"type":"string","description":"The manifest's id: the id property records cite."},"name":{"type":"string"},"publisher":{"type":"string"},"url":{"type":["string","null"]},"provides":{"type":"string","description":"What it gives us, in a few words."},"datasets":{"type":"array","items":{"type":"string"},"description":"Dataset ids it feeds."},"coverage":{"type":"object","required":["label","states","counties"],"properties":{"label":{"type":"string"},"states":{"oneOf":[{"const":"all"},{"type":"array","items":{"type":"string"}}]},"counties":{"type":["array","null"],"items":{"type":"string"}}}},"method":{"type":["string","null"],"enum":["arcgis","socrata","bulk-file","api","web-pages","map-tiles","records-request","release",null]},"method_label":{"type":["string","null"]},"delivery":{"enum":["stored","release","live"]},"cadence":{"type":["string","null"],"description":"How often we look for a new copy, as the manifest says it. Null for live reads."},"licence":{"type":"object","required":["status","label","text","terms_url","attribution","redistribution","rights_record_on_file"],"properties":{"status":{"enum":["open","attribution","unclear","permission","licensed","held","paid","not-recorded"]},"label":{"type":"string"},"text":{"type":["string","null"],"description":"The terms as recorded."},"terms_url":{"type":["string","null"]},"attribution":{"type":"string","description":"The credit line to show."},"redistribution":{"type":"string","description":"What the terms allow, read from the status alone."},"rights_record_on_file":{"type":"boolean","description":"A written licence or permission record is on file."}}},"status":{"enum":["served","registered","held","not-covered"]},"status_label":{"type":"string"},"reason":{"type":["string","null"],"description":"Why it is held or not covered."},"last_load":{"type":["object","null"],"properties":{"release":{"type":"string"},"loaded_at":{"type":"string","format":"date-time"},"records":{"type":"integer"}},"description":"The serving release that last loaded it."},"last_check":{"type":["object","null"],"properties":{"checked_at":{"type":["string","null"],"format":"date-time"},"outcome":{"type":["string","null"]}},"description":"The last check of the publisher for a new copy."},"last_run":{"type":["object","null"],"description":"The newest run report from the ingestion line, and its last successful run that changed something.","properties":{"run":{"enum":["build","load"]},"verdict":{"type":["string","null"],"enum":["pass","hold",null]},"finished_at":{"type":"string","format":"date-time"},"release":{"type":["string","null"]},"rows":{"type":["integer","null"],"description":"Rows the run loaded, or mapped for a build."},"failed_checks":{"type":"array","items":{"type":"string"}},"last_success_at":{"type":["string","null"],"format":"date-time"}}},"manifest":{"type":"string","description":"Where the source is defined in West Kite's repository."}}},"Source":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"url":{"type":"string"},"observed_at":{"type":"string"}}},"PropertyImage":{"type":"object","required":["property_id","source","publisher","year","license","credit","width","height","outline","years","available_years"],"properties":{"property_id":{"type":"string"},"source":{"type":"string","description":"The imagery's name."},"publisher":{"type":"string"},"year":{"type":["integer","null"],"description":"The year flown; null when the flight can't be dated."},"flown":{"type":["string","null"]},"resolution_inches":{"type":"number"},"license":{"enum":["public-domain","open","no-restriction-stated","permission"]},"license_url":{"type":"string"},"permission":{"type":"string","description":"The grant, when license is permission."},"credit":{"type":"string","description":"Show it wherever the photo is shown."},"width":{"type":"integer"},"height":{"type":"integer"},"outline":{"type":["object","null"],"description":"The parcel outline as GeoJSON, or null with a note."},"note":{"type":"string"},"years":{"type":"array","description":"Every year with a photo of the lot, newest first. The default photo is the first; year=Y serves the entry for Y.","items":{"type":"object","required":["year","source","publisher","resolution_inches","license"],"properties":{"year":{"type":"integer"},"source":{"type":"string"},"publisher":{"type":"string"},"resolution_inches":{"type":"number"},"license":{"enum":["public-domain","open","no-restriction-stated","permission"]}}}},"available_years":{"type":"array","items":{"type":"integer"},"description":"The years in years, as plain numbers."}}},"MissingField":{"type":"object","required":["field","reason"],"properties":{"field":{"type":"string"},"reason":{"enum":["not_covered","not_published","not_on_record","not_found","temporarily_unavailable"],"description":"not_covered on a find: a where field West Kite holds for under 5% of properties in the scope (rows filtered on it are only that share)."},"note":{"type":"string"}}},"ResolvedScope":{"type":"object","required":["input","kind","label","county_fips","includes_neighboring_places","basis"],"description":"Where a find searched.","properties":{"input":{"type":["string","null"],"description":"in as sent; null for near, within or no place."},"kind":{"enum":["city","metro","county","state","zip","place","point","polygon","nationwide"],"description":"city: the city's own records; metro: a city read as its county (no city boundary held); place: a region, or a New York City or San Francisco neighborhood, the search resolved."},"label":{"type":"string"},"county_fips":{"type":"array","items":{"type":"string"},"description":"The counties searched, when the scope is a set of counties; empty for a point, polygon, ZIP or a place the search resolved."},"includes_neighboring_places":{"type":"boolean","description":"True when the search reaches past the named place, e.g. a city read as its whole county."},"basis":{"enum":["city_records","counties","county","state_counties","zip_boundary","radius","polygon","search_resolved","all_coverage"]},"radius_m":{"type":"number"},"note":{"type":"string"}}},"Within":{"description":"A GeoJSON Polygon or MultiPolygon, or a Feature holding one: up to 8 polygons, up to 40 vertices each, outer rings only (no holes), [longitude, latitude], inside the United States.","oneOf":[{"type":"object","required":["type","coordinates"],"properties":{"type":{"enum":["Polygon","MultiPolygon"]},"coordinates":{"type":"array"}}},{"type":"object","required":["type","geometry"],"properties":{"type":{"const":"Feature"},"geometry":{"type":"object"}}}]},"Billing":{"type":"object","required":["operation_id","operation","charged_usd","balance_usd"],"properties":{"operation_id":{"type":"string"},"operation":{"type":"string"},"charged_usd":{"type":"number"},"balance_usd":{"type":"number"},"replayed":{"type":"boolean"}}},"Error":{"type":"object","properties":{"error":{"type":"object","required":["code","message","retryable","docs_url"],"properties":{"code":{"enum":["invalid_request","invalid_key","insufficient_balance","spend_limit_exceeded","max_cost_too_low","scope_missing","not_found","idempotency_conflict","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"docs_url":{"type":"string"},"reason":{"type":"string","description":"invalid_key: revoked, expired or unknown. rate_limited: requests (per minute), concurrency (in flight), agent_questions (the Agent's own cap) or agent_signups (sign-ups started)."},"retry_after":{"type":"integer"},"upgrade_url":{"type":"string"},"quoted_usd":{"type":"number"},"concurrent":{"type":"integer"},"balance_usd":{"type":"number"},"available_usd":{"type":"number"},"spend_cap_usd":{"type":"number"},"spent_usd":{"type":"number"}}},"request_id":{"type":"string"}}},"Limits":{"type":"object","required":["requests_per_minute","concurrent","research_concurrent"],"properties":{"requests_per_minute":{"type":"integer"},"concurrent":{"type":"integer","description":"Requests in flight at once for the team."},"research_concurrent":{"type":"integer","description":"Owner research runs at once; extra runs queue."}}},"Establishment":{"type":"object","required":["id","kind","source"],"description":"A named operator at an address from a public register: a bank branch, licence, care facility, school and so on.","properties":{"id":{"type":"string","description":"establishment:<key>, stable across refreshes of the same source record."},"kind":{"type":"string","enum":["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"],"x-enum-descriptions":{"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"}},"category":{"type":["string","null"],"description":"The kind's own category as published (main_office, on_premise, nursing_home)."},"name":{"type":["string","null"],"description":"The business name at the premises (a bank's name for its branch, a licence's trade name)."},"operator":{"type":["string","null"],"description":"The operating organisation, when the register names one. Individuals are never published here."},"identifier":{"type":["string","null"],"description":"The publisher's own key: FDIC branch number, licence number, CMS certification number."},"status":{"type":["string","null"]},"opened_on":{"type":["string","null"],"format":"date"},"closed_on":{"type":["string","null"],"format":"date"},"address":{"type":["string","null"],"description":"The premises address as published."},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"county_fips":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"coordinates":{"type":["array","null"],"items":{"type":"number"},"description":"[longitude, latitude] as published."},"property_id":{"type":["string","null"],"description":"property:<uuid> when exactly one property matched the address or published point."},"link":{"type":"object","properties":{"method":{"type":["string","null"],"enum":["address","point_in_parcel",null]},"candidates":{"type":["integer","null"],"description":"Properties matched: 1 linked, more ambiguous (condo units), 0 none."}}},"details":{"type":"object","additionalProperties":true,"description":"The kind's own published facts, snake_case: deposits, beds, licence class, owner flags."},"first_seen":{"type":["string","null"],"format":"date"},"last_seen":{"type":["string","null"],"format":"date"},"source":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"publisher":{"type":"string"},"url":{"type":"string"},"as_of":{"type":"string","format":"date"},"licence":{"type":"string"}}}}},"EstablishmentCoverage":{"type":"object","required":["kind","state","status"],"properties":{"kind":{"type":"string"},"state":{"type":"string","description":"Two-letter state, or US for the whole country when no source for the kind is loaded anywhere."},"status":{"type":"string","enum":["covered","partial","not_covered"]},"note":{"type":["string","null"]}}},"PropertySummary":{"type":"object","additionalProperties":true,"description":"A property's facts from the published fact row, the same row the app's list, map and filters read. A fact that is not published is absent (placeholders are listed in missing), never zero.","properties":{"id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"neighborhood":{"type":"string"},"apn":{"type":"string","description":"The parcel number as the county writes it."},"coordinates":{"type":["array","null"],"items":{"type":"number"},"description":"[longitude, latitude]."},"property_type":{"type":"string"},"subtype":{"type":"string","description":"The publisher's use below the type."},"general_commercial":{"type":"boolean","description":"A commercial parcel whose roll records no specific use."},"building_sqft":{"type":["number","null"],"description":"Building area, square feet."},"lot_sqft":{"type":["number","null"],"description":"Lot area, square feet."},"year_built":{"type":["number","null"],"description":"Year built."},"zoning":{"type":["string","null"],"description":"Zoning code as published."},"owner_name":{"type":["string","null"],"description":"Owner of record as the publisher writes it."},"held_years":{"type":["number","null"],"description":"Whole years since the current owner took title."},"last_sale_price":{"type":["number","null"],"description":"Last sale price, US dollars."},"last_sale_date":{"type":["string","null"],"description":"YYYY-MM-DD, or YYYY-MM when the sale is known only to the month."},"updated_at":{"type":"string"},"signals":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"tone":{"type":"string"}}},"description":"Research signals (Long-held, Underbuilt, Recent permit, Tenant change); often empty."},"market_value":{"type":["number","null"],"description":"Assessor's market value, US dollars (not an appraisal)."},"assessed_value":{"type":["number","null"],"description":"Assessed value, US dollars (the tax basis)."},"taxable_value":{"type":["number","null"],"description":"Taxable value after exemptions, US dollars."},"tax_amount":{"type":["number","null"],"description":"Annual property tax, US dollars."},"valuation_year":{"type":["number","null"],"description":"Roll year of the values."},"units":{"type":["number","null"],"description":"Units."},"stories":{"type":["number","null"],"description":"Stories."},"bedrooms":{"type":["number","null"],"description":"Bedrooms."},"bathrooms":{"type":["number","null"],"description":"Bathrooms."},"flood_zone":{"type":["string","null"],"description":"FEMA flood zone as the assessor or flood map publishes it."},"owner_type":{"enum":["government","nonprofit","llc","corporation","trust","estate","individual"],"description":"Owner class read from the owner name. find filters on it as owner_type."},"zoning_class":{"enum":["commercial","industrial","residential","mixed use"],"description":"The zoning code read by its opening letters: a reading, not a legal finding. find filters on it as zoning_class."},"flood_sfha_pct":{"type":"number","description":"Share of the parcel in a FEMA special flood hazard area (the 1% annual chance floodplain), 0 to 100. Unit: percent of parcel. find filters on it as floodplain_pct (or flood_sfha_pct). Absent when not measured; a measured 0 or false is a value."},"wetland_pct":{"type":"number","description":"Share of the parcel that is mapped wetland (USFWS NWI), 0 to 100. Unit: percent of parcel. find filters on it as wetland_pct. Absent when not measured; a measured 0 or false is a value."},"upland_acres":{"type":"number","description":"Acres outside the floodplain, wetlands and water. Unit: acres. find filters on it as upland_acres. Absent when not measured; a measured 0 or false is a value."},"largest_upland_acres":{"type":"number","description":"The largest contiguous upland piece. Unit: acres. find filters on it as largest_upland_acres. Absent when not measured; a measured 0 or false is a value."},"road_frontage_ft":{"type":"number","description":"Parcel edge along public roads. Unit: feet. find filters on it as road_frontage_ft. Absent when not measured; a measured 0 or false is a value."},"landlocked":{"type":"boolean","description":"True when no public road lies within 20 m of the parcel; false when one does. find filters on it as site_access (or landlocked). Absent when not measured; a measured 0 or false is a value."},"water_frontage_ft":{"type":"number","description":"Parcel edge along water (USGS NHD). Unit: feet. find filters on it as water_frontage_ft. Absent when not measured; a measured 0 or false is a value."},"waterfront_type":{"type":"string","description":"Kind of water the parcel fronts: bay, canal, coast, lake, pond, river, stream or swamp. find filters on it as waterfront (or waterfront_type). Absent when not measured; a measured 0 or false is a value."}}},"SiteFacts":{"type":"object","additionalProperties":false,"description":"Per-parcel site facts only the stored site-facts record carries, measured over the parcel outline from FEMA NFHL, USFWS NWI, Census TIGER and OpenStreetMap roads, USGS NHD and county layers. The site facts every record can carry (wetlandPct, floodSfhaPct, uplandAcres, largestUplandAcres, landlocked, roadFrontageFt, waterFrontageFt, waterfrontType) are on property. Absent when the county was not measured; GET /v1/coverage field_share says which counties carry which facts.","properties":{"parcel_gis_sqft":{"type":"number","description":"Area of the parcel outline as mapped. Unit: square feet. Absent when not measured; a measured 0 or false is a value."},"flood_zone":{"type":"string","description":"The FEMA NFHL zone covering the largest share of the parcel outline (the record's floodZone is the assessor's). Absent when not measured; a measured 0 or false is a value."},"flood_zone_shares":{"type":"object","additionalProperties":{"type":"number"},"description":"Each FEMA zone's share of the parcel, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"floodway_pct":{"type":"number","description":"Share of the parcel in a regulatory floodway, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"flood_bfe_ft":{"type":"number","description":"FEMA base flood elevation over the parcel. Unit: feet. Absent when not measured; a measured 0 or false is a value."},"flood_map_date":{"type":"string","format":"date","description":"Effective date of the FEMA flood map read (YYYY-MM-DD). Absent when not measured; a measured 0 or false is a value."},"deepwater_pct":{"type":"number","description":"Share of the parcel that is open water in the NWI, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"wetland_types":{"type":"object","additionalProperties":{"type":"number"},"description":"Each NWI wetland type's share of the parcel, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"upland_pct":{"type":"number","description":"Upland share of the parcel, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"nearest_road_m":{"type":"number","description":"Distance from the parcel to the nearest public road. Unit: meters. Absent when not measured; a measured 0 or false is a value."},"frontage_roads":{"type":"array","items":{"type":["string","object"]},"description":"The roads the parcel fronts, as stored: names, or objects naming each road. Absent when not measured; a measured 0 or false is a value."},"frontage_surface":{"type":"string","description":"Surface of the fronting road (paved, unpaved). Absent when not measured; a measured 0 or false is a value."},"unpaved_only_access":{"type":"boolean","description":"True when every fronting road is unpaved. Absent when not measured; a measured 0 or false is a value."},"water_body_name":{"type":"string","description":"Name of the water the parcel fronts. Absent when not measured; a measured 0 or false is a value."},"water_pct":{"type":"number","description":"Share of the parcel that is water, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"vacant_class":{"type":"string","description":"The vacant land class read from the parcel. Absent when not measured; a measured 0 or false is a value."},"zoning_shares":{"type":"object","additionalProperties":{"type":"number"},"description":"Each zoning district's share of the parcel, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"zoning_jurisdiction":{"type":"string","description":"The government whose zoning map was read. Absent when not measured; a measured 0 or false is a value."},"future_land_use":{"type":"string","description":"Future land use designation covering the largest share of the parcel. Absent when not measured; a measured 0 or false is a value."},"future_land_use_description":{"type":"string","description":"The designation as the plan describes it. Absent when not measured; a measured 0 or false is a value."},"future_land_use_shares":{"type":"object","additionalProperties":{"type":"number"},"description":"Each designation's share of the parcel, 0 to 100. Unit: percent of parcel. Absent when not measured; a measured 0 or false is a value."},"future_land_use_jurisdiction":{"type":"string","description":"The government whose plan was read. Absent when not measured; a measured 0 or false is a value."},"water_service_area":{"type":"boolean","description":"True when the parcel lies in a mapped public water service area. Absent when not measured; a measured 0 or false is a value."},"water_provider":{"type":"string","description":"The water utility serving the area. Absent when not measured; a measured 0 or false is a value."},"sewer_service_area":{"type":"boolean","description":"True when the parcel lies in a mapped sewer service area. Absent when not measured; a measured 0 or false is a value."},"sewer_provider":{"type":"string","description":"The sewer utility serving the area. Absent when not measured; a measured 0 or false is a value."},"flwmi_drinking_water":{"type":"string","description":"Florida Water Management Inventory drinking water code. Absent when not measured; a measured 0 or false is a value."},"flwmi_wastewater":{"type":"string","description":"Florida Water Management Inventory wastewater code. Absent when not measured; a measured 0 or false is a value."},"plat_name":{"type":"string","description":"The recorded plat or subdivision the parcel lies in. Absent when not measured; a measured 0 or false is a value."},"nearest_aadt":{"type":"number","description":"Annual average daily traffic at the nearest state DOT count station within 500 m. Unit: vehicles per day. Absent when not measured; a measured 0 or false is a value."},"nearest_aadt_year":{"type":"number","description":"Year of that traffic count. Absent when not measured; a measured 0 or false is a value."},"nearest_aadt_road":{"type":"string","description":"Road of that count station. Absent when not measured; a measured 0 or false is a value."},"nearest_aadt_m":{"type":"number","description":"Distance to that count station. Unit: meters. Absent when not measured; a measured 0 or false is a value."}}},"PropertyRecord":{"type":"object","additionalProperties":true,"required":["id"],"description":"property is the typed record; the parts asked for sit beside it by name. A part that could not be read is { not_checked: true, retry } and is listed in missing.","properties":{"id":{"type":"string"},"property":{"$ref":"#/components/schemas/Property"},"note":{"type":"string"},"overview":{"type":"object","additionalProperties":true,"properties":{"records":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"site_facts":{"$ref":"#/components/schemas/SiteFacts"},"facts":{"type":"array","description":"Key facts as the property page shows them.","items":{"$ref":"#/components/schemas/Fact"}},"flags":{"type":"array","items":{"type":"object"}},"transfer":{"type":"object"},"assessment":{"type":["object","null"]},"activity":{"type":"array","items":{"type":"object"}},"unknowns":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}}}}}},"fields":{"type":"object","additionalProperties":true,"properties":{"records":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"site_facts":{"$ref":"#/components/schemas/SiteFacts"},"recorded_fields":{"type":"array","description":"Every publisher field stored for the property, per source record, as published (label, group and display value).","items":{"type":"object","properties":{"source_id":{"type":"string"},"as_of":{"type":["string","null"]},"fields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"group":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}},"sales":{"oneOf":[{"$ref":"#/components/schemas/SalesPart"},{"$ref":"#/components/schemas/NotChecked"}]},"assessments":{"oneOf":[{"$ref":"#/components/schemas/AssessmentsPart"},{"$ref":"#/components/schemas/NotChecked"}]},"zoning":{"oneOf":[{"$ref":"#/components/schemas/ZoningPart"},{"$ref":"#/components/schemas/NotChecked"}]},"permits":{"oneOf":[{"$ref":"#/components/schemas/PermitsPart"},{"$ref":"#/components/schemas/NotChecked"}]},"planning":{"oneOf":[{"$ref":"#/components/schemas/PlanningPart"},{"$ref":"#/components/schemas/NotChecked"}]},"events":{"oneOf":[{"$ref":"#/components/schemas/EventsPart"},{"$ref":"#/components/schemas/NotChecked"}]},"owner":{"oneOf":[{"$ref":"#/components/schemas/OwnerPart"},{"$ref":"#/components/schemas/NotChecked"}]},"loans":{"oneOf":[{"$ref":"#/components/schemas/LoansPart"},{"$ref":"#/components/schemas/NotChecked"}]},"outline":{"oneOf":[{"$ref":"#/components/schemas/OutlinePart"},{"$ref":"#/components/schemas/NotChecked"},{"type":"null"}]}}},"PartSource":{"type":"object","additionalProperties":false,"required":["id","label","publisher","url","observed_at","effective_at"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"publisher":{"type":["string","null"]},"url":{"type":["string","null"]},"observed_at":{"type":["string","null"],"description":"When West Kite read the source."},"effective_at":{"type":["string","null"],"description":"The date the source's data is current to, where it states one."}}},"NotChecked":{"type":"object","additionalProperties":false,"required":["not_checked","retry"],"properties":{"not_checked":{"const":true},"retry":{"type":"string","description":"The call that reads this part alone."}},"description":"A part that could not be read just now; it is also listed in missing."},"Sale":{"type":"object","additionalProperties":false,"required":["id","basis","date","date_precision","recording_date","document_number","transfer_type","qualification","price_scope","price","transaction_price","allocated_price","currency","lot_count","buyers","sellers","source_id"],"properties":{"id":{"type":["string","null"]},"basis":{"enum":["recorded_sale","assessor_roll"],"description":"recorded_sale: a transfer the recorder or a sales file publishes. assessor_roll: the roll's last-sale date (and price, where stated), given only when no recorded transfer is held."},"date":{"type":["string","null"],"description":"YYYY-MM-DD, YYYY-MM or YYYY, as precise as the source: the same convention as property.last_sale_date."},"date_precision":{"enum":["day","month","year","unknown"]},"recording_date":{"type":["string","null"],"description":"When the document was recorded. YYYY-MM-DD.","format":"date"},"document_number":{"type":["string","null"],"description":"The recorder's document or reference number."},"transfer_type":{"type":["string","null"],"description":"The publisher's deed or transfer type."},"qualification":{"type":["string","null"],"description":"Whether the publisher counts it as an arm's-length sale (qualified, unqualified, other-transfer, unknown)."},"price_scope":{"type":["string","null"],"description":"individual (one property), portfolio (one price for several), or unknown when the source does not say."},"price":{"type":["number","null"],"description":"US dollars attributable to this property: the whole price of an individual sale, or its allocated share of a portfolio. Null when neither is stated."},"transaction_price":{"type":["number","null"],"description":"The transaction's total consideration as recorded; for a portfolio it covers every property in it."},"allocated_price":{"type":["number","null"],"description":"This property's share of a portfolio price, where the publisher allocates one."},"currency":{"type":["string","null"]},"lot_count":{"type":["integer","null"],"description":"Parcels the transaction conveyed, where stated."},"buyers":{"type":"array","items":{"type":"string"},"description":"Grantees as recorded."},"sellers":{"type":"array","items":{"type":"string"},"description":"Grantors as recorded."},"source_id":{"type":["string","null"]}}},"SalesPart":{"type":"object","additionalProperties":false,"required":["sales","more_available","sources"],"properties":{"sales":{"type":"array","items":{"$ref":"#/components/schemas/Sale"},"description":"Newest first."},"more_available":{"type":"boolean","description":"True when the property's record holds more than it returned here (the record itself is capped)."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"Assessment":{"type":"object","additionalProperties":false,"required":["id","roll_year","state","basis","land_value","improvement_value","total_assessed_value","market_value","market_value_label","assessed_value_label","land_value_label","taxable_value","tax_amount","fixtures_value","personal_property_value","last_sale_price","last_sale_type","characteristics","as_of","source_ids"],"properties":{"id":{"type":"string"},"roll_year":{"type":["integer","null"]},"state":{"type":"string","description":"observed, inferred, conflicting, not-observed, not-applicable or unattributed."},"basis":{"type":["string","null"]},"land_value":{"type":["number","null"]},"improvement_value":{"type":["number","null"]},"total_assessed_value":{"type":["number","null"],"description":"The assessed value (the tax basis), not a market valuation."},"market_value":{"type":["number","null"],"description":"The publisher's own market or appraised value."},"market_value_label":{"type":["string","null"],"description":"What the publisher calls it."},"assessed_value_label":{"type":["string","null"]},"land_value_label":{"type":["string","null"]},"taxable_value":{"type":["number","null"]},"tax_amount":{"type":["number","null"]},"fixtures_value":{"type":["number","null"]},"personal_property_value":{"type":["number","null"]},"last_sale_price":{"type":["number","null"],"description":"The roll's last-sale price for that year."},"last_sale_type":{"type":["string","null"]},"characteristics":{"type":"object","additionalProperties":{"type":["string","number"]},"description":"The roll's building and land characteristics for that year (use_code, year_built, building_sqft, lot_sqft, stories, units, zoning_code, …), only those it states."},"as_of":{"type":["string","null"]},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"AssessmentsPart":{"type":"object","additionalProperties":false,"required":["assessments","more_available","sources"],"properties":{"assessments":{"type":"array","items":{"$ref":"#/components/schemas/Assessment"},"description":"Newest roll first; a roll loaded twice appears once."},"more_available":{"type":"boolean","description":"True when the property's record holds more than it returned here (the record itself is capped)."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"PermitStatus":{"type":"object","additionalProperties":false,"required":["status","effective_on","source_ids"],"properties":{"status":{"type":["string","null"]},"effective_on":{"type":["string","null"],"description":"When the status took effect. YYYY-MM-DD.","format":"date"},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"Permit":{"type":"object","additionalProperties":false,"required":["id","number","type_code","title","description","status","filed_on","issued_on","completed_on","recorded_on","url","status_history","state","source_ids"],"properties":{"id":{"type":"string"},"number":{"type":["string","null"]},"type_code":{"type":["string","null"]},"title":{"type":"string"},"description":{"type":["string","null"],"description":"The work description as the publisher wrote it."},"status":{"type":["string","null"],"description":"The publisher's current status: not proof the work was completed."},"filed_on":{"type":["string","null"],"description":"Filed. YYYY-MM-DD.","format":"date"},"issued_on":{"type":["string","null"],"description":"Issued. YYYY-MM-DD.","format":"date"},"completed_on":{"type":["string","null"],"description":"Completed or finaled. YYYY-MM-DD.","format":"date"},"recorded_on":{"type":["string","null"],"description":"The one date an activity record gives when it is not split into filed, issued and completed. YYYY-MM-DD.","format":"date"},"url":{"type":["string","null"],"description":"The publisher's page for this permit, or its dataset."},"status_history":{"type":"array","items":{"$ref":"#/components/schemas/PermitStatus"}},"state":{"type":"string"},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"PermitsPart":{"type":"object","additionalProperties":false,"required":["permits","more_available","sources"],"properties":{"permits":{"type":"array","items":{"$ref":"#/components/schemas/Permit"},"description":"Newest first."},"more_available":{"type":"boolean","description":"True when the property's record holds more than it returned here (the record itself is capped)."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"PublicRecord":{"type":"object","additionalProperties":false,"required":["id","label","category","relationship","caveat","as_of","fields","source_id"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"category":{"type":"string"},"relationship":{"type":"string","description":"How the record is tied to the property."},"caveat":{"type":["string","null"]},"as_of":{"type":["string","null"]},"fields":{"type":"object","additionalProperties":true,"description":"The record's fields as the publisher names them."},"source_id":{"type":"string"}}},"ZoningDistrict":{"type":"object","additionalProperties":false,"required":["layer","label","value","state","note","as_of","source_ids"],"properties":{"layer":{"enum":["base","height_bulk","special_use"]},"label":{"type":"string"},"value":{"type":["string","null"]},"state":{"type":"string"},"note":{"type":["string","null"]},"as_of":{"type":["string","null"]},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"ZoningLimits":{"type":"object","additionalProperties":false,"required":["zoning_code","zoning_districts","built_far","max_far","max_residential_far","max_commercial_far","max_community_facility_far","max_manufacturing_far","unused_zoning_floor_area","historic_district","landmark","roll_year","source_ids"],"properties":{"zoning_code":{"type":["string","null"]},"zoning_districts":{"type":["string","null"]},"built_far":{"type":["number","null"]},"max_far":{"type":["number","null"]},"max_residential_far":{"type":["number","null"]},"max_commercial_far":{"type":["number","null"]},"max_community_facility_far":{"type":["number","null"]},"max_manufacturing_far":{"type":["number","null"]},"unused_zoning_floor_area":{"type":["number","null"],"description":"Square feet."},"historic_district":{"type":["string","null"]},"landmark":{"type":["string","null"]},"roll_year":{"type":["integer","null"]},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}},"description":"Zoning figures the assessor or land-use file publishes for the lot."},"MapZoningDistrict":{"type":"object","additionalProperties":false,"required":["code","name","class","class_label","jurisdiction","source"],"properties":{"code":{"type":"string","description":"The local zone code as the city or county publishes it, e.g. M1-2 or I-1."},"name":{"type":["string","null"],"description":"The district's local name or description, when the layer gives one."},"class":{"enum":["residential","multifamily","commercial","office","mixed","industrial","agricultural","open","public","planned","other"],"description":"A broad class read from the local name and code: a reading, not a legal category."},"class_label":{"type":"string"},"jurisdiction":{"type":["string","null"],"description":"The city, town, township or county whose zoning this is."},"source":{"type":"object","additionalProperties":false,"required":["id","publisher","name","url","vintage"],"properties":{"id":{"type":"string"},"publisher":{"type":["string","null"]},"name":{"type":["string","null"]},"url":{"type":["string","null"]},"vintage":{"type":["string","null"]}},"description":"The published zoning layer the district comes from."}},"description":"A district on West Kite's national zoning map: the jurisdiction's own published code and name."},"ZoningPart":{"type":"object","additionalProperties":false,"required":["zoning_code","districts","map_district","limits","designations","capacity","records","sources"],"properties":{"zoning_code":{"type":["string","null"],"description":"The zoning code as published on the assessor or land-use roll."},"districts":{"type":"array","items":{"$ref":"#/components/schemas/ZoningDistrict"},"description":"Districts from a city's zoning map layers, where West Kite holds them."},"map_district":{"oneOf":[{"$ref":"#/components/schemas/MapZoningDistrict"},{"type":"null"}],"description":"The district on West Kite's national zoning map at the lot's point (the same answer as GET /v1/zoning). null where the map has no district there."},"limits":{"oneOf":[{"$ref":"#/components/schemas/ZoningLimits"},{"type":"null"}]},"designations":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["kind","text","as_of","source_id"],"properties":{"kind":{"type":"string"},"text":{"type":"string"},"as_of":{"type":["string","null"]},"source_id":{"type":"string"}}},"description":"Plan designations an area overlay gives the lot (a General Plan land use, a transit tier, a historic zone)."},"capacity":{"type":["object","null"],"description":"New York City only: floor area by use under the zoning resolution, from lot area and district. An estimate, not a zoning determination.","additionalProperties":true},"records":{"type":"array","items":{"$ref":"#/components/schemas/PublicRecord"},"description":"Zoning records linked to the lot."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"PlanningProject":{"type":"object","additionalProperties":false,"required":["id","project_number","type","description","status","effective_on","link_method","source_ids"],"properties":{"id":{"type":"string"},"project_number":{"type":["string","null"]},"type":{"type":"string"},"description":{"type":["string","null"]},"status":{"type":["string","null"]},"effective_on":{"type":["string","null"],"description":"The record's date. YYYY-MM-DD.","format":"date"},"link_method":{"type":"string"},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"PlanningContextItem":{"type":"object","additionalProperties":false,"required":["id","date","title","detail","record_type","relationship","as_of","source_ids"],"properties":{"id":{"type":"string"},"date":{"type":["string","null"],"description":"The record's date. YYYY-MM-DD.","format":"date"},"title":{"type":"string"},"detail":{"type":"string"},"record_type":{"enum":["project","non-project","unclassified"]},"relationship":{"enum":["subject-property","nearby-context","unresolved"]},"as_of":{"type":["string","null"]},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"PlanningPart":{"type":"object","additionalProperties":false,"required":["projects","projects_total","context","records","sources"],"properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/PlanningProject"},"description":"Planning applications linked to the lot."},"projects_total":{"type":"integer"},"context":{"type":"array","items":{"$ref":"#/components/schemas/PlanningContextItem"},"description":"Planning records at or near the lot from a city's planning layers."},"records":{"type":"array","items":{"$ref":"#/components/schemas/PublicRecord"},"description":"Other planning records linked to the lot."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"PropertyEventItem":{"type":"object","additionalProperties":false,"required":["id","category","title","detail","status","date","filed_on","issued_on","completed_on","source_ids"],"properties":{"id":{"type":"string"},"category":{"enum":["violation","inspection","planning","ownership","other"],"description":"The record's own category, lower-cased: violation (code, housing and building violations, unsafe-structure cases), inspection (inspections, complaints, device and facade filings, food inspections), or other (orders, licences, court cases and the rest)."},"title":{"type":"string","description":"The record as the publisher names it; an old snapshot says so with its year."},"detail":{"type":["string","null"],"description":"The publisher's description, codes and amounts, as written."},"status":{"type":["string","null"],"description":"The publisher's status (Open, Closed, Unsafe, a grade), as of the source's date."},"date":{"type":["string","null"],"description":"The record's date: when the case was opened or the inspection made. YYYY-MM-DD.","format":"date"},"filed_on":{"type":["string","null"],"description":"Filed or opened. YYYY-MM-DD.","format":"date"},"issued_on":{"type":["string","null"],"description":"Issued or ordered. YYYY-MM-DD.","format":"date"},"completed_on":{"type":["string","null"],"description":"Closed, resolved or completed. YYYY-MM-DD.","format":"date"},"source_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the sources in this part's sources that state it."}}},"EventsPart":{"type":"object","additionalProperties":false,"required":["events","more_available","next_cursor","violation_counts","sources"],"properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/PropertyEventItem"},"description":"Newest first. Permits, sales and assessments are their own parts and are not repeated here."},"more_available":{"type":"boolean","description":"True when the property's record holds more than it returned here (the record itself is capped)."},"next_cursor":{"type":["string","null"],"description":"Pass as events_cursor (with parts=events) for the next page; null at the end. Opaque; it carries the place in both the violations and the other records."},"violation_counts":{"oneOf":[{"type":"object","additionalProperties":false,"required":["total","open"],"properties":{"total":{"type":"integer"},"open":{"type":"integer","description":"Open as the publishers report it."}}},{"type":"null"}],"description":"Every violation on record for the property, beyond the ones listed. null when the record holds no count."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/PartSource"},"description":"Exactly the sources the items in this part cite, each once."}}},"OutlinePart":{"type":"object","required":["type","geometry","properties"],"additionalProperties":false,"description":"The property's accepted parcel outline as one GeoJSON Feature, [longitude, latitude] in WGS 84: the outline the map draws and GET /v1/properties/{id}/image outlines. A property on several lots is their union; a condominium unit leaves out the shared common lot. null, and listed in missing, when no accepted outline is on record.","properties":{"type":{"const":"Feature"},"geometry":{"type":"object","required":["type","coordinates"],"properties":{"type":{"enum":["Polygon","MultiPolygon"]},"coordinates":{"type":"array"}}},"properties":{"type":"object","required":["parcel_count","parcel_ids","area_sqft","simplified"],"properties":{"parcel_count":{"type":"integer","description":"Lots the outline unions."},"parcel_ids":{"type":"array","items":{"type":"string"},"description":"parcel:<uuid> of each lot."},"area_sqft":{"type":"integer","description":"Ground area of the outline (geodesic), in square feet. Not the assessor's lot size, which is property.lot_sqft."},"simplified":{"type":"boolean","description":"True when the published outline had more than 20,000 vertices and was simplified to about 0.5 m."}}}}},"LoansPart":{"type":"object","additionalProperties":true,"description":"Debt on public record: CMBS loans from SEC filings, active HUD/FHA multifamily mortgages and, in New York City, mortgages recorded against the lot. A field the filing does not report is absent.","properties":{"loans":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"deal_id":{"type":"string"},"deal_name":{"type":"string"},"original_amount":{"type":"number"},"actual_balance":{"type":"number"},"scheduled_balance":{"type":"number"},"interest_rate":{"type":"number","description":"A fraction (0.0393 is 3.93%)."},"origination_date":{"type":"string"},"maturity_date":{"type":"string"},"payment_status_code":{"type":"string"},"modified":{"type":"boolean"},"property_count":{"type":"integer"},"terms":{"type":"object"},"evidence":{"type":"object","description":"The filing it was read from."},"collateral":{"type":"array","items":{"type":"object","additionalProperties":true}},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"role":{"type":"string"}}}}}},"description":"CMBS loans, the newest report linked to this property for each."},"hud_fha":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"project_number":{"type":"string"},"property_name":{"type":"string"},"original_mortgage_amount":{"type":"number"},"amortized_balance":{"type":"number"},"interest_rate_percent":{"type":"number"},"maturity_date":{"type":"string"},"holder_name":{"type":"string"},"servicer_name":{"type":"string"},"source_as_of":{"type":"string"},"source_url":{"type":"string"}}}},"recorded_debt":{"type":["object","null"],"additionalProperties":true,"description":"New York City: mortgages, assignments and satisfactions recorded against the lot (ACRIS). No term is published, so no maturity."},"coverage":{"type":"object","additionalProperties":true,"properties":{"state":{"enum":["available","not-observed","disabled"]},"last_checked_at":{"type":["string","null"]},"latest_reported_at":{"type":["string","null"]},"missing_periods":{"type":"array","items":{"type":"string"}},"pending_documents":{"type":"integer"},"unsupported_documents":{"type":"integer"},"note":{"type":"string"}}},"rate_summary":{"type":"object","additionalProperties":true,"properties":{"loans_with_rate":{"type":"integer"},"loans_without_rate":{"type":"integer"},"simple_average_rate_percent":{"type":["number","null"]},"balance_weighted_rate_percent":{"type":["number","null"]},"weighted_balance":{"type":"number"}}}}},"ResearchResult":{"type":"object","description":"Who owns and runs the property, from saved research, without person contacts (POST /v1/contacts reveals them).","properties":{"names_person":{"type":"boolean","description":"True when the research reached a person through the owner, operator, manager or a broker. Names that appear only on planning and permit filings (applicants, their architects and expediters) do not count: a run with only those is not charged."},"owner_of_record":{"type":["string","null"]},"people":{"type":"array","items":{"type":"object","properties":{"person_id":{"type":"string"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"available":{"type":"object","description":"What is already on file and reveals at once. A channel marked false is still looked up when you ask POST /v1/contacts, and a lookup that finds nothing costs nothing.","properties":{"email":{"type":"boolean"},"phone":{"type":"boolean"},"linkedin":{"type":"boolean"}}}}},"description":"Best contacts first: the owner's principals and managers, a small owner company's officers, operators and property managers, brokers, a large company's officers and directors, registered agents, people whose role is not yet confirmed, then people known only from planning filings."},"companies":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"website":{"type":["string","null"]}}},"description":"The owner first, then parent companies, operators and managers, brokers, and companies known only from planning filings. A role of parking_operator is read from the company's name (the word parking or a national operator's brand), not from a filing."},"sources":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"publisher":{"type":["string","null"]}}}},"summary":{"type":"array","items":{"type":"string"}}}},"OwnerPart":{"type":"object","additionalProperties":false,"required":["research","last_researched_at","research_running"],"properties":{"research":{"oneOf":[{"$ref":"#/components/schemas/ResearchResult"},{"type":"null"}],"description":"Null when no research is on file: POST /v1/research runs it."},"last_researched_at":{"type":["string","null"]},"research_running":{"type":"boolean"}},"description":"Saved owner research only; reading it never starts a run."},"FieldCatalogType":{"type":"object","additionalProperties":false,"required":["type","summary","source","sort","fields"],"properties":{"type":{"enum":["properties","sales","permits","tax_notices","distress_filings","recorded_loans","cmbs_loans","reit_properties","sba_loans","sba_lenders","warn_notices","listings","facilities","establishments","government_comps"]},"summary":{"type":"string"},"source":{"type":"string","description":"Where this type's records come from."},"sort":{"type":"array","items":{"type":"string"},"description":"What sort takes; - for largest or newest first."},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CatalogField"}}}},"CatalogField":{"type":"object","additionalProperties":false,"required":["name","type","unit","operators","values","sortable","description","source","coverage"],"properties":{"name":{"type":"string","description":"The field as a where clause names it."},"type":{"enum":["string","number","integer","boolean","date","enum"]},"unit":{"type":["string","null"],"description":"usd, sqft, acres, ft, percent, ratio, year, years, units, stories, …; null for text, codes and counts without one."},"operators":{"type":"array","items":{"enum":["=","!=","~",">=","<=","between","in","is known","is unknown"]}},"values":{"type":["array","null"],"items":{"type":"string"},"description":"The values the field takes, where it takes a fixed list."},"sortable":{"type":"boolean"},"description":{"type":"string","description":"What the field is and how its operators behave, as find describes it."},"source":{"type":"string"},"coverage":{"type":["number","null"],"description":"Share of served properties in scope that carry the field, 0 to 1. Null for other types, for property fields West Kite does not measure, and when shares could not be read (then listed in missing)."}}},"ScreenTopic":{"type":"object","properties":{"answer":{"type":"string"},"tone":{"enum":["good","neutral","watch","bad"]},"note":{"type":["string","null"]},"findings":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"detail":{"type":["string","null"]},"tone":{"type":"string"},"source_id":{"type":"string"},"facts":{"type":"array","items":{"type":"object"}}}}}}},"NearbyFeature":{"type":"object","required":["kind","name","distance_m"],"properties":{"kind":{"enum":["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"]},"name":{"type":"string"},"detail":{"type":["string","null"]},"distance_m":{"type":"number","description":"Straight-line meters; 0 when the point lies inside the feature (a service area)."},"distance_miles":{"type":"number"},"direction":{"type":["string","null"]},"facts":{"type":"array","items":{"$ref":"#/components/schemas/Fact"}},"url":{"type":"string"},"source":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"publisher":{"type":"string"},"url":{"type":"string"},"vintage":{"type":["string","null"]}}}}},"SearchHit":{"type":"object","required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"match":{"enum":["address","apn","owner","name"],"description":"What kind of match it is."},"exact":{"type":"boolean","description":"False for the closest records held when nothing matched exactly."},"confidence":{"type":"number","minimum":0,"maximum":1,"description":"How sure the match is, 0 to 1. Act on the first result alone only at 0.9 or more; below that, show the choices."},"reason":{"enum":["exact","suffix_variant","direction_variant","range","alternate","spelling","nearby_number","geocoded","prefix","apn","owner","name","street"],"description":"Why it matched. Addresses: exact (as filed), suffix_variant (another street type), direction_variant, range (inside a filed number range), alternate (one of the lot's other addresses), spelling (a corrected street name), geocoded (the parcel where a geocoder puts the address), prefix (starts with the text typed). Others: apn, owner, name, street."},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"coordinates":{"type":"array","items":{"type":"number"}},"nearest":{"type":"boolean"},"distance_m":{"type":"number"}}},"ResearchRun":{"type":"object","properties":{"id":{"type":"string"},"property_id":{"type":"string"},"status":{"enum":["queued","running","complete","failed"]},"created_at":{"type":"string"},"completed_at":{"type":["string","null"]},"status_url":{"type":"string"},"queue_position":{"type":"integer","description":"While queued: 1 starts next."},"poll_after_seconds":{"type":"integer"},"error_code":{"type":"string"},"progress":{"type":"object","description":"While queued or running.","properties":{"stage":{"type":"string"},"message":{"type":"string"},"sources_read":{"type":"integer"},"people_found":{"type":"integer"},"elapsed_seconds":{"type":"integer"},"typical_seconds":{"type":"integer"},"estimated_seconds_remaining":{"type":"integer"}}},"charged_usd":{"type":"number"},"result":{"type":["object","null"],"properties":{"names_person":{"type":"boolean","description":"True when the research reached a person through the owner, operator, manager or a broker. Names that appear only on planning and permit filings (applicants, their architects and expediters) do not count: a run with only those is not charged."},"owner_of_record":{"type":["string","null"]},"people":{"type":"array","description":"Best contacts first: the owner's principals and managers, a small owner company's officers, operators and property managers, brokers, a large company's officers and directors, registered agents, people whose role is not yet confirmed, then people known only from planning filings.","items":{"type":"object","properties":{"person_id":{"type":"string"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"available":{"type":"object","description":"What is already on file and reveals at once. A channel marked false is still looked up when you ask POST /v1/contacts, and a lookup that finds nothing costs nothing.","properties":{"email":{"type":"boolean"},"phone":{"type":"boolean"},"linkedin":{"type":"boolean"}}}}}},"companies":{"type":"array","description":"The owner first, then parent companies, operators and managers, brokers, and companies known only from planning filings. A role of parking_operator is read from the company's name (the word parking or a national operator's brand), not from a filing.","items":{"type":"object"}},"sources":{"type":"array","items":{"type":"object"}},"summary":{"type":"array","items":{"type":"string"}}}}}}},"headers":{"RateLimit-Limit":{"description":"Requests per minute on the team's plan.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current minute.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the minute resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-Request-Id":{"description":"The request's id, as request_id in the body.","schema":{"type":"string"}},"X-Charged-USD":{"description":"What a non-JSON answer (the image) was charged.","schema":{"type":"number"}},"X-Balance-USD":{"description":"The balance after a non-JSON answer.","schema":{"type":"number"}},"X-Imagery-Source":{"description":"The imagery's name.","schema":{"type":"string"}},"X-Imagery-Year":{"description":"The year it was flown, or unknown.","schema":{"type":"string"}},"X-Imagery-Credit":{"description":"The credit line to show with the photo.","schema":{"type":"string"}},"X-Imagery-License":{"description":"The imagery's license status.","schema":{"enum":["public-domain","open","no-restriction-stated","permission"]}}}}}