{ "openapi": "3.1.0", "info": { "title": "geoamcan", "version": "1.0.0", "description": "geoamcan public data API. Data operations require a service bearer token. Discover credential limits and readiness with /v1/capabilities. Public catalog and this contract require no token." }, "paths": { "/health": { "get": { "summary": "Health", "description": "Private database-backed service health. Excluded from usage and rate limits.", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/capabilities": { "get": { "tags": [ "National data warehouse" ], "summary": "Effective credential policy and retrieval contract", "operationId": "capabilities_v1_capabilities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/datasets": { "get": { "tags": [ "National data warehouse" ], "summary": "Installed datasets and verified readiness", "operationId": "datasets_v1_datasets_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/geography/lookup": { "get": { "tags": [ "National data warehouse" ], "summary": "Locate native census geographies by coordinates", "operationId": "geography_v1_geography_lookup_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "lat", "in": "query", "required": true, "schema": { "type": "number", "maximum": 90, "minimum": -90, "title": "Lat" } }, { "name": "lon", "in": "query", "required": true, "schema": { "type": "number", "maximum": 180, "minimum": -180, "title": "Lon" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographyResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/geography/places": { "get": { "tags": [ "National data warehouse" ], "summary": "Discover published city and Census-designated place identifiers", "operationId": "places_v1_geography_places_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{2}$" }, { "type": "null" } ], "title": "State" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{4}$", "default": "2024", "title": "Vintage" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacesResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/demographics": { "get": { "tags": [ "National data warehouse" ], "summary": "Population, housing, affordability and demographics", "operationId": "demographics_v1_demographics_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": true, "schema": { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string", "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 32, "title": "Geoid" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "metrics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metrics" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business-density": { "get": { "tags": [ "National data warehouse" ], "summary": "Published industry establishments, employment and payroll", "operationId": "business_v1_business_density_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": true, "schema": { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string", "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 32, "title": "Geoid" } }, { "name": "naics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "metrics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metrics" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/employment": { "get": { "tags": [ "National data warehouse" ], "summary": "Workplace, resident employment, wages and commuting", "operationId": "employment_v1_employment_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": true, "schema": { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string", "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 32, "title": "Geoid" } }, { "name": "naics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "characteristics", "flows" ], "type": "string", "default": "characteristics", "title": "View" } }, { "name": "flow_direction", "in": "query", "required": false, "schema": { "enum": [ "incoming", "outgoing" ], "type": "string", "default": "incoming", "title": "Flow Direction" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "metrics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metrics" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/economy": { "get": { "tags": [ "National data warehouse" ], "summary": "Regional GDP, income and building permits", "operationId": "economy_v1_economy_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": true, "schema": { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string", "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 32, "title": "Geoid" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "metrics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metrics" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/environment": { "get": { "tags": [ "National data warehouse" ], "summary": "Published hazard, monitored air-quality and release indicators", "operationId": "environment_v1_environment_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": true, "schema": { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string", "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 32, "title": "Geoid" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "metrics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metrics" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/market-profile": { "post": { "tags": [ "National data warehouse" ], "summary": "Combine available native-resolution geographic intelligence", "operationId": "profile_v1_market_profile_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketProfileResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/geography/areas": { "get": { "tags": [ "National data warehouse" ], "summary": "Discover native townships, metropolitan areas, and other published boundaries", "operationId": "areas_v1_geography_areas_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "geo_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string" }, { "type": "null" } ], "title": "Geo Type" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{2}$" }, { "type": "null" } ], "title": "State" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "dataset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacesResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/business-locations": { "get": { "tags": [ "National data warehouse" ], "summary": "Published business and POI locations, categories, source confidence and attribution", "operationId": "business_locations_v1_business_locations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bbox" } }, { "name": "lat", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "title": "Lat" } }, { "name": "lon", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "title": "Lon" } }, { "name": "radius_m", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 200000, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Radius M" } }, { "name": "geo_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string" }, { "type": "null" } ], "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geoid" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "min_confidence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 1, "minimum": 0 }, { "type": "null" } ], "title": "Min Confidence" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturesResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/roads": { "get": { "tags": [ "National data warehouse" ], "summary": "Published road segments, connectors and source routing restrictions", "operationId": "roads_v1_roads_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bbox" } }, { "name": "lat", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 90, "minimum": -90 }, { "type": "null" } ], "title": "Lat" } }, { "name": "lon", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 180, "minimum": -180 }, { "type": "null" } ], "title": "Lon" } }, { "name": "radius_m", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "maximum": 200000, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Radius M" } }, { "name": "geo_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "type": "string" }, { "type": "null" } ], "title": "Geo Type" } }, { "name": "geoid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geoid" } }, { "name": "feature_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "segment", "connector" ], "type": "string" }, { "type": "null" } ], "title": "Feature Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturesResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/spending/groups": { "get": { "tags": [ "National data warehouse" ], "summary": "Discover the native published Consumer Expenditure groups", "operationId": "spending_groups_v1_spending_groups_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 9223372036854775806, "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpendingGroupsResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/geo/analyze": { "post": { "tags": [ "National data warehouse" ], "summary": "Calculate published or spatially estimated ACS intelligence for an area or overlapping selection", "operationId": "geographic_analysis_v1_geo_analyze_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/geo/boundaries": { "get": { "tags": [ "National data warehouse" ], "summary": "Search boundary names or GEOIDs and discover boundaries intersecting a viewport", "operationId": "boundaries_v1_geo_boundaries_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "boundary_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "zcta", "tract", "block_group", "place", "county", "state" ], "type": "string" }, { "type": "null" } ], "title": "Boundary Type" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bbox" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^20\\d{2}$" }, { "type": "null" } ], "title": "Vintage" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacesResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/geo/boundaries/{boundary_type}/{geoid}": { "get": { "tags": [ "National data warehouse" ], "summary": "Retrieve bounded simplified GeoJSON for map rendering", "operationId": "boundary_geometry_v1_geo_boundaries__boundary_type___geoid__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "boundary_type", "in": "path", "required": true, "schema": { "enum": [ "zcta", "tract", "block_group", "place", "county", "state" ], "type": "string", "title": "Boundary Type" } }, { "name": "geoid", "in": "path", "required": true, "schema": { "type": "string", "title": "Geoid" } }, { "name": "zoom", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 22, "minimum": 0, "default": 10, "title": "Zoom" } }, { "name": "vintage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^20\\d{2}$" }, { "type": "null" } ], "title": "Vintage" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoundaryFeatureResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/export": { "post": { "tags": [ "National data warehouse" ], "summary": "Complete resumable nationwide or selected-area NDJSON export", "description": "Each newline-delimited JSON object is an export event. Save checkpoints only after committing preceding records. Resume with the last committed cursor. A 200 HTTP status does not imply completion: require a complete event; an error event means the stream was interrupted. Heartbeats contain no records.", "operationId": "export_v1_export_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportInput" } } }, "required": true }, "responses": { "200": { "description": "One metadata, record, checkpoint, heartbeat, complete or error event per line.", "content": { "application/x-ndjson": { "schema": { "$ref": "#/components/schemas/ExportEvent" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/search/metrics": { "get": { "tags": [ "National data warehouse" ], "summary": "Discover reviewed market metrics and geography compatibility", "operationId": "metrics_v1_search_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/search/validate": { "post": { "tags": [ "National data warehouse" ], "summary": "Validate portable manual or model-generated search criteria", "operationId": "validation_v1_search_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/search/areas": { "post": { "tags": [ "National data warehouse" ], "summary": "Find and rank published markets nationwide or in a working region", "operationId": "areas_v1_search_areas_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/markets/compare": { "post": { "tags": [ "National data warehouse" ], "summary": "Compare up to five published markets with explicit county context", "operationId": "comparison_v1_markets_compare_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompareInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/markets/trends": { "post": { "tags": [ "National data warehouse" ], "summary": "Compare published historical observations without silently mixing vintages", "operationId": "history_v1_markets_trends_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrendsInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrendsResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/search/business-categories": { "get": { "tags": [ "National data warehouse" ], "summary": "Discover published POI categories and reviewed business-brief mappings", "operationId": "categories_v1_search_business_categories_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/search/businesses": { "post": { "tags": [ "National data warehouse" ], "summary": "Search published business locations with full-result counts and spatial filters", "operationId": "locations_v1_search_businesses_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/canada/geographies": { "get": { "tags": [ "Canadian data warehouse" ], "summary": "Discover Canadian native census identifiers and names", "operationId": "geographies_v1_canada_geographies_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "dataset", "in": "query", "required": false, "schema": { "enum": [ "ca-population", "ca-postal-areas", "ca-business-counts", "ca-census-profile", "ca-boundaries", "ca-administrative-boundaries", "ca-business-locations", "ca-roads" ], "type": "string", "default": "ca-population", "title": "Dataset" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "geo_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "national", "province", "census_division", "census_subdivision", "cma_ca", "cma_ca_part", "census_tract", "dissemination_area", "census_fsa" ], "type": "string" }, { "type": "null" } ], "title": "Geo Type" } }, { "name": "geo_uid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Geo Uid" } }, { "name": "dguid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Dguid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 8192 }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanadaResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/canada/metrics": { "get": { "tags": [ "Canadian data warehouse" ], "summary": "Discover Canadian source characteristics, units and definitions", "operationId": "metrics_v1_canada_metrics_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "dataset", "in": "query", "required": false, "schema": { "enum": [ "ca-population", "ca-postal-areas", "ca-business-counts", "ca-census-profile", "ca-boundaries", "ca-administrative-boundaries", "ca-business-locations", "ca-roads" ], "type": "string", "default": "ca-population", "title": "Dataset" } }, { "name": "product_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Product Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 8192 }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanadaResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/canada/data": { "get": { "tags": [ "Canadian data warehouse" ], "summary": "Retrieve Canadian observations, administrative polygons, POIs and roads", "operationId": "data_v1_canada_data_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "dataset", "in": "query", "required": true, "schema": { "enum": [ "ca-population", "ca-postal-areas", "ca-business-counts", "ca-census-profile", "ca-boundaries", "ca-administrative-boundaries", "ca-business-locations", "ca-roads" ], "type": "string", "title": "Dataset" } }, { "name": "dguid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Dguid" } }, { "name": "geo_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "national", "province", "census_division", "census_subdivision", "cma_ca", "cma_ca_part", "census_tract", "dissemination_area", "census_fsa" ], "type": "string" }, { "type": "null" } ], "title": "Geo Type" } }, { "name": "geo_uid", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Geo Uid" } }, { "name": "product_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Product Id" } }, { "name": "characteristic", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Characteristic" } }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Period" } }, { "name": "naics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Naics" } }, { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Bbox" } }, { "name": "feature_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "segment", "connector" ], "type": "string" }, { "type": "null" } ], "title": "Feature Type" } }, { "name": "feature_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Feature Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "geometry", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Geometry" } }, { "name": "zoom", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 22, "minimum": 0, "default": 10, "title": "Zoom" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 8192 }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanadaResponse" } } } }, "422": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Structured service error; retain request_id for diagnosis. Retryable responses may include Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/catalog.json": { "get": { "summary": "Public dataset catalog and measured warehouse totals", "operationId": "public_catalog_catalog_json_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCatalogResponse" } } } }, "503": { "description": "Catalog temporarily unavailable; detail contains the message." } } } } }, "components": { "schemas": { "AnalysisInput": { "properties": { "geometry": { "oneOf": [ { "$ref": "#/components/schemas/Boundary" }, { "$ref": "#/components/schemas/Circle" }, { "$ref": "#/components/schemas/Rectangle" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/Union" } ], "title": "Geometry", "discriminator": { "propertyName": "type", "mapping": { "Polygon": "#/components/schemas/Polygon", "boundary": "#/components/schemas/Boundary", "circle": "#/components/schemas/Circle", "rectangle": "#/components/schemas/Rectangle", "union": "#/components/schemas/Union" } } }, "metrics": { "anyOf": [ { "type": "string", "const": "available" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Metrics", "default": "available" } }, "additionalProperties": false, "type": "object", "required": [ "geometry" ], "title": "AnalysisInput" }, "AnalysisResponse": { "properties": { "status": { "type": "string", "enum": [ "ok", "partial" ], "title": "Status" }, "geography": { "additionalProperties": true, "type": "object", "title": "Geography" }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/MetricResult" }, "type": "object", "title": "Metrics" }, "coverage": { "additionalProperties": true, "type": "object", "title": "Coverage" }, "sources": { "additionalProperties": true, "type": "object", "title": "Sources" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "type": "object", "required": [ "status", "geography", "metrics", "coverage", "sources", "snapshot" ], "title": "AnalysisResponse" }, "ApiOperation": { "properties": { "method": { "type": "string", "title": "Method" }, "path": { "type": "string", "title": "Path" }, "summary": { "type": "string", "title": "Summary" }, "access": { "type": "string", "enum": [ "public", "service_bearer" ], "title": "Access" } }, "type": "object", "required": [ "method", "path", "summary", "access" ], "title": "ApiOperation" }, "Area": { "properties": { "geo_type": { "type": "string", "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "title": "Geo Type" }, "geoid": { "type": "string", "maxLength": 32, "title": "Geoid" } }, "additionalProperties": false, "type": "object", "required": [ "geo_type", "geoid" ], "title": "Area" }, "Boundary": { "properties": { "type": { "type": "string", "const": "boundary", "title": "Type" }, "boundary_type": { "type": "string", "enum": [ "zcta", "tract", "block_group", "place", "county", "state" ], "title": "Boundary Type" }, "geoid": { "type": "string", "maxLength": 12, "title": "Geoid" } }, "additionalProperties": false, "type": "object", "required": [ "type", "boundary_type", "geoid" ], "title": "Boundary" }, "BoundaryFeatureResponse": { "properties": { "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "additionalProperties": true, "type": "object", "title": "Geometry" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "type": "object", "required": [ "type", "geometry", "properties", "snapshot" ], "title": "BoundaryFeatureResponse" }, "BusinessInput": { "properties": { "scope": { "$ref": "#/components/schemas/Scope" }, "q": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Q" }, "categories": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Categories" }, "operating_status": { "anyOf": [ { "type": "string", "enum": [ "open", "closed", "temporarily_closed", "unknown" ] }, { "type": "null" } ], "title": "Operating Status" }, "min_confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Min Confidence" }, "limit": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ], "title": "Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "scope" ], "title": "BusinessInput" }, "BusinessResponse": { "properties": { "applied_criteria": { "additionalProperties": true, "type": "object", "title": "Applied Criteria" }, "features": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Features" }, "summary": { "additionalProperties": true, "type": "object", "title": "Summary" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "source_attribution": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Source Attribution" }, "coverage_limitations": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Coverage Limitations" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "applied_criteria", "features", "summary", "snapshot", "source_attribution", "coverage_limitations", "returned_count", "complete", "next_cursor" ], "title": "BusinessResponse" }, "CanadaResponse": { "properties": { "country": { "type": "string", "const": "CA", "title": "Country", "default": "CA" }, "dataset": { "type": "string", "title": "Dataset" }, "records": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Records" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "next_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Url" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "source_attribution": { "type": "string", "title": "Source Attribution" }, "coverage_limitations": { "items": { "type": "string" }, "type": "array", "title": "Coverage Limitations" } }, "additionalProperties": true, "type": "object", "required": [ "dataset", "records", "returned_count", "complete", "next_cursor", "next_url", "snapshot", "source_attribution", "coverage_limitations" ], "title": "CanadaResponse" }, "CapabilitiesResponse": { "properties": { "rate_policy": { "type": "string", "title": "Rate Policy" }, "requests_per_utc_minute": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Requests Per Utc Minute" }, "maximum_page_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Page Rows" }, "default_page_rows": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Default Page Rows" }, "json_page_memory_target_bytes": { "type": "integer", "title": "Json Page Memory Target Bytes" }, "offset_ceiling": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Offset Ceiling" }, "interactive_request_slots": { "type": "integer", "title": "Interactive Request Slots" }, "export_slots": { "type": "integer", "title": "Export Slots" }, "deadlines_seconds": { "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Deadlines Seconds" }, "pagination": { "additionalProperties": true, "type": "object", "title": "Pagination" }, "export": { "additionalProperties": true, "type": "object", "title": "Export" }, "search": { "additionalProperties": true, "type": "object", "title": "Search" } }, "type": "object", "required": [ "rate_policy", "requests_per_utc_minute", "maximum_page_rows", "default_page_rows", "json_page_memory_target_bytes", "offset_ceiling", "interactive_request_slots", "export_slots", "deadlines_seconds", "pagination", "export" ], "title": "CapabilitiesResponse" }, "CatalogResponse": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "index_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index Version" }, "catalog_version": { "type": "string", "title": "Catalog Version" }, "scoring_version": { "type": "string", "title": "Scoring Version" }, "metrics": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Metrics" }, "limitations": { "items": { "type": "string" }, "type": "array", "title": "Limitations" } }, "additionalProperties": false, "type": "object", "required": [ "enabled", "index_version", "catalog_version", "scoring_version", "metrics", "limitations" ], "title": "CatalogResponse" }, "CatalogSummary": { "properties": { "stored_records": { "type": "integer", "title": "Stored Records" }, "available_datasets": { "type": "integer", "title": "Available Datasets" }, "catalog_datasets": { "type": "integer", "title": "Catalog Datasets" }, "source_agencies": { "type": "integer", "title": "Source Agencies" }, "boundary_records": { "type": "integer", "title": "Boundary Records" } }, "type": "object", "required": [ "stored_records", "available_datasets", "catalog_datasets", "source_agencies", "boundary_records" ], "title": "CatalogSummary" }, "CategoryResponse": { "properties": { "categories": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Categories" }, "mappings": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Mappings" }, "mapping_policy": { "type": "string", "title": "Mapping Policy" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "additionalProperties": false, "type": "object", "required": [ "categories", "mappings", "mapping_policy", "returned_count", "complete", "next_cursor", "snapshot" ], "title": "CategoryResponse" }, "Circle": { "properties": { "type": { "type": "string", "const": "circle", "title": "Type" }, "latitude": { "type": "number", "maximum": 90.0, "minimum": -90.0, "title": "Latitude" }, "longitude": { "type": "number", "maximum": 180.0, "minimum": -180.0, "title": "Longitude" }, "radius_miles": { "type": "number", "maximum": 125.0, "exclusiveMinimum": 0.0, "title": "Radius Miles" } }, "additionalProperties": false, "type": "object", "required": [ "type", "latitude", "longitude", "radius_miles" ], "title": "Circle" }, "CompareInput": { "properties": { "markets": { "items": { "$ref": "#/components/schemas/Market" }, "type": "array", "maxItems": 5, "minItems": 1, "title": "Markets" }, "metrics": { "items": { "type": "string" }, "type": "array", "maxItems": 30, "minItems": 1, "title": "Metrics" }, "priorities": { "items": { "$ref": "#/components/schemas/Priority" }, "type": "array", "maxItems": 20, "title": "Priorities" }, "naics": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" }, "index_version": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Index Version" }, "county_context": { "type": "boolean", "title": "County Context", "default": true } }, "additionalProperties": false, "type": "object", "required": [ "markets" ], "title": "CompareInput" }, "ComparisonResponse": { "properties": { "markets": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Markets" }, "index_version": { "type": "integer", "title": "Index Version" }, "scoring_version": { "type": "string", "title": "Scoring Version" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "additionalProperties": false, "type": "object", "required": [ "markets", "index_version", "scoring_version", "snapshot" ], "title": "ComparisonResponse" }, "DataResponse": { "properties": { "source_attribution": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Source Attribution", "description": "Required source notices." }, "requested_area": { "additionalProperties": true, "type": "object", "title": "Requested Area" }, "data": { "items": { "$ref": "#/components/schemas/Record" }, "type": "array", "title": "Data" }, "availability": { "additionalProperties": true, "type": "object", "title": "Availability" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" }, "returned_count": { "type": "integer", "title": "Returned Count", "default": 0 }, "complete": { "type": "boolean", "title": "Complete", "default": true }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "next_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Url" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "continuations": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Continuations" }, "metric_definitions": { "additionalProperties": true, "type": "object", "title": "Metric Definitions" }, "coverage_limitations": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Coverage Limitations", "description": "Officially unpublished geographic components, retained from release validation. Available observations do not imply complete coverage." }, "native_area_contexts": { "additionalProperties": true, "type": "object", "title": "Native Area Contexts", "description": "Source-specific area identifiers. Point profiles preserve native tract vintages and county-level regional employment." }, "commuting_flows": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Commuting Flows" }, "derived_source_snapshot": { "additionalProperties": true, "type": "object", "title": "Derived Source Snapshot" } }, "type": "object", "required": [ "requested_area", "data", "availability" ], "title": "DataResponse" }, "ErrorDetail": { "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "retryable": { "title": "Retryable", "type": "boolean" }, "retry_after_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retry After Seconds" }, "guidance": { "title": "Guidance", "type": "string" } }, "required": [ "code", "message", "details", "retryable", "retry_after_seconds", "guidance" ], "title": "ErrorDetail", "type": "object" }, "ExportCheckpoint": { "properties": { "type": { "type": "string", "const": "checkpoint", "title": "Type" }, "cursor": { "type": "string", "title": "Cursor" }, "records_committed": { "type": "integer", "title": "Records Committed" }, "complete": { "type": "boolean", "const": false, "title": "Complete" } }, "type": "object", "required": [ "type", "cursor", "records_committed", "complete" ], "title": "ExportCheckpoint" }, "ExportComplete": { "properties": { "type": { "type": "string", "const": "complete", "title": "Type" }, "complete": { "type": "boolean", "const": true, "title": "Complete" }, "records_committed": { "type": "integer", "title": "Records Committed" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "next_cursor": { "type": "null", "title": "Next Cursor" } }, "type": "object", "required": [ "type", "complete", "records_committed", "returned_count", "next_cursor" ], "title": "ExportComplete" }, "ExportError": { "properties": { "detail": { "type": "string", "title": "Detail" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "correlation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Correlation Id" }, "error": { "$ref": "#/components/schemas/ErrorDetail" }, "type": { "type": "string", "const": "error", "title": "Type" }, "complete": { "type": "boolean", "const": false, "title": "Complete" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "detail", "request_id", "correlation_id", "error", "type", "complete", "next_cursor" ], "title": "ExportError" }, "ExportEvent": { "oneOf": [ { "$ref": "#/components/schemas/ExportMetadata" }, { "$ref": "#/components/schemas/ExportRecord" }, { "$ref": "#/components/schemas/ExportCheckpoint" }, { "$ref": "#/components/schemas/ExportComplete" }, { "$ref": "#/components/schemas/ExportHeartbeat" }, { "$ref": "#/components/schemas/ExportError" } ], "title": "ExportEvent", "discriminator": { "propertyName": "type", "mapping": { "checkpoint": "#/components/schemas/ExportCheckpoint", "complete": "#/components/schemas/ExportComplete", "error": "#/components/schemas/ExportError", "heartbeat": "#/components/schemas/ExportHeartbeat", "metadata": "#/components/schemas/ExportMetadata", "record": "#/components/schemas/ExportRecord" } } }, "ExportHeartbeat": { "properties": { "type": { "type": "string", "const": "heartbeat", "title": "Type" }, "request_id": { "type": "string", "title": "Request Id" } }, "type": "object", "required": [ "type", "request_id" ], "title": "ExportHeartbeat" }, "ExportInput": { "properties": { "datasets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Datasets" }, "view": { "type": "string", "enum": [ "observations", "flows", "geographies", "features" ], "title": "View", "default": "observations" }, "flow_direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "title": "Flow Direction", "default": "incoming" }, "geo_type": { "anyOf": [ { "type": "string", "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ] }, { "type": "null" } ], "title": "Geo Type" }, "geoid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geoid" }, "areas": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Area" }, "type": "array" }, { "type": "null" } ], "title": "Areas" }, "state": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{2}$" }, { "type": "null" } ], "title": "State" }, "vintage": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}$" }, { "type": "null" } ], "title": "Vintage" }, "naics": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" }, "metrics": { "anyOf": [ { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" }, { "type": "null" } ], "title": "Metrics" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "bbox": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bbox" }, "feature_type": { "anyOf": [ { "type": "string", "enum": [ "place", "segment", "connector" ] }, { "type": "null" } ], "title": "Feature Type" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "min_confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Min Confidence" } }, "additionalProperties": false, "type": "object", "title": "ExportInput" }, "ExportMetadata": { "properties": { "type": { "type": "string", "const": "metadata", "title": "Type" }, "request_id": { "type": "string", "title": "Request Id" }, "correlation_id": { "type": "string", "title": "Correlation Id" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "metric_definitions": { "additionalProperties": true, "type": "object", "title": "Metric Definitions" }, "availability": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Availability" }, "records_committed": { "type": "integer", "title": "Records Committed" }, "checkpoint_records": { "type": "integer", "title": "Checkpoint Records" }, "complete": { "type": "boolean", "const": false, "title": "Complete" } }, "additionalProperties": true, "type": "object", "required": [ "type", "request_id", "correlation_id", "snapshot", "metric_definitions", "availability", "records_committed", "checkpoint_records", "complete" ], "title": "ExportMetadata" }, "ExportRecord": { "properties": { "type": { "type": "string", "const": "record", "title": "Type" }, "key": { "items": {}, "type": "array", "title": "Key" }, "record": { "additionalProperties": true, "type": "object", "title": "Record" } }, "type": "object", "required": [ "type", "key", "record" ], "title": "ExportRecord" }, "FeatureRecord": { "properties": { "dataset": { "type": "string", "title": "Dataset" }, "source": { "type": "string", "title": "Source" }, "release": { "type": "string", "title": "Release" }, "feature_type": { "type": "string", "enum": [ "place", "segment", "connector" ], "title": "Feature Type" }, "feature_id": { "type": "string", "title": "Feature Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Confidence" }, "geometry": { "additionalProperties": true, "type": "object", "title": "Geometry" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" } }, "type": "object", "required": [ "dataset", "source", "release", "feature_type", "feature_id", "geometry", "properties" ], "title": "FeatureRecord" }, "FeaturesResponse": { "properties": { "requested_area": { "additionalProperties": true, "type": "object", "title": "Requested Area" }, "features": { "items": { "$ref": "#/components/schemas/FeatureRecord" }, "type": "array", "title": "Features" }, "availability": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Availability" }, "source_attribution": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Source Attribution" }, "coverage_limitations": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Coverage Limitations" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "next_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Url" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "type": "object", "required": [ "requested_area", "features", "availability", "returned_count", "complete" ], "title": "FeaturesResponse" }, "Filter": { "properties": { "metric": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Metric" }, "operator": { "type": "string", "enum": [ "gte", "lte", "between", "eq" ], "title": "Operator" }, "value": { "type": "number", "title": "Value" }, "upper": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Upper" } }, "additionalProperties": false, "type": "object", "required": [ "metric", "operator", "value" ], "title": "Filter" }, "GeographyResponse": { "properties": { "requested_area": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Requested Area" }, "geographies": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Geographies" }, "rural_classifications": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Rural Classifications" }, "availability": { "type": "string", "title": "Availability" } }, "type": "object", "required": [ "requested_area", "geographies", "rural_classifications", "availability" ], "title": "GeographyResponse" }, "HealthResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "database": { "type": "string", "title": "Database" } }, "type": "object", "required": [ "status", "database" ], "title": "HealthResponse" }, "InventoryResponse": { "properties": { "datasets": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Datasets" } }, "type": "object", "required": [ "datasets" ], "title": "InventoryResponse" }, "Market": { "properties": { "geo_type": { "type": "string", "enum": [ "place", "county" ], "title": "Geo Type" }, "geoid": { "type": "string", "pattern": "^\\d{5}(?:\\d{2})?$", "title": "Geoid" } }, "additionalProperties": false, "type": "object", "required": [ "geo_type", "geoid" ], "title": "Market" }, "MarketProfileResponse": { "properties": { "requested_area": { "additionalProperties": true, "type": "object", "title": "Requested Area" }, "geographies": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Geographies" }, "complete": { "type": "boolean", "title": "Complete", "default": true }, "demographics": { "anyOf": [ { "$ref": "#/components/schemas/DataResponse" }, { "$ref": "#/components/schemas/UnavailableContext" } ], "title": "Demographics" }, "employment": { "anyOf": [ { "$ref": "#/components/schemas/DataResponse" }, { "$ref": "#/components/schemas/UnavailableContext" } ], "title": "Employment" }, "business": { "anyOf": [ { "$ref": "#/components/schemas/DataResponse" }, { "$ref": "#/components/schemas/UnavailableContext" } ], "title": "Business" }, "economy": { "anyOf": [ { "$ref": "#/components/schemas/DataResponse" }, { "$ref": "#/components/schemas/UnavailableContext" } ], "title": "Economy" }, "environment": { "anyOf": [ { "$ref": "#/components/schemas/DataResponse" }, { "$ref": "#/components/schemas/UnavailableContext" } ], "title": "Environment" }, "county_contexts": { "additionalProperties": true, "type": "object", "title": "County Contexts", "description": "For place profiles, separately labeled data for counties intersecting the published place boundary; never city totals." } }, "type": "object", "required": [ "requested_area", "geographies", "demographics", "employment", "business", "economy", "environment" ], "title": "MarketProfileResponse" }, "MetricResult": { "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ], "title": "Status" }, "unit": { "type": "string", "title": "Unit" }, "label": { "type": "string", "title": "Label" }, "source": { "type": "string", "title": "Source", "default": "ACS" }, "dataset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" }, "survey_window": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Survey Window" }, "method": { "type": "string", "title": "Method" }, "estimated": { "type": "boolean", "title": "Estimated" }, "source_codes": { "items": { "type": "string" }, "type": "array", "title": "Source Codes" }, "universe": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Universe" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "numerator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numerator" }, "denominator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Denominator" }, "margin_of_error": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Margin Of Error" }, "margin_of_error_status": { "type": "string", "title": "Margin Of Error Status" }, "geographic_resolution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geographic Resolution" }, "geography_vintage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Geography Vintage" }, "coverage_fraction": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Coverage Fraction" }, "missing_unit_count": { "type": "integer", "title": "Missing Unit Count", "default": 0 }, "flags": { "additionalProperties": true, "type": "object", "title": "Flags" } }, "type": "object", "required": [ "value", "status", "unit", "label", "method", "estimated", "source_codes", "margin_of_error_status" ], "title": "MetricResult" }, "PlacesResponse": { "properties": { "requested_area": { "additionalProperties": true, "type": "object", "title": "Requested Area" }, "geographies": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Geographies" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" }, "returned_count": { "type": "integer", "title": "Returned Count", "default": 0 }, "complete": { "type": "boolean", "title": "Complete", "default": true }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "next_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Url" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "continuations": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Continuations" } }, "type": "object", "required": [ "requested_area", "geographies" ], "title": "PlacesResponse" }, "Polygon": { "properties": { "type": { "type": "string", "const": "Polygon", "title": "Type" }, "coordinates": { "items": { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, "type": "array", "maxItems": 1250, "minItems": 1, "title": "Coordinates" } }, "additionalProperties": false, "type": "object", "required": [ "type", "coordinates" ], "title": "Polygon" }, "Priority": { "properties": { "metric": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Metric" }, "weight": { "type": "number", "maximum": 100.0, "exclusiveMinimum": 0.0, "title": "Weight" }, "direction": { "type": "string", "enum": [ "higher", "lower" ], "title": "Direction", "default": "higher" } }, "additionalProperties": false, "type": "object", "required": [ "metric", "weight" ], "title": "Priority" }, "ProfileInput": { "properties": { "geo_type": { "type": "string", "enum": [ "national", "state", "county", "county_subdivision", "bea_county_group", "place", "tract", "block_group", "zcta", "postal_zip", "monitor", "cbsa", "csa", "metro_division", "permit_area", "bls_area", "consumer_group", "economic_place", "economic_place_part", "consolidated_city" ], "title": "Geo Type", "default": "tract" }, "geoid": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Geoid" }, "lat": { "anyOf": [ { "type": "number", "maximum": 90.0, "minimum": -90.0 }, { "type": "null" } ], "title": "Lat" }, "lon": { "anyOf": [ { "type": "number", "maximum": 180.0, "minimum": -180.0 }, { "type": "null" } ], "title": "Lon" }, "naics": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" }, "sections": { "anyOf": [ { "items": { "type": "string", "enum": [ "demographics", "employment", "business", "economy", "environment" ] }, "type": "array" }, { "type": "null" } ], "title": "Sections" }, "metrics": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metrics" }, "limit": { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": 1.0, "title": "Limit", "default": 100 } }, "type": "object", "title": "ProfileInput" }, "PublicCatalogResponse": { "properties": { "generated_at": { "type": "string", "title": "Generated At" }, "summary": { "$ref": "#/components/schemas/CatalogSummary" }, "datasets": { "items": { "$ref": "#/components/schemas/PublicDataset" }, "type": "array", "title": "Datasets" }, "apis": { "items": { "$ref": "#/components/schemas/ApiOperation" }, "type": "array", "title": "Apis" } }, "type": "object", "required": [ "generated_at", "summary", "datasets", "apis" ], "title": "PublicCatalogResponse" }, "PublicDataset": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "source": { "type": "string", "title": "Source" }, "release": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release" }, "resolution": { "type": "string", "title": "Resolution" }, "record_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Record Count" }, "installed": { "type": "boolean", "title": "Installed" }, "available": { "type": "boolean", "title": "Available" }, "status": { "type": "string", "enum": [ "available", "pending", "not_installed" ], "title": "Status" }, "last_validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Validation" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint" } }, "type": "object", "required": [ "identifier", "name", "description", "source", "release", "resolution", "record_count", "installed", "available", "status", "last_validation", "endpoint" ], "title": "PublicDataset" }, "Record": { "properties": { "dataset": { "type": "string", "title": "Dataset" }, "source": { "type": "string", "title": "Source" }, "release": { "type": "string", "title": "Release" }, "geographic_resolution": { "type": "string", "title": "Geographic Resolution" }, "geoid": { "type": "string", "title": "Geoid" }, "geography_vintage": { "type": "string", "title": "Geography Vintage" }, "period": { "type": "string", "title": "Period" }, "naics": { "type": "string", "title": "Naics", "default": "" }, "component": { "type": "string", "title": "Component", "default": "" }, "metrics": { "additionalProperties": true, "type": "object", "title": "Metrics" }, "margins_of_error": { "additionalProperties": true, "type": "object", "title": "Margins Of Error", "description": "Source-published margins of error. ACS margins use a 90% confidence level; units match the corresponding estimates." }, "flags": { "additionalProperties": true, "type": "object", "title": "Flags" } }, "type": "object", "required": [ "dataset", "source", "release", "geographic_resolution", "geoid", "geography_vintage", "period", "metrics" ], "title": "Record" }, "Rectangle": { "properties": { "type": { "type": "string", "const": "rectangle", "title": "Type" }, "west": { "type": "number", "maximum": 180.0, "minimum": -180.0, "title": "West" }, "south": { "type": "number", "exclusiveMaximum": 90.0, "exclusiveMinimum": -90.0, "title": "South" }, "east": { "type": "number", "maximum": 180.0, "minimum": -180.0, "title": "East" }, "north": { "type": "number", "exclusiveMaximum": 90.0, "exclusiveMinimum": -90.0, "title": "North" } }, "additionalProperties": false, "type": "object", "required": [ "type", "west", "south", "east", "north" ], "title": "Rectangle" }, "Scope": { "properties": { "type": { "type": "string", "enum": [ "nationwide", "region" ], "title": "Type", "default": "nationwide" }, "geometry": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/Boundary" }, { "$ref": "#/components/schemas/Circle" }, { "$ref": "#/components/schemas/Rectangle" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/Union" } ], "discriminator": { "propertyName": "type", "mapping": { "Polygon": "#/components/schemas/Polygon", "boundary": "#/components/schemas/Boundary", "circle": "#/components/schemas/Circle", "rectangle": "#/components/schemas/Rectangle", "union": "#/components/schemas/Union" } } }, { "type": "null" } ], "title": "Geometry" } }, "additionalProperties": false, "type": "object", "title": "Scope" }, "SearchInput": { "properties": { "scope": { "$ref": "#/components/schemas/Scope" }, "geo_type": { "type": "string", "enum": [ "place", "county" ], "title": "Geo Type", "default": "place" }, "metrics": { "items": { "type": "string" }, "type": "array", "maxItems": 30, "title": "Metrics" }, "filters": { "items": { "$ref": "#/components/schemas/Filter" }, "type": "array", "maxItems": 20, "title": "Filters" }, "priorities": { "items": { "$ref": "#/components/schemas/Priority" }, "type": "array", "maxItems": 20, "title": "Priorities" }, "naics": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" }, "sort": { "anyOf": [ { "$ref": "#/components/schemas/Sort" }, { "type": "null" } ] }, "group": { "type": "string", "enum": [ "matches", "insufficient_data" ], "title": "Group", "default": "matches" }, "limit": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ], "title": "Cursor" }, "index_version": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Index Version" } }, "additionalProperties": false, "type": "object", "title": "SearchInput" }, "SearchResponse": { "properties": { "applied_criteria": { "additionalProperties": true, "type": "object", "title": "Applied Criteria" }, "markets": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Markets" }, "counts": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Counts" }, "index_version": { "type": "integer", "title": "Index Version" }, "scoring_version": { "type": "string", "title": "Scoring Version" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" }, "selection_rule": { "type": "string", "title": "Selection Rule" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "applied_criteria", "markets", "counts", "index_version", "scoring_version", "snapshot", "selection_rule", "returned_count", "complete", "next_cursor" ], "title": "SearchResponse" }, "Sort": { "properties": { "metric": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Metric" }, "direction": { "type": "string", "enum": [ "asc", "desc" ], "title": "Direction", "default": "desc" } }, "additionalProperties": false, "type": "object", "required": [ "metric" ], "title": "Sort" }, "SpendingGroupsResponse": { "properties": { "groups": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Groups" }, "returned_count": { "type": "integer", "title": "Returned Count" }, "complete": { "type": "boolean", "title": "Complete" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "next_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Url" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "type": "object", "required": [ "groups", "returned_count", "complete" ], "title": "SpendingGroupsResponse" }, "TrendsInput": { "properties": { "markets": { "items": { "$ref": "#/components/schemas/Market" }, "type": "array", "maxItems": 5, "minItems": 1, "title": "Markets" }, "metrics": { "items": { "type": "string" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Metrics" }, "naics": { "anyOf": [ { "type": "string", "pattern": "^(?:\\d{2,6}|\\d{2}-\\d{2})$" }, { "type": "null" } ], "title": "Naics" }, "periods": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1 }, { "type": "null" } ], "title": "Periods" }, "index_version": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Index Version" } }, "additionalProperties": false, "type": "object", "required": [ "markets", "metrics" ], "title": "TrendsInput" }, "TrendsResponse": { "properties": { "markets": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Markets" }, "index_version": { "type": "integer", "title": "Index Version" }, "snapshot": { "additionalProperties": true, "type": "object", "title": "Snapshot" } }, "additionalProperties": false, "type": "object", "required": [ "markets", "index_version", "snapshot" ], "title": "TrendsResponse" }, "UnavailableContext": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Record" }, "type": "array", "title": "Data" }, "availability": { "type": "string", "title": "Availability" } }, "type": "object", "required": [ "availability" ], "title": "UnavailableContext" }, "Union": { "properties": { "type": { "type": "string", "const": "union", "title": "Type" }, "geometries": { "items": { "oneOf": [ { "$ref": "#/components/schemas/Boundary" }, { "$ref": "#/components/schemas/Circle" }, { "$ref": "#/components/schemas/Rectangle" }, { "$ref": "#/components/schemas/Polygon" } ], "discriminator": { "propertyName": "type", "mapping": { "Polygon": "#/components/schemas/Polygon", "boundary": "#/components/schemas/Boundary", "circle": "#/components/schemas/Circle", "rectangle": "#/components/schemas/Rectangle" } } }, "type": "array", "minItems": 1, "title": "Geometries" } }, "additionalProperties": false, "type": "object", "required": [ "type", "geometries" ], "title": "Union" }, "ValidationResponse": { "properties": { "valid": { "type": "boolean", "title": "Valid" }, "normalized": { "additionalProperties": true, "type": "object", "title": "Normalized" }, "selected_metrics": { "items": { "type": "string" }, "type": "array", "title": "Selected Metrics" }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings" } }, "additionalProperties": false, "type": "object", "required": [ "valid", "normalized", "selected_metrics", "warnings" ], "title": "ValidationResponse" }, "ErrorResponse": { "properties": { "detail": { "title": "Detail", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "correlation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Correlation Id" }, "error": { "$ref": "#/components/schemas/ErrorDetail" } }, "required": [ "detail", "request_id", "correlation_id", "error" ], "title": "ErrorResponse", "type": "object" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://api.geoamcan.com", "description": "geoamcan production API" } ] }