{ "openapi": "3.0.1", "info": { "title": "NYC Boiler & Burner Equipment Leads: Make, Model, Expiration", "description": "NYC boiler, burner and generator leads: registered equipment make and model, burner, fuel, permit expiration date and owner organisation, plus boiler inspection reports with defects. Filter by expiration window, manufacturer, fuel and borough. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "S5aqQHqNCycV6oYwS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/buildingsignal~nyc-boiler-burner-equipment-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-buildingsignal-nyc-boiler-burner-equipment-leads", "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/buildingsignal~nyc-boiler-burner-equipment-leads/runs": { "post": { "operationId": "runs-sync-buildingsignal-nyc-boiler-burner-equipment-leads", "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/buildingsignal~nyc-boiler-burner-equipment-leads/run-sync": { "post": { "operationId": "run-sync-buildingsignal-nyc-boiler-burner-equipment-leads", "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": { "recordTypes": { "title": "Record types", "type": "array", "description": "equipment_permit = registered boilers, burners and generators with permit expiration; boiler_inspection = annual boiler inspection reports.", "items": { "type": "string", "enum": [ "equipment_permit", "boiler_inspection" ], "enumTitles": [ "Equipment registrations & permits", "Boiler inspection reports" ] } }, "permitExpiringWithinDays": { "title": "Permit expiring within (days)", "minimum": 0, "type": "integer", "description": "Only equipment whose operating permit/registration expires within this many days. Great for service and replacement outreach." }, "boroughs": { "title": "Boroughs", "type": "array", "description": "Only these boroughs.", "items": { "type": "string", "enum": [ "Manhattan", "Bronx", "Brooklyn", "Queens", "Staten Island" ], "enumTitles": [ "Manhattan", "Bronx", "Brooklyn", "Queens", "Staten Island" ] } }, "permitStatuses": { "title": "Permit statuses", "type": "array", "description": "e.g. CURRENT, EXPIRED, ISSUED.", "items": { "type": "string" } }, "equipmentMakes": { "title": "Equipment makes", "type": "array", "description": "Boiler or burner manufacturer contains, e.g. Weil McLain, Burnham, Cleaver Brooks, Powerflame.", "items": { "type": "string" } }, "fuelTypes": { "title": "Fuel types", "type": "array", "description": "Primary fuel contains, e.g. NATURALGAS, NO2FUEL, NO4FUEL.", "items": { "type": "string" } }, "ownerKeyword": { "title": "Owner contains", "type": "string", "description": "Only equipment whose registered owner (organisation) contains this text." }, "excludeVariousLocations": { "title": "Skip multi-site registrations", "type": "boolean", "description": "Skip registrations filed for 'various locations' (portable generators etc.).", "default": true }, "defectsOnly": { "title": "Inspections with defects only", "type": "boolean", "description": "For boiler inspections: return only reports with defects.", "default": false }, "inspectedAfter": { "title": "Inspected after (YYYY-MM-DD)", "type": "string", "description": "For boiler inspections: only reports on or after this date." }, "maxEquipment": { "title": "Max records", "minimum": 1, "type": "integer", "description": "Maximum number of records to return. Free Apify plans are limited to 10 per run.", "default": 50 } } }, "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 } } } } } } } } } }