{ "openapi": "3.0.1", "info": { "title": "HUD Section 8 Expiring Contracts Scraper - Multifamily & LIHTC", "description": "Scrape HUD-assisted multifamily properties with expiring Section 8 and PRAC contracts, unit counts, rent-to-FMR ratios, REAC scores, and management agents, plus Year-15 and full LIHTC property lists.", "version": "0.1", "x-build-id": "BuzjPMcST26Y970oe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundplanes~hud-section8-expiring-contracts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundplanes-hud-section8-expiring-contracts", "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/groundplanes~hud-section8-expiring-contracts/runs": { "post": { "operationId": "runs-sync-groundplanes-hud-section8-expiring-contracts", "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/groundplanes~hud-section8-expiring-contracts/run-sync": { "post": { "operationId": "run-sync-groundplanes-hud-section8-expiring-contracts", "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": "HUD Dataset Mode", "enum": [ "SECTION8_CONTRACTS", "LIHTC_YEAR15", "LIHTC_ALL" ], "type": "string", "description": "Dataset to query: SECTION8_CONTRACTS (HUD-assisted multifamily properties with expiring assistance contracts), LIHTC_YEAR15 (LIHTC properties placed in service in the Year-15 window), or LIHTC_ALL (all LIHTC properties).", "default": "SECTION8_CONTRACTS" }, "expiringWithinMonths": { "title": "Expiring Within Months (Section 8 Only)", "minimum": 1, "type": "integer", "description": "For SECTION8_CONTRACTS mode: keep contracts (`EXPIRATION_DATE1` or `EXPIRATION_DATE2`) expiring between today and this many months into the future.", "default": 24 }, "includeContacts": { "title": "Include Named Individual Contacts", "type": "boolean", "description": "Defaults to false for privacy compliance because `MGMT_CONTACT_FULL_NAME` (Section 8) and `CONTACT` / `CO_TEL` (LIHTC) identify individual people. Management agent organization name and on-site property phone are business data and are always included.", "default": false }, "lihtcPlacedInServiceYears": { "title": "LIHTC Placed-in-Service Years (LIHTC_YEAR15 Only)", "type": "array", "description": "For LIHTC_YEAR15 mode: 4-digit placed-in-service years (`YR_PIS`) to target properties approaching the 15-year compliance period milestone. When empty, it defaults to the current Year-15 cohort (current year minus 15 and minus 14).", "items": { "type": "integer" }, "default": [ 2011, 2012 ] }, "maxItems": { "title": "Maximum Items", "minimum": 1, "type": "integer", "description": "Maximum number of contract or property rows to return.", "default": 200 }, "minUnits": { "title": "Minimum Total Units", "minimum": 0, "type": "integer", "description": "Minimum total unit count on the property (`TOTAL_UNIT_COUNT` for Section 8, `N_UNITS` for LIHTC).", "default": 0 }, "states": { "title": "US States (2-letter codes)", "type": "array", "description": "Two-letter US state or territory postal codes to filter properties (e.g. [\"AZ\"] or [\"AZ\", \"NV\", \"CO\"]).", "items": { "type": "string" }, "default": [ "AZ" ] } } }, "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 } } } } } } } } } }