{ "openapi": "3.0.1", "info": { "title": "Boulder Building Performance Program Energy Data", "description": "Building energy benchmarking data for Boulder, CO: energy use intensity, ENERGY STAR score, electricity, gas, GHG emissions, floor area, property type and compliance status per building, normalized across programs. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "oOMhrkeXeSo9K6zQU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/buildingsignal~boulder-building-performance-program/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-buildingsignal-boulder-building-performance-program", "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~boulder-building-performance-program/runs": { "post": { "operationId": "runs-sync-buildingsignal-boulder-building-performance-program", "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~boulder-building-performance-program/run-sync": { "post": { "operationId": "run-sync-buildingsignal-boulder-building-performance-program", "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": { "reportingYears": { "title": "Reporting years", "type": "array", "description": "Only these reporting years, e.g. 2023, 2024. Leave empty for the most recent year of every building.", "items": { "type": "string" } }, "latestYearOnly": { "title": "Latest year only", "type": "boolean", "description": "Return only the most recent report of each building (ignored when reporting years are set). Turn off to get the full history.", "default": true }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only buildings whose type contains any of these words, e.g. Office, Multifamily, Hotel, Warehouse.", "items": { "type": "string" } }, "minFloorAreaSqft": { "title": "Min floor area (sq ft)", "minimum": 0, "type": "integer", "description": "Only buildings at least this large." }, "maxFloorAreaSqft": { "title": "Max floor area (sq ft)", "minimum": 0, "type": "integer", "description": "Only buildings up to this size." }, "minSiteEui": { "title": "Min site EUI (kBtu/sq ft)", "minimum": 0, "type": "integer", "description": "Only buildings using at least this much energy per square foot. High EUI = retrofit opportunity." }, "maxSiteEui": { "title": "Max site EUI (kBtu/sq ft)", "minimum": 0, "type": "integer", "description": "Only buildings using at most this much energy per square foot." }, "minEnergyStarScore": { "title": "Min ENERGY STAR score", "minimum": 0, "type": "integer", "description": "Only buildings with at least this ENERGY STAR score (1-100)." }, "maxEnergyStarScore": { "title": "Max ENERGY STAR score", "minimum": 0, "type": "integer", "description": "Only buildings with at most this ENERGY STAR score (1-100). Low scores = inefficient buildings." }, "complianceStatuses": { "title": "Compliance status", "type": "array", "description": "Keep only these reporting/compliance statuses.", "items": { "type": "string", "enum": [ "compliant", "not_submitted", "non_compliant", "exempt", "pending" ], "enumTitles": [ "Compliant / reported", "Not submitted", "Non-compliant", "Exempt", "Pending" ] } }, "zipCodes": { "title": "ZIP / postal codes", "type": "array", "description": "Only buildings in these ZIP or postal codes.", "items": { "type": "string" } }, "ownerKeyword": { "title": "Owner contains", "type": "string", "description": "Only buildings whose published owner or responsible entity contains this text (where the program publishes it)." }, "maxBuildings": { "title": "Max buildings", "minimum": 1, "type": "integer", "description": "Maximum number of buildings 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 } } } } } } } } } }