input | string | object | Input The address (or point) exactly as sent. |
status | string | Status ok | not_found | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged Whether this record incurred its pay-per-event charge (the address event; add-on charges are listed in chargedAddOns). |
chargedEvent | string | Charged event Pay-per-event event charged for this record (present only when charged): address. |
chargedCount | integer | Events charged Events actually charged when the charge came back short of the requested count (present only then; a warning explains it). |
chargedAddOns | array | Charged add-ons Add-on events charged for this record besides chargedEvent (present only then): flood-zone. |
source | string | Source Upstream data source: us-census-geocoder (with FEMA NFHL and the FCC Area API for the optional fields). |
fetchedAt | string | Fetched at ISO timestamp. |
error | object | Error { code, message, provider?, status? } when status is not ok. Codes: not_found (no match, or a point outside the US), ambiguous_address (several candidates, see candidates), invalid_input; set by the runtime: budget_exhausted, free_plan_limit, unmetered, aborted, charge_failed, record_too_large, invalid_record, dataset_push_failed; upstream: http_error (with the HTTP status), network, tls_error, timeout, invalid_json, unexpected_type, too_large, invalid_response. |
warnings | array | Warnings Notes about this record: a flood zone that was not charged or not available, an FCC lookup that failed, a charge that came back short. |
inputType | string | null | Input type address | coordinates. |
matchType | string | null | Match type exact (the match agrees with every part of the input) | non_exact (the Census corrected or completed the address: check matchedAddress) | tie (several candidates, not charged) | no_match (not charged) | null for coordinate inputs. |
matchedAddress | string | null | Matched address The address as the Census standardised it, e.g. "1600 PENNSYLVANIA AVE NW, WASHINGTON, DC, 20500". |
latitude | number | null | Latitude WGS84 latitude of the match (interpolated along the street segment), or the input point. |
longitude | number | null | Longitude WGS84 longitude. |
candidates | array | Candidates Only for matchType tie: up to 10 { matchedAddress, latitude, longitude, stateCode, countyFips } the address could be. |
addressComponents | object | null | Address components { houseNumber, street, streetName, city, state, zip } of the matched address (mailing city and state, which can differ from the Census geography, e.g. Washington, DC addresses in Maryland). |
tigerLineId | string | null | TIGER/Line ID Census TIGER/Line edge the address range lies on. |
tigerLineSide | string | null | Street side L or R side of the TIGER/Line edge. |
stateFips | string | null | State FIPS 2-digit state FIPS code of the point (the Census geography). |
stateCode | string | null | State USPS state code of the point. |
stateName | string | null | State name State name. |
countyFips | string | null | County FIPS 5-digit state + county FIPS code. |
countyName | string | null | County County (parish, borough) name. |
tractGeoid | string | null | Census tract GEOID 11-digit state + county + tract code (the key of tract-level ACS tables). |
tractCode | string | null | Tract code 6-digit tract code within the county. |
blockGroupGeoid | string | null | Block group GEOID 12-digit block group GEOID. |
blockGroupCode | string | null | Block group 1-digit block group within the tract. |
blockGeoid | string | null | Block GEOID 15-digit Census block GEOID. |
blockCode | string | null | Block code 4-digit block code within the tract. |
congressionalDistrict | object | null | Congressional district { code, geoid, name, congress }: code is the district number ("00" at large, "98" non-voting delegate), congress e.g. 120. |
stateLegislativeDistrictUpper | object | null | State senate district { geoid, code, name } of the upper-house district. |
stateLegislativeDistrictLower | object | null | State house district { geoid, code, name } of the lower-house district (null where there is none, e.g. DC, Nebraska). |
place | object | null | Place { geoid, code, name, type }: the incorporated place (city, town) or census designated place. |
countySubdivision | object | null | County subdivision { geoid, code, name } (township, town, census county division). |
zcta | string | null | ZCTA ZIP Code Tabulation Area (the Census approximation of a ZIP code area). |
cbsa | object | null | Metro / micro area { geoid, code, name, type }: core-based statistical area, type metropolitan or micropolitan. |
csa | object | null | Combined statistical area { geoid, code, name }. |
metropolitanDivision | object | null | Metropolitan division { geoid, code, name } inside the largest metro areas. |
schoolDistrict | object | null | School district { geoid, code, name, type }: unified, else elementary or secondary district. |
urbanArea | object | null | Urban area { geoid, code, name } (null in rural areas). |
puma | object | null | PUMA { geoid, code, name } Public Use Microdata Area. |
censusRegion | string | null | Census region Northeast, Midwest, South or West. |
censusDivision | string | null | Census division e.g. South Atlantic. |
vintage | string | null | Vintage Census geography vintage used (input vintage). |
floodZone | object | null | Flood zone Only with includeFloodZone: { zone, zoneSubtype, sfha, riskLevel, baseFloodElevation, depth, elevationUnit, verticalDatum, dfirmId, panel, panelEffectiveDate, panelType, otherZones } from FEMA's National Flood Hazard Layer; null when FEMA has no zone at the point (not charged). |
fccArea | object | null | FCC area Only with includeFccArea: { blockFips, blockPopulation2020, countyFips, countyName, stateFips, stateCode, stateName, marketAreas: { cma, pea, bta, mta, bea, eag, mea, rea, rpc, vpc, ivm, amt } }. |
raw | object | Raw Only with includeRaw: the unmodified census, fema and fcc answers. |