{ "openapi": "3.0.1", "info": { "title": "MaStR Scraper: German Solar, Battery & Wind Register", "description": "Scrape Germany's official energy register (Marktstammdatenregister): every solar park, battery storage and wind turbine with capacity, location and commissioning date — plus a lead list of operator companies with email, phone, website and register number.", "version": "0.1", "x-build-id": "E9PFpoi9jm2kk6jwu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dach_data_tools~mastr-energy-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dach_data_tools-mastr-energy-register-scraper", "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/dach_data_tools~mastr-energy-register-scraper/runs": { "post": { "operationId": "runs-sync-dach_data_tools-mastr-energy-register-scraper", "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/dach_data_tools~mastr-energy-register-scraper/run-sync": { "post": { "operationId": "run-sync-dach_data_tools-mastr-energy-register-scraper", "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": { "energyType": { "title": "Energy type", "enum": [ "2495", "2496", "2497", "2493", "2498", "2410", "all" ], "type": "string", "description": "Which kind of installation to scrape.", "default": "2495" }, "minCapacityKw": { "title": "Min. capacity (kW)", "minimum": 0, "type": "integer", "description": "Only installations with gross capacity above this value. 100+ kW filters out home rooftops and keeps commercial / utility-scale systems.", "default": 500 }, "maxCapacityKw": { "title": "Max. capacity (kW)", "minimum": 0, "type": "integer", "description": "Only installations with gross capacity below this value. Leave empty for no limit." }, "state": { "title": "Federal state (Bundesland)", "enum": [ "", "1402", "1403", "1401", "1400", "1404", "1406", "1405", "1407", "1408", "1409", "1410", "1412", "1413", "1414", "1411", "1415", "1416" ], "type": "string", "description": "Limit to one German federal state.", "default": "" }, "postalCodePrefix": { "title": "Postal code starts with", "type": "string", "description": "e.g. \"80\" for the Munich area or \"48147\" for one postal code." }, "city": { "title": "City / town", "type": "string", "description": "Installation location (Ort), e.g. \"Münster\"." }, "commissionedAfter": { "title": "Commissioned after", "type": "string", "description": "Only installations put into operation after this date (YYYY-MM-DD). Great for finding brand-new systems." }, "commissionedBefore": { "title": "Commissioned before", "type": "string", "description": "Only installations put into operation before this date (YYYY-MM-DD). Use e.g. 2010-01-01 to find old systems due for repowering or battery retrofits." }, "status": { "title": "Operating status", "enum": [ "35", "31", "all" ], "type": "string", "description": "Operating, planned, or any status.", "default": "35" }, "onlyOrganizations": { "title": "Only company-owned installations", "type": "boolean", "description": "Skip installations owned by private persons (their names are anonymised in the register anyway). Keep on for B2B leads.", "default": true }, "operatorNameContains": { "title": "Operator name contains", "type": "string", "description": "Filter by operator company name, e.g. \"Stadtwerke\" or \"Solarpark\"." }, "sortBy": { "title": "Sort by", "enum": [ "Bruttoleistung-desc", "InbetriebnahmeDatum-desc", "InbetriebnahmeDatum-asc", "" ], "type": "string", "description": "Order of results.", "default": "Bruttoleistung-desc" }, "maxItems": { "title": "Max installations", "minimum": 1, "type": "integer", "description": "Maximum number of installations to return.", "default": 100 }, "includeOperatorContacts": { "title": "Operator company contacts (lead list)", "type": "boolean", "description": "Fetch each operating company's public register profile: address, email, phone, website, legal form, commercial register number, SME flag. Produces an 'operators' lead list dataset (one row per company).", "default": true } } }, "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 } } } } } } } } } }