{
  "openapi": "3.0.1",
  "info": {
    "title": "Solar Roof Prospects: commercial solar leads with savings",
    "description": "Commercial solar leads for installers: businesses with big roofs in any city. Get the rooftop solar system that fits, yearly power, bill saving, cost and payback, business email, lead score, a branded one-page solar estimate and a ready-to-send email for each roof, plus a map.",
    "version": "0.1",
    "x-build-id": "gCnI7F8o1CVqBDr0u"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/translucent_wire~solar-roof-prospects/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-translucent_wire-solar-roof-prospects",
        "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/translucent_wire~solar-roof-prospects/runs": {
      "post": {
        "operationId": "runs-sync-translucent_wire-solar-roof-prospects",
        "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/translucent_wire~solar-roof-prospects/run-sync": {
      "post": {
        "operationId": "run-sync-translucent_wire-solar-roof-prospects",
        "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",
        "required": [
          "location"
        ],
        "properties": {
          "location": {
            "title": "City or area",
            "type": "string",
            "description": "City, county or area plus state or country, e.g. 'Fresno, California' or 'Leeds, UK'."
          },
          "countryCode": {
            "title": "Country code (optional)",
            "type": "string",
            "description": "Two-letter code like US or GB to make the location search exact."
          },
          "radiusKm": {
            "title": "Radius in km (optional)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Search this many km around the location instead of inside its official boundary."
          },
          "businessTypes": {
            "title": "Business types",
            "type": "array",
            "description": "Types of business with big roofs and daytime power use.",
            "items": {
              "type": "string",
              "enum": [
                "manufacturers",
                "warehouses_wholesale",
                "cold_storage_food",
                "supermarkets_big_retail",
                "car_dealers_repair",
                "hotels",
                "gyms_sports",
                "offices"
              ],
              "enumTitles": [
                "Manufacturers and workshops",
                "Warehouses and wholesale",
                "Food producers and cold storage",
                "Supermarkets and large stores",
                "Car dealers and repair",
                "Hotels",
                "Gyms and sports centres",
                "Company offices"
              ]
            },
            "default": [
              "manufacturers",
              "warehouses_wholesale",
              "cold_storage_food",
              "supermarkets_big_retail",
              "car_dealers_repair"
            ]
          },
          "minRoofM2": {
            "title": "Minimum roof size (m²)",
            "minimum": 50,
            "type": "integer",
            "description": "Skip smaller roofs. 600 m² is about 6,500 sq ft (roughly a 50 kW system).",
            "default": 600
          },
          "includeChains": {
            "title": "Include chains and big brands",
            "type": "boolean",
            "description": "Off: skip branded chain stores, whose solar decisions are usually made at head office.",
            "default": false
          },
          "includeSharedBuildings": {
            "title": "Include shared buildings",
            "type": "boolean",
            "description": "Off: skip buildings with 3 or more businesses inside (the landlord usually owns the roof).",
            "default": false
          },
          "electricityPricePerKwh": {
            "title": "Business electricity price per kWh (optional)",
            "type": "string",
            "description": "US: leave empty to use the EIA average business price for the state. Other countries: enter your local price (e.g. 0.25) to get savings and payback."
          },
          "currency": {
            "title": "Currency (outside the US)",
            "type": "string",
            "description": "Three-letter currency of your price and cost inputs, e.g. GBP or EUR. US always uses USD.",
            "default": "USD"
          },
          "installCostPerWatt": {
            "title": "Installed cost per watt",
            "type": "string",
            "description": "Average installed price for business solar in your market (US Q2 2026 about 1.77). Small systems are priced higher, big ones lower, automatically.",
            "default": "1.77"
          },
          "taxCreditPercent": {
            "title": "Tax credit or grant (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "US default 30 (federal credit for systems in service by 31 Dec 2027, if eligible). Elsewhere default 0."
          },
          "minFitScore": {
            "title": "Minimum lead score (0-100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only return roofs with at least this score (size, payback, daytime use, independent owner, contact found).",
            "default": 50
          },
          "maxResults": {
            "title": "Maximum roof prospects",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Stop after this many prospects.",
            "default": 5
          },
          "onlyWithEmail": {
            "title": "Only roofs with a business email",
            "type": "boolean",
            "description": "Return only businesses whose own website publishes an email fit for a sales message.",
            "default": true
          },
          "solarPages": {
            "title": "Branded one-page estimates (best-fit roofs first)",
            "type": "boolean",
            "description": "A page per business with its roof drawing, system size, saving, cost and payback, in your branding.",
            "default": true
          },
          "maxSolarPages": {
            "title": "Maximum estimate pages",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "Estimate pages are made for your best-fit roofs first, up to this number ($0.50 each). Set 0 for a page for every roof.",
            "default": 1
          },
          "makeMap": {
            "title": "Map of all roofs",
            "type": "boolean",
            "description": "One interactive map with every roof, its size, saving and score.",
            "default": true
          },
          "emailOffer": {
            "title": "Offer line for the email (optional)",
            "type": "string",
            "description": "One sentence added to each ready-to-send email, e.g. 'We handle permits and the utility connection.'"
          },
          "brandName": {
            "title": "Your company name",
            "type": "string",
            "description": "Shown on pages and the map."
          },
          "brandLogoUrl": {
            "title": "Your logo URL (https)",
            "type": "string",
            "description": "Public https link to your logo image."
          },
          "brandColor": {
            "title": "Your brand colour",
            "type": "string",
            "description": "Hex colour like #d97706."
          },
          "brandContact": {
            "title": "Your contact line",
            "type": "string",
            "description": "e.g. 'Jane Smith, Sunny Solar, jane@sunnysolar.com, (555) 010-0000'. Used as the email signature."
          },
          "brandCtaUrl": {
            "title": "Button link",
            "type": "string",
            "description": "Your booking page or website."
          },
          "brandCtaText": {
            "title": "Button text",
            "type": "string",
            "description": "Text on the button.",
            "default": "Book a free site check"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}