{ "openapi": "3.0.1", "info": { "title": "US Census Bureau Data API Scraper", "description": "Query official US Census Bureau API datasets for ACS, Decennial Census, and public data research. Returns structured rows with variables, geography identifiers, source URL, and retrieval time. Charged $0.00005 per valid query plus $0.0005 per row.", "version": "1.0", "x-build-id": "v6Pcv5asmxnIcl8XL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~us-census-bureau-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-us-census-bureau-scraper", "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/muhammadafzal~us-census-bureau-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-us-census-bureau-scraper", "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/muhammadafzal~us-census-bureau-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-us-census-bureau-scraper", "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": { "dataset": { "title": "Dataset path", "pattern": "^[A-Za-z0-9_-]+(?:/[A-Za-z0-9_-]+)*$", "minLength": 1, "maxLength": 120, "type": "string", "description": "Use this to select the Census dataset path after the year, for example 'acs/acs5' or 'dec/pl'. Defaults to 'acs/acs5'. This is not a data.census.gov URL.", "default": "acs/acs5" }, "year": { "title": "Vintage year", "minimum": 1790, "maximum": 2100, "type": "integer", "description": "Use this to choose the Census vintage year, for example 2023. Defaults to 2023; choose a year published by the selected dataset.", "default": 2023 }, "variables": { "title": "Variables", "minItems": 1, "maxItems": 100, "type": "array", "description": "Use this to choose Census variable codes returned in each row, for example 'NAME' and 'B01001_001E'. Defaults to NAME and total population. This is not a free-text search across Census websites.", "items": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[A-Za-z0-9_.-]+$" }, "default": [ "NAME", "B01001_001E" ] }, "for": { "title": "Geography selector", "minLength": 1, "maxLength": 200, "type": "string", "description": "Use this to set the Census API 'for' geography selector, for example 'state:*' or 'county:*'. Defaults to state:*; use ucgid instead when selecting mixed geographies.", "default": "state:*" }, "in": { "title": "Parent geography filters", "type": "array", "description": "Use this to restrict results inside parent geographies, for example 'state:06' when querying counties in California. Defaults to no parent filter; this is not the same as the 'for' geography.", "items": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_. -]+:[A-Za-z0-9_*.-]+$" }, "default": [] }, "predicates": { "title": "API predicates", "type": "object", "description": "Use this for additional Census API predicate parameters such as NAME or DATE_CODE, for example {\"NAME\": \"California\"}. Defaults to none; do not place get, for, in, key, or ucgid here.", "default": {}, "additionalProperties": true }, "ucgid": { "title": "Uniform Census geography ID", "maxLength": 500, "type": "string", "description": "Use this for UCGID geography selection supported by newer Census datasets, for example '0400000US24'. Leave blank when using the standard for/in selectors.", "default": "" }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Use this to cap rows returned and billed from the Census API response. Defaults to 1000, with a maximum of 50000. This is a client-side cap, not Census server pagination.", "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 } } }, "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 } } } } } } } } } }