{
  "openapi": "3.0.1",
  "info": {
    "title": "EP-Online Energy Label Scraper",
    "description": "EP-Online Actor for Netherlands energielabel data: postcode + huisnummer lookups, batch input, EP-Online search filters, exact toevoeging or all units at one address. Exports label class, dates, certificate holder, performance metrics. Public search. Pay per event. Not affiliated with RVO.",
    "version": "0.0",
    "x-build-id": "g6Yq7SRZ4Bak1p2MU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nocodeventure~ep-online-energy-label-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nocodeventure-ep-online-energy-label-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/nocodeventure~ep-online-energy-label-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nocodeventure-ep-online-energy-label-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/nocodeventure~ep-online-energy-label-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nocodeventure-ep-online-energy-label-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",
        "required": [
          "addresses"
        ],
        "properties": {
          "addresses": {
            "title": "Addresses",
            "minItems": 1,
            "type": "array",
            "description": "Dutch addresses to look up (postcode + house number). Each row triggers one live EP-Online search.",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "postcode": {
                  "type": "string",
                  "title": "Postcode",
                  "description": "Dutch postcode (e.g. 1234AB)",
                  "editor": "textfield",
                  "pattern": "^[1-9][0-9]{3}\\s?[A-Za-z]{2}$",
                  "minLength": 6
                },
                "houseNumber": {
                  "type": "string",
                  "title": "House number",
                  "description": "House number (huisnummer). You may include the suffix here (e.g. 18C) or use the field below.",
                  "editor": "textfield",
                  "minLength": 1
                },
                "houseNumberAddition": {
                  "type": "string",
                  "title": "House number addition",
                  "description": "Optional suffix (toevoeging), e.g. A or bis. Omit or leave empty if not used.",
                  "editor": "textfield"
                }
              },
              "required": [
                "postcode",
                "houseNumber"
              ]
            },
            "default": [
              {
                "postcode": "1221JV",
                "houseNumber": "40"
              }
            ]
          },
          "dataSource": {
            "title": "Data source",
            "enum": [
              "scrape",
              "officialApi"
            ],
            "type": "string",
            "description": "Default **Website scrape** needs no API key. Choose **Official Public API** for RVO Public REST API v5 (extra BAG/NTA fields); then you must fill the optional secret API key field below.",
            "default": "scrape"
          },
          "epOnlineApiKey": {
            "title": "EP-Online API key",
            "type": "string",
            "description": "Optional. Leave empty for website scrape (default). Required when Data source is Official Public API — your RVO key is sent as the Authorization header. On Apify this field is encrypted (isSecret); Actor.getInput() decrypts it automatically. Local dev only: you may use EP_ONLINE_API_KEY in a gitignored `.env` instead of putting the key in INPUT.json. Request a key at https://apikey.ep-online.nl/"
          },
          "addressMatchMode": {
            "title": "Address match mode",
            "enum": [
              "exact",
              "all"
            ],
            "type": "string",
            "description": "EP-Online ignores huisnummertoevoeging in search and may return every unit at the same house number (18 A, 18 B, …). `exact` keeps only the row matching your postcode + huisnummer + toevoeging (default). `all` returns every unit EP-Online lists.",
            "default": "exact"
          },
          "searchFilters": {
            "title": "EP-Online search filters",
            "type": "object",
            "description": "Optional narrowing after each scrape. DEFAULT: every checkbox is OFF — that means no extra filtering; you get all registrations EP-Online returned (same as the website with no boxes ticked). Turn a checkbox ON only when you want to limit results to that category. OFF never means exclude; it means ignore this filter.",
            "properties": {
              "filterEnergyLabel": {
                "title": "Energy label (Energielabel)",
                "type": "boolean",
                "description": "OFF (default): ignore — still includes energielabel rows. ON: narrow to official energielabel registrations only (within this registration-type group).",
                "editor": "checkbox",
                "groupCaption": "Registration type",
                "groupDescription": "Leave both OFF for all registration types. If either is ON, rows must match at least one ON option in this group.",
                "default": false
              },
              "filterTailoredAdvice": {
                "title": "Tailored advice (Maatwerkadvies)",
                "type": "boolean",
                "description": "OFF (default): ignore — still includes maatwerkadvies rows. ON: narrow to maatwerkadvies registrations only (within this group).",
                "editor": "checkbox",
                "default": false
              },
              "filterStatusExisting": {
                "title": "Existing building (Bestaand)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep rows with status Bestaand (and other ON status boxes in this group, if any).",
                "editor": "checkbox",
                "groupCaption": "Status",
                "groupDescription": "Leave all OFF for every status. If any is ON, rows must match at least one ON status in this group.",
                "default": false
              },
              "filterStatusNewLicenseApplication": {
                "title": "Permit application (Vergunningsaanvraag)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep rows with status Vergunningsaanvraag.",
                "editor": "checkbox",
                "default": false
              },
              "filterStatusNewCompletion": {
                "title": "New completion (Oplevering)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep rows with status Oplevering.",
                "editor": "checkbox",
                "default": false
              },
              "filterFunctionResidential": {
                "title": "Residential (Woningbouw)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep woningbouw (residential) rows only in this building-class group.",
                "editor": "checkbox",
                "groupCaption": "Building class",
                "groupDescription": "Leave both OFF for all building classes. If either is ON, rows must match at least one ON class in this group.",
                "default": false
              },
              "filterFunctionUtility": {
                "title": "Utility / commercial (Utiliteitsbouw)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep utiliteitsbouw (non-residential) rows only in this group.",
                "editor": "checkbox",
                "default": false
              },
              "filterScopeBuilding": {
                "title": "Whole building (Pand)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep pand (whole-building) scope rows in this group.",
                "editor": "checkbox",
                "groupCaption": "Scope",
                "groupDescription": "Leave both OFF for all scopes. If either is ON, rows must match at least one ON scope in this group.",
                "default": false
              },
              "filterScopeResidence": {
                "title": "Dwelling unit (Verblijfsobject)",
                "type": "boolean",
                "description": "OFF (default): ignore. ON: keep verblijfsobject (unit-level) scope rows in this group.",
                "editor": "checkbox",
                "default": false
              },
              "filterDeletedFalse": {
                "title": "Hide deleted registrations",
                "type": "boolean",
                "description": "OFF (default): ignore deleted flag. ON: drop registrations marked deleted on EP-Online (advanced; hidden checkbox on the public site).",
                "editor": "checkbox",
                "default": false
              }
            },
            "default": {
              "filterEnergyLabel": false,
              "filterTailoredAdvice": false,
              "filterStatusExisting": false,
              "filterStatusNewLicenseApplication": false,
              "filterStatusNewCompletion": false,
              "filterFunctionResidential": false,
              "filterFunctionUtility": false,
              "filterScopeBuilding": false,
              "filterScopeResidence": false,
              "filterDeletedFalse": false
            },
            "additionalProperties": false
          },
          "maxConcurrency": {
            "title": "Max Concurrency",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Maximum parallel address lookups. Keep low (1–2) to reduce bot mitigation on ep-online.nl.",
            "default": 1
          },
          "maxRequestsPerMinute": {
            "title": "Max Lookups Per Minute",
            "minimum": 1,
            "maximum": 120,
            "type": "integer",
            "description": "Maximum address lookups per minute (each lookup may perform 1–2 HTTP calls). Default 30 is conservative for EP-Online.",
            "default": 30
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Proxy settings. Optional for small runs; recommended if you see rate limiting.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}