{ "openapi": "3.0.1", "info": { "title": "US Building Permits Data — Census BPS by State, County & Metro", "description": "US Census Building Permits Survey as data: new housing units, buildings and valuation by structure type (1-unit to 5+) for states, counties and metro areas, monthly, year-to-date and annual. Filter by state, area and date. No API key. Part of NexGen Signal — official-source data products", "version": "0.1", "x-build-id": "N4t7D86WxiP31sPo8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgensignal~us-census-building-permit-survey-observations/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgensignal-us-census-building-permit-survey-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nexgensignal~us-census-building-permit-survey-observations/runs": { "post": { "operationId": "runs-sync-nexgensignal-us-census-building-permit-survey-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nexgensignal~us-census-building-permit-survey-observations/run-sync": { "post": { "operationId": "run-sync-nexgensignal-us-census-building-permit-survey-observations", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "level": { "title": "Geography level", "enum": [ "state", "county", "metro" ], "type": "string", "description": "Which Census permits file family to read.", "default": "state" }, "periodType": { "title": "Period type", "enum": [ "monthly", "year_to_date", "annual" ], "type": "string", "description": "Monthly current-month files, year-to-date files (include late reports for earlier months), or annual files.", "default": "monthly" }, "monthFrom": { "title": "Month from", "type": "string", "description": "First month wanted, e.g. 2025-01 (monthly and year-to-date). Leave both months empty for the latest month." }, "monthTo": { "title": "Month to", "type": "string", "description": "Last month wanted, e.g. 2026-08." }, "yearFrom": { "title": "Year from", "type": "integer", "description": "First year wanted (annual files)." }, "yearTo": { "title": "Year to", "type": "integer", "description": "Last year wanted (annual files)." }, "states": { "title": "States", "type": "array", "description": "Two-letter codes (TX) or FIPS codes (48); at state level also full names. Not for metro.", "default": [], "items": { "type": "string" } }, "nameContains": { "title": "Name contains", "type": "array", "description": "Keep rows whose name contains any of these, e.g. Harris (county), Austin (metro), TX (metro names end with the state).", "default": [], "items": { "type": "string" } }, "cbsaCodes": { "title": "CBSA codes", "type": "array", "description": "Five-digit CBSA codes, e.g. 12420 (metro level).", "default": [], "items": { "type": "string" } }, "includeAggregates": { "title": "Include division, region and US rows", "type": "boolean", "description": "State files end with division, region and US totals.", "default": true }, "order": { "title": "Order", "enum": [ "newest_first", "oldest_first" ], "type": "string", "description": "By period.", "default": "newest_first" }, "maxRecords": { "title": "Maximum records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many records (each is charged once).", "default": 1000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }