{ "openapi": "3.0.1", "info": { "title": "US Storm Damage Roofing Leads - NOAA Hail + Permits", "description": "Hail and damaging-wind reports from NOAA around 12 US cities, and the roofing permits pulled in the weeks after: which neighbourhoods are replacing roofs right now, how many more than before the storm, and which contractors are doing the work. Official NOAA storm reports and city permit registers.", "version": "1.0", "x-build-id": "x6z6sXKDxIaUpma5b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wellbuilt_zythem~us-storm-roofing-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wellbuilt_zythem-us-storm-roofing-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/wellbuilt_zythem~us-storm-roofing-leads/runs": { "post": { "operationId": "runs-sync-wellbuilt_zythem-us-storm-roofing-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/wellbuilt_zythem~us-storm-roofing-leads/run-sync": { "post": { "operationId": "run-sync-wellbuilt_zythem-us-storm-roofing-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": { "cities": { "title": "Cities", "type": "array", "description": "Leave empty for all twelve. Storm reports are matched to the city centre; permits come from that city's official register.", "items": { "type": "string", "enum": [ "chicago", "cincinnati", "austin", "mesa", "new_orleans", "baton_rouge", "orlando", "new_york", "seattle", "everett", "somerville_ma", "marin_county" ], "enumTitles": [ "Chicago, IL", "Cincinnati, OH", "Austin, TX", "Mesa, AZ", "New Orleans, LA", "Baton Rouge, LA", "Orlando, FL", "New York, NY", "Seattle, WA", "Everett, WA", "Somerville, MA", "Marin County, CA" ] }, "default": [] }, "lastNDays": { "title": "Storms in the last N days", "minimum": 1, "maximum": 120, "type": "integer", "description": "How far back to look for NOAA hail and wind reports. Roofing permits are then read from the first storm in the window to today, plus the same number of days before it as the baseline.", "default": 30 }, "radiusKm": { "title": "Radius around the city centre (km)", "minimum": 1, "maximum": 150, "type": "integer", "description": "A NOAA report is a point where someone saw the hail, inside a swath 10 to 30 km wide. 40 km catches the metro area.", "default": 40 }, "minHailInches": { "title": "Minimum hail size (inches)", "type": "string", "description": "1 inch is the size that dents shingles; 1.75 (golf ball) is what insurers pay out on. NOAA only publishes reports of 1 inch and above.", "default": "1" }, "minWindMph": { "title": "Minimum wind speed (mph)", "minimum": 1, "type": "integer", "description": "58 mph is the National Weather Service severe threshold. Reports of wind damage with no measured speed always count.", "default": 58 }, "withPermits": { "title": "Read the permits pulled after the storm", "type": "boolean", "description": "Off gives storm reports only. On adds one row per roofing permit issued since the first storm, with the storm that explains it, days after the storm, distance, and the contractor's permit count after the storm.", "default": true }, "trades": { "title": "Permit trades", "type": "array", "description": "Roofing by default. Add solar, HVAC or remodel to see what else a storm pulls.", "items": { "type": "string", "enum": [ "roofing", "solar", "hvac", "electrical", "plumbing", "remodel", "new_construction", "demolition", "fence", "other" ] }, "default": [] }, "maxResults": { "title": "Max rows", "minimum": 0, "type": "integer", "description": "Storm reports and permits together. 0 = no limit. The prefilled 100 makes a first run cost cents.", "default": 0 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Free token from any Socrata portal; gives the permit reads their own rate limit." } } }, "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 } } } } } } } } } }