{ "info": { "name": "Atlasblock API", "description": "The Atlasblock neighborhood API — scored ratings, climate, demographics, housing, schools, crime, and more for any US zip or address. Set the `apiKey` collection variable to your key (ab_live_… or ab_test_…), then send any request. The base URL is the `baseUrl` variable. Full docs: https://atlasblock.dev/docs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://atlasblock.dev/api", "type": "string" }, { "key": "apiKey", "value": "ab_live_your_key_here", "type": "string" } ], "item": [ { "name": "Regions", "description": "The broadest tier: the four US Census regions and their divisions.", "item": [ { "name": "GET /regions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/regions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "regions" ] }, "description": "The four US Census regions, each with its divisions and aggregate counts." }, "response": [] }, { "name": "GET /regions/{region}/states", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/regions/:region/states", "host": [ "{{baseUrl}}" ], "path": [ "v1", "regions", ":region", "states" ], "variable": [ { "key": "region", "value": "{region}", "description": "Region slug: northeast, midwest, south, or west." } ] }, "description": "The states that make up a Census region." }, "response": [] }, { "name": "GET /regions/{region}/counties", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/regions/:region/counties", "host": [ "{{baseUrl}}" ], "path": [ "v1", "regions", ":region", "counties" ], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ], "variable": [ { "key": "region", "value": "{region}", "description": "Region slug: northeast, midwest, south, or west." } ] }, "description": "Every county in a Census region (paginated)." }, "response": [] } ] }, { "name": "States", "description": "Every state with metadata, its counties, rollups, and lookup.", "item": [ { "name": "GET /states", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/states", "host": [ "{{baseUrl}}" ], "path": [ "v1", "states" ] }, "description": "Every US state, DC, and territory with Census metadata and live counts." }, "response": [] }, { "name": "GET /states/{state}/summary", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/states/:state/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "states", ":state", "summary" ], "variable": [ { "key": "state", "value": "{state}", "description": "USPS state code (e.g. NC)." } ] }, "description": "State rollup: crime and school counts across the state." }, "response": [] }, { "name": "GET /states/{state}/counties", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/states/:state/counties", "host": [ "{{baseUrl}}" ], "path": [ "v1", "states", ":state", "counties" ], "query": [ { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ], "variable": [ { "key": "state", "value": "{state}", "description": "USPS state code, full name, or FIPS (e.g. NC)." } ] }, "description": "The counties in a state (paginated)." }, "response": [] }, { "name": "POST /states/verify", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/states/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "states", "verify" ] }, "description": "Resolve a state abbreviation, full name, or FIPS to its canonical record.", "body": { "mode": "raw", "raw": "{\"value\":\"north carolina\"}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Counties", "description": "County list, rollups, the schools within a county, and lookup.", "item": [ { "name": "GET /counties", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/counties", "host": [ "{{baseUrl}}" ], "path": [ "v1", "counties" ], "query": [ { "key": "state", "value": "", "description": "USPS state code, full name, or FIPS.", "disabled": true }, { "key": "region", "value": "", "description": "Region slug: northeast, midwest, south, or west.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "County list, filterable by state or Census region (paginated)." }, "response": [] }, { "name": "GET /counties/{countyFips}/summary", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/counties/:countyFips/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "counties", ":countyFips", "summary" ], "variable": [ { "key": "countyFips", "value": "{countyFips}", "description": "5-digit county FIPS code (e.g. 37119)." } ] }, "description": "County rollup: crime and school counts across the county." }, "response": [] }, { "name": "GET /counties/{countyFips}/schools", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/counties/:countyFips/schools", "host": [ "{{baseUrl}}" ], "path": [ "v1", "counties", ":countyFips", "schools" ], "query": [ { "key": "source / level / sector / charter / type", "value": "", "description": "Same filters as /v1/schools.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ], "variable": [ { "key": "countyFips", "value": "{countyFips}", "description": "5-digit county FIPS code (e.g. 37119)." } ] }, "description": "Every school in a county: public K-12, colleges, and private (paginated)." }, "response": [] }, { "name": "POST /counties/verify", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/counties/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "counties", "verify" ] }, "description": "Resolve a county by FIPS, or by name + state (tolerates the \"County\" suffix).", "body": { "mode": "raw", "raw": "{\"name\":\"Mecklenburg\",\"state\":\"NC\"}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Zips", "description": "Zip location, demographics, lookup, verify, and geocoding.", "item": [ { "name": "GET /zips/{zip}", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips/:zip", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", ":zip" ], "variable": [ { "key": "zip", "value": "{zip}", "description": "US zip code." } ] }, "description": "One zip's location and demographics." }, "response": [] }, { "name": "GET /zips", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips" ], "query": [ { "key": "county_fips", "value": "", "description": "5-digit county FIPS. One of county_fips or state is required.", "disabled": true }, { "key": "state", "value": "", "description": "USPS state code (e.g. NC).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Zips within a county or state." }, "response": [] }, { "name": "GET /zips/nearby", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips/nearby", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", "nearby" ], "query": [ { "key": "lat", "value": "", "description": "Latitude of the center point.", "disabled": false }, { "key": "lng", "value": "", "description": "Longitude of the center point.", "disabled": false }, { "key": "radius", "value": "", "description": "Miles (default 10, max 100).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Zips within a radius of a point, sorted by distance." }, "response": [] }, { "name": "POST /zips/verify", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/zips/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", "verify" ] }, "description": "Validate one zip or a batch; returns a valid flag + the canonical record for each.", "body": { "mode": "raw", "raw": "{\"zips\":[\"28203\",\"00000\"]}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "GET /zips/geocode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips/geocode", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", "geocode" ], "query": [ { "key": "address", "value": "", "description": "A full street address to geocode.", "disabled": false } ] }, "description": "Resolve a street address to its canonical zip (via the Census geocoder)." }, "response": [] }, { "name": "GET /zips/reverse-geocode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips/reverse-geocode", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", "reverse-geocode" ], "query": [ { "key": "lat", "value": "", "description": "Latitude of the point.", "disabled": false }, { "key": "lng", "value": "", "description": "Longitude of the point.", "disabled": false } ] }, "description": "Find the nearest zip to a latitude/longitude." }, "response": [] }, { "name": "GET /zips/autocomplete", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/zips/autocomplete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "zips", "autocomplete" ], "query": [ { "key": "query", "value": "", "description": "At least 2 characters. Digits match zip prefixes, text matches city names.", "disabled": false }, { "key": "limit", "value": "", "description": "Max suggestions (default 10, max 25).", "disabled": true } ] }, "description": "Typeahead suggestions by zip prefix or city name." }, "response": [] } ] }, { "name": "Neighborhoods", "description": "Scored profiles for a zip or address, plus discovery: search, rankings, recommend, and look-alikes.", "item": [ { "name": "GET /neighborhood", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Required unless address is given.", "disabled": true }, { "key": "address", "value": "", "description": "Full street address, geocoded to a zip.", "disabled": true }, { "key": "include_summary", "value": "", "description": "Include the AI-written profile. Defaults to true.", "disabled": true } ] }, "description": "Full profile: ratings, climate, demographics, housing, hazards, health, mobility, raw metrics, and an optional AI summary." }, "response": [] }, { "name": "GET /neighborhood/ratings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/ratings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "ratings" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Required unless address is given.", "disabled": true }, { "key": "address", "value": "", "description": "Full street address, geocoded to a zip.", "disabled": true } ] }, "description": "Ratings only: fastest, cache-first, and never triggers an AI call." }, "response": [] }, { "name": "GET /neighborhood/compare", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/compare", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "compare" ], "query": [ { "key": "locations[]", "value": "", "description": "2–4 zips or addresses to compare.", "disabled": false } ] }, "description": "Two to four locations side by side, with the winner of each category." }, "response": [] }, { "name": "GET /neighborhood/batch", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/batch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "batch" ], "query": [ { "key": "zips[]", "value": "", "description": "Up to 25 zip codes.", "disabled": false }, { "key": "fields[]", "value": "", "description": "Restrict the ratings returned (e.g. walkability, safety).", "disabled": true } ] }, "description": "Up to 25 zips in one request, ratings only. Built for scoring many listings." }, "response": [] }, { "name": "GET /neighborhood/search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/search", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "search" ], "query": [ { "key": "state", "value": "", "description": "Scope to a state (USPS code).", "disabled": true }, { "key": "county_fips", "value": "", "description": "Scope to a county.", "disabled": true }, { "key": "region", "value": "", "description": "Scope to a Census region (northeast/midwest/south/west).", "disabled": true }, { "key": "{metric}_min / {metric}_max", "value": "", "description": "Rating bounds 0–10 for any metric (e.g. safety_min=7, affordability_max=5).", "disabled": true }, { "key": "income_min / income_max / rent_min / rent_max", "value": "", "description": "Median household income / gross rent bounds.", "disabled": true }, { "key": "sort", "value": "", "description": "Metric to sort by (default overall).", "disabled": true }, { "key": "order", "value": "", "description": "asc or desc (default desc).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Find zips by rating criteria: filter and sort across the precomputed ratings." }, "response": [] }, { "name": "GET /neighborhood/rankings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/rankings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "rankings" ], "query": [ { "key": "metric", "value": "", "description": "The rating to rank by (default overall).", "disabled": true }, { "key": "state / county_fips / region", "value": "", "description": "Optional geographic scope.", "disabled": true }, { "key": "order", "value": "", "description": "asc or desc (default desc).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Top zips by a single metric, optionally scoped to a state, county, or region." }, "response": [] }, { "name": "POST /neighborhood/recommend", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/neighborhood/recommend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", "recommend" ] }, "description": "Rank the best-fit zips for a set of per-dimension weights (your priorities).", "body": { "mode": "raw", "raw": "{\"weights\":{\"safety\":2,\"affordability\":1},\"state\":\"NC\"}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "GET /neighborhood/{zip}/similar", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/neighborhood/:zip/similar", "host": [ "{{baseUrl}}" ], "path": [ "v1", "neighborhood", ":zip", "similar" ], "query": [ { "key": "national", "value": "", "description": "Search nationwide instead of within the same state.", "disabled": true }, { "key": "limit", "value": "", "description": "How many matches (default 10, max 50).", "disabled": true } ], "variable": [ { "key": "zip", "value": "{zip}", "description": "The zip to find look-alikes for." } ] }, "description": "Neighborhoods with the most similar rating profile to a given zip." }, "response": [] } ] }, { "name": "Demographics", "description": "Who lives here: age, race/ethnicity, education, households, poverty, employment, and income (ACS).", "item": [ { "name": "GET /demographics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/demographics", "host": [ "{{baseUrl}}" ], "path": [ "v1", "demographics" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Who lives here: age, race/ethnicity + diversity, education, households, and the economic picture." }, "response": [] }, { "name": "POST /demographics/compare", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/demographics/compare", "host": [ "{{baseUrl}}" ], "path": [ "v1", "demographics", "compare" ] }, "description": "Demographic profiles for several zips side by side.", "body": { "mode": "raw", "raw": "{\"zips\":[\"28203\",\"10001\"]}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Housing", "description": "Housing stock: value, rent, tenure, vacancy, structure type, age, and affordability (ACS).", "item": [ { "name": "GET /housing", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/housing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "housing" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Housing stock: median value, rent, tenure, vacancy, structure type, and age (ACS)." }, "response": [] }, { "name": "GET /housing/affordability", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/housing/affordability", "host": [ "{{baseUrl}}" ], "path": [ "v1", "housing", "affordability" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Affordability derived from the housing medians and local income." }, "response": [] } ] }, { "name": "Schools", "description": "Individual schools, districts, colleges, search, and verify.", "item": [ { "name": "GET /schools", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Provide zip or county_fips.", "disabled": true }, { "key": "county_fips", "value": "", "description": "5-digit county FIPS; lists every school in the county.", "disabled": true }, { "key": "source", "value": "", "description": "ccd (public K-12), ipeds (colleges), or pss (private).", "disabled": true }, { "key": "level", "value": "", "description": "elementary, middle, high, other, postsecondary.", "disabled": true }, { "key": "sector", "value": "", "description": "public or private.", "disabled": true }, { "key": "charter", "value": "", "description": "Restrict to charter schools.", "disabled": true }, { "key": "type", "value": "", "description": "regular, special_education, vocational, alternative.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Individual schools in a zip: public K-12, colleges, and private, filterable." }, "response": [] }, { "name": "GET /schools/{schoolId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/:schoolId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", ":schoolId" ], "variable": [ { "key": "schoolId", "value": "{schoolId}", "description": "The school id (NCES ncessch for K-12, IPEDS unitid for colleges)." } ] }, "description": "A single school by its NCES (public/private) or IPEDS (college) id." }, "response": [] }, { "name": "GET /schools/nearby", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/nearby", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "nearby" ], "query": [ { "key": "lat", "value": "", "description": "Latitude of the center point.", "disabled": false }, { "key": "lng", "value": "", "description": "Longitude of the center point.", "disabled": false }, { "key": "radius", "value": "", "description": "Miles (default 5, max 50).", "disabled": true }, { "key": "source / level / sector / charter / type", "value": "", "description": "Same filters as /v1/schools.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Schools within a radius of a point, sorted by distance." }, "response": [] }, { "name": "GET /schools/search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/search", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "search" ], "query": [ { "key": "query", "value": "", "description": "At least 2 characters of the school name.", "disabled": false }, { "key": "state", "value": "", "description": "Restrict to a state.", "disabled": true }, { "key": "source / level / sector / charter / type", "value": "", "description": "Same filters as /v1/schools.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Search schools by name (paginated)." }, "response": [] }, { "name": "GET /schools/districts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/districts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "districts" ], "query": [ { "key": "state", "value": "", "description": "USPS state code.", "disabled": true }, { "key": "county_fips", "value": "", "description": "5-digit county FIPS.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Public-school districts, filterable by state or county (paginated)." }, "response": [] }, { "name": "GET /schools/districts/{districtId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/districts/:districtId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "districts", ":districtId" ], "variable": [ { "key": "districtId", "value": "{districtId}", "description": "The district id (NCES leaid)." } ] }, "description": "One district: name, school count, enrollment, and a level breakdown." }, "response": [] }, { "name": "GET /schools/districts/{districtId}/schools", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/districts/:districtId/schools", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "districts", ":districtId", "schools" ], "query": [ { "key": "source / level / sector / charter / type", "value": "", "description": "Same filters as /v1/schools.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ], "variable": [ { "key": "districtId", "value": "{districtId}", "description": "The district id (NCES leaid)." } ] }, "description": "The schools in a district (paginated)." }, "response": [] }, { "name": "GET /schools/colleges", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/schools/colleges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "colleges" ], "query": [ { "key": "state", "value": "", "description": "USPS state code.", "disabled": true }, { "key": "zip", "value": "", "description": "US zip code.", "disabled": true }, { "key": "county_fips", "value": "", "description": "5-digit county FIPS.", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "Colleges and universities (IPEDS), filterable by state, zip, or county (paginated)." }, "response": [] }, { "name": "POST /schools/verify", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/schools/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "schools", "verify" ] }, "description": "Resolve a school by name + zip to its canonical id.", "body": { "mode": "raw", "raw": "{\"name\":\"Myers Park High\",\"zip\":\"28207\"}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Points of Interest", "description": "Individual venues, category counts, and density, live from OpenStreetMap.", "item": [ { "name": "GET /poi", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/poi", "host": [ "{{baseUrl}}" ], "path": [ "v1", "poi" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Required unless address is given.", "disabled": true }, { "key": "address", "value": "", "description": "Full street address, geocoded to a center point.", "disabled": true }, { "key": "category", "value": "", "description": "Filter by one or more (comma-separated): food_drink, nightlife, grocery, parks_recreation, health, fitness, transit, financial, fuel, shopping, civic. Omit for all.", "disabled": true }, { "key": "radius", "value": "", "description": "Miles from the center (default 3, max 25).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Venues per page, nearest first (default 50, max 200).", "disabled": true } ] }, "description": "Individual points of interest around a zip or address, fetched live from OpenStreetMap." }, "response": [] }, { "name": "GET /poi/nearby", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/poi/nearby", "host": [ "{{baseUrl}}" ], "path": [ "v1", "poi", "nearby" ], "query": [ { "key": "lat", "value": "", "description": "Latitude of the center point.", "disabled": false }, { "key": "lng", "value": "", "description": "Longitude of the center point.", "disabled": false }, { "key": "category", "value": "", "description": "Same category filter as /v1/poi. Omit for all.", "disabled": true }, { "key": "radius", "value": "", "description": "Miles from the center (default 2, max 25).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Venues per page, nearest first (default 50, max 200).", "disabled": true } ] }, "description": "Points of interest within a radius of a point, sorted by distance." }, "response": [] }, { "name": "GET /poi/categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/poi/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "poi", "categories" ] }, "description": "The POI category taxonomy and the OSM tags behind each." }, "response": [] }, { "name": "GET /poi/counts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/poi/counts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "poi", "counts" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Required unless address is given.", "disabled": true }, { "key": "address", "value": "", "description": "Full street address, geocoded to a center point.", "disabled": true }, { "key": "radius", "value": "", "description": "Miles from the center (default 3, max 25).", "disabled": true } ] }, "description": "Aggregate venue counts by category around a location (live from OSM)." }, "response": [] }, { "name": "GET /poi/density", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/poi/density", "host": [ "{{baseUrl}}" ], "path": [ "v1", "poi", "density" ], "query": [ { "key": "zip", "value": "", "description": "US zip code. Required unless address is given.", "disabled": true }, { "key": "address", "value": "", "description": "Full street address, geocoded to a center point.", "disabled": true }, { "key": "radius", "value": "", "description": "Miles from the center (default 3, max 25).", "disabled": true } ] }, "description": "Venues per square mile by category around a location (live from OSM)." }, "response": [] } ] }, { "name": "Crime", "description": "County crime rates, national benchmarks, and comparison.", "item": [ { "name": "GET /crime", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/crime", "host": [ "{{baseUrl}}" ], "path": [ "v1", "crime" ], "query": [ { "key": "zip", "value": "", "description": "US zip code (resolved to its county).", "disabled": true }, { "key": "county_fips", "value": "", "description": "5-digit county FIPS. Use instead of zip.", "disabled": true } ] }, "description": "County violent and property crime rates (per 100k), with the state rate for comparison." }, "response": [] }, { "name": "GET /crime/national", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/crime/national", "host": [ "{{baseUrl}}" ], "path": [ "v1", "crime", "national" ] }, "description": "National benchmark crime averages, plus the scoring reference." }, "response": [] }, { "name": "POST /crime/compare", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/crime/compare", "host": [ "{{baseUrl}}" ], "path": [ "v1", "crime", "compare" ] }, "description": "Compare violent and property crime across zips and/or counties.", "body": { "mode": "raw", "raw": "{\"zips\":[\"28203\",\"10001\"]}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Mobility", "description": "Getting around: walkability, transit, bike, and commute for a zip.", "item": [ { "name": "GET /walkability", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/walkability", "host": [ "{{baseUrl}}" ], "path": [ "v1", "walkability" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Per-census-block-group walkability for a zip, plus a min/max/avg summary." }, "response": [] }, { "name": "GET /transit", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/transit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transit" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Transit proximity and intersection density for a zip (EPA block groups)." }, "response": [] }, { "name": "GET /mobility", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/mobility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "mobility" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Combined walk + bike + transit + commute snapshot for a zip." }, "response": [] } ] }, { "name": "Environment", "description": "Objective climate facts (stations, comparison, comfort) and FEMA natural-hazard risk.", "item": [ { "name": "GET /climate", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/climate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "climate" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Objective climate facts from the nearest NOAA station (no score)." }, "response": [] }, { "name": "GET /climate/stations/{stationId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/climate/stations/:stationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "climate", "stations", ":stationId" ], "variable": [ { "key": "stationId", "value": "{stationId}", "description": "NOAA station id (e.g. USW00013881)." } ] }, "description": "One NOAA station's 1991–2020 climate normals." }, "response": [] }, { "name": "GET /climate/nearby", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/climate/nearby", "host": [ "{{baseUrl}}" ], "path": [ "v1", "climate", "nearby" ], "query": [ { "key": "lat", "value": "", "description": "Latitude of the center point.", "disabled": false }, { "key": "lng", "value": "", "description": "Longitude of the center point.", "disabled": false }, { "key": "radius", "value": "", "description": "Miles (default 50, max 200).", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default 1).", "disabled": true }, { "key": "per_page", "value": "", "description": "Results per page (default 25, max 100).", "disabled": true } ] }, "description": "The nearest NOAA stations to a point (paginated)." }, "response": [] }, { "name": "POST /climate/compare", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/climate/compare", "host": [ "{{baseUrl}}" ], "path": [ "v1", "climate", "compare" ] }, "description": "Climate facts for several zips side by side.", "body": { "mode": "raw", "raw": "{\"zips\":[\"28203\",\"59718\"]}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "GET /climate/comfort", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/climate/comfort", "host": [ "{{baseUrl}}" ], "path": [ "v1", "climate", "comfort" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "A derived comfort index (milder = higher) and growing-season length." }, "response": [] }, { "name": "GET /hazards", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/hazards", "host": [ "{{baseUrl}}" ], "path": [ "v1", "hazards" ], "query": [ { "key": "zip", "value": "", "description": "US zip code (resolved to its county).", "disabled": true }, { "key": "county_fips", "value": "", "description": "5-digit county FIPS. Use instead of zip.", "disabled": true } ] }, "description": "Natural-hazard risk for the containing county (FEMA National Risk Index)." }, "response": [] } ] }, { "name": "Health", "description": "Community-health outcomes for a zip (CDC PLACES).", "item": [ { "name": "GET /health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/health", "host": [ "{{baseUrl}}" ], "path": [ "v1", "health" ], "query": [ { "key": "zip", "value": "", "description": "US zip code.", "disabled": false } ] }, "description": "Community-health outcomes for a zip (CDC PLACES adult prevalence, %). Operational status lives at /v1/system/health." }, "response": [] } ] }, { "name": "System", "description": "Operational status.", "item": [ { "name": "GET /system/health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/system/health", "host": [ "{{baseUrl}}" ], "path": [ "v1", "system", "health" ] }, "description": "Operational liveness: per-source data vintages, freshness, and cache status." }, "response": [] } ] } ] }