# EP-Online Energy Label Scraper (`nocodeventure/ep-online-energy-label-scraper`) Actor

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.

- **URL**: https://apify.com/nocodeventure/ep-online-energy-label-scraper.md
- **Developed by:** [No-Code Venture](https://apify.com/nocodeventure) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.50 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## EP-Online Energy Label Scraper

An Apify Actor that looks up **registered Dutch energy labels** on [EP-Online](https://ep-online.nl/) by **postcode** and **house number** (huisnummer).

> **API key:** **Not required** for normal use — default **website scrape** needs no key.\
> **Optional:** only if you choose **Official Public API** as the data source, request your **own** RVO key at **[apikey.ep-online.nl](https://apikey.ep-online.nl/)** (free registration via RVO; not supplied by this Actor).

### What it does

- **Scrapes** registered energielabel data from [EP-Online](https://ep-online.nl/) for each address (live HTTP search, HTML parsing, structured JSON output) — **default, no key**
- **Or** calls the **official Public API** (`public.ep-online.nl`, v5) when you set data source to Official Public API and supply an **optional encrypted API key** (Apify secret input)
- Batch lookup for many addresses in one run
- Optional **EP-Online search filters** (same checkboxes as the website — applied to scraped results so your dataset matches the site UI)
- Handles **0, 1, or many** label rows per address (e.g. multiple verblijfsobjecten)
- Extracts label class, dates, certificate holder, **performance metrics**, and **measured values** from each result card
- Conservative rate limits for F5 bot mitigation on ep-online.nl
- Pay Per Event billing with cost caps

### Input

#### API key & data source (read first)

| | |
| --- | --- |
| **Default (`scrape`)** | No API key. Leave **EP-Online API key** empty. |
| **Official Public API (`officialApi`)** | You need an RVO API key → request it at **[apikey.ep-online.nl](https://apikey.ep-online.nl/)** (also linked from [EP-Online open data](https://www.ep-online.nl/PublicData)). Paste it in the Actor’s **EP-Online API key** field (encrypted secret on Apify). |

| Setting | When to use | API key |
| -------- | ----------- | ------- |
| `dataSource`: **`scrape`** (default) | Same data as the EP-Online website UI; filters applied after scrape | **Not used** — leave key empty |
| `dataSource`: **`officialApi`** | RVO [Public REST API v5](https://public.ep-online.nl/swagger/index.html) — BAG IDs, NTA metrics, full `officialApiRecord` on each row | **Your key** from [apikey.ep-online.nl](https://apikey.ep-online.nl/) → `epOnlineApiKey` |

**On Apify:** paste your key into the Actor’s **EP-Online API key** field in the Console input form or API run body. It is stored as an [encrypted secret input](https://docs.apify.com/actors/development/actor-definition/input-schema/secret-input) and is not shown in run logs.

**After you have a key (Official API only):**

1. Confirm activation from RVO’s e-mail (within 24 hours).
2. **Save the key** when RVO shows it — they do not e-mail the key itself.
3. In this Actor: **Data source** = Official Public API, paste key into **EP-Online API key**.

#### Addresses (required)

| Field | Type | Description |
| ----- | ---- | ----------- |
| `addresses` | array | List of `{ "postcode", "houseNumber", "houseNumberAddition?" }` |

Postcode is normalized (uppercase, spaces removed). You can pass `houseNumber` as `18` with `houseNumberAddition` `C`, or combined as `18C` in `houseNumber`. Invalid rows are skipped with a warning; the run fails if none are valid.

#### Address match mode

EP-Online **does not search on huisnummertoevoeging** — a query for `1015KP 18C` still returns every unit at `18` (A, B, C, D, …). By default the Actor keeps **only the row whose result header matches your requested unit**.

| Value | Behavior |
| ----- | -------- |
| `exact` (default) | One dataset row per matching unit (e.g. only `1015KP 18 C`) |
| `all` | Every unit EP-Online returns at that house number |

Each result row includes `resultAddress`, `addressMatched`, and `resultsAtSearchCount` (how many units EP-Online returned before filtering).

#### Search filters

**How to read each checkbox**

| Value | Meaning |
| ----- | ------- |
| **`false` (default)** | **Ignore this filter** — does *not* remove that type. With every box off, you get **all** scraped registrations. |
| **`true`** | **Narrow results** — keep rows that match this category (combined with other groups; see below). |

Optional `searchFilters` mirror the checkboxes on [ep-online.nl](https://ep-online.nl/Energylabel/Search). For each address the Actor **scrapes the full EP-Online search results page**, extracts every registration card, then applies your filter settings when building the dataset — same idea as ticking boxes on the website.

**Groups (Registration type, Status, Building class, Scope):** if **every** box in a group is **off**, that group does not narrow anything. If **any** box in a group is **on**, a row must match **at least one** turned-on option **in that group**.

| Input field | EP-Online (NL) | When **`true`** (when **`false`**, ignored) |
| ----------- | -------------- | --------------------------------------------- |
| `filterEnergyLabel` | Energielabel | Only energielabel registrations (in this group) |
| `filterTailoredAdvice` | Maatwerkadvies | Only maatwerkadvies registrations (in this group) |
| `filterStatusExisting` | Bestaand | Rows with status Bestaand |
| `filterStatusNewLicenseApplication` | Vergunningsaanvraag | Rows with status Vergunningsaanvraag |
| `filterStatusNewCompletion` | Oplevering | Rows with status Oplevering |
| `filterFunctionResidential` | Woningbouw | Residential (woningbouw) rows |
| `filterFunctionUtility` | Utiliteitsbouw | Utility / commercial rows |
| `filterScopeResidence` | Verblijfsobject | Unit-level (verblijfsobject) scope |
| `filterScopeBuilding` | Pand | Whole-building (pand) scope |
| `filterDeletedFalse` | Verwijderd (hidden on site) | Omit deleted registrations |

**How filtering works on the website:** EP-Online returns the full result list for a postcode + house number; checkbox filters narrow what you see in the UI. This Actor follows the same pattern: it loads all registration cards for the address, then applies your `searchFilters` when building dataset rows.

#### Performance

| Field | Default | Description |
| ----- | ------- | ----------- |
| `maxConcurrency` | `1` | Parallel lookups (max 3) |
| `maxRequestsPerMinute` | `30` | Address lookups per minute |
| `proxyConfiguration` | off | Apify proxy (recommended if rate-limited) |

#### Example — single address

```json
{
  "addresses": [
    {
      "postcode": "1221JV",
      "houseNumber": "40"
    }
  ]
}
```

#### Example — batch with filters

```json
{
  "addresses": [
    { "postcode": "1221JV", "houseNumber": "40" },
    { "postcode": "1012AB", "houseNumber": "1", "houseNumberAddition": "A" }
  ],
  "searchFilters": {
    "filterFunctionResidential": true,
    "filterStatusExisting": true
  },
  "maxConcurrency": 1,
  "maxRequestsPerMinute": 30
}
```

#### Scrape vs Official API — what you get (verified runs)

Both modes return the **same shared columns** (`labelClass`, dates, `certificateHolder`, `performanceMetrics`, `measuredValues`, `rawFields`, …). Each row also has `dataSource` (`scrape` | `officialApi`) and, for API runs, a full **`officialApiRecord`** object (typed JSON from RVO OpenAPI). Official API requires your key from **[apikey.ep-online.nl](https://apikey.ep-online.nl/)** (see [API key & data source](#api-key--data-source-read-first) above).

Example comparison with `addressMatchMode: exact` and all search filters off.

##### Example A — utiliteitsgebouw `1221JV 40` (label **B**)

| | **Website scrape** | **Official Public API v5** |
| --- | --- | --- |
| **API key** | Not needed | Your RVO key in **EP-Online API key** |
| **Label & holder** | B, E-Label Nederland B.V. | Same |
| **Energy index** | `1,11` (from HTML) | `1,11` |
| **`performanceMetrics`** | **Empty** — the public result card for this registration does not render the BEREKEND/EIS grid | **Empty** — API response has no NTA metric fields for this record either |
| **`measuredValues`** | Empty on scrape | **Bouwjaar** `1991` |
| **Extra in `rawFields`** | Dutch site labels: registratienummer, BAG verblijfsobject id, EI forfaitair, … | **Gebouwklasse** Utiliteitsbouw, **SBIcode**, **BerekendeCO2Emissie**, **BerekendeEnergieverbruik**, Berekeningstype, BAG IDs, … |
| **`officialApiRecord`** | `null` | Full v5 object (ISO dates, numeric `EnergieIndex`, `Bouwjaar`, …) |
| **Dates (survey / valid until)** | `26-01-2017` / `26-01-2027` | `25-01-2017` / `25-01-2027` (API uses midnight UTC; website text can differ by one day) |

**Takeaway:** for some utiliteits registrations the website shows a **short** card. The API still adds **building class, SBI, CO₂, total energy use, bouwjaar**, and machine-readable BAG fields you will not get from scrape alone.

##### Example B — woningbouw `1015KP 18 C` (label **C**)

| | **Website scrape** | **Official Public API v5** |
| --- | --- | --- |
| **`performanceMetrics`** | **6 rows** (Energiebehoefte, primair fossiel, hernieuwbaar, temperatuuroverschrijding, warmtebehoefte, …) — **EIS column mostly `-`** on the site | **Same 6 calculated values** (mapped to the same labels/units); EIS still `-` when the API does not return requirement fields for this label |
| **`measuredValues`** | Parsed from HTML when shown (e.g. gebruiksoppervlakte) | **Gebruiksoppervlakte thermische zone**, **Compactheid**, **Bouwjaar** |
| **`rawFields`** | Extra Dutch labels from the card | **Status** Bestaand, **Gebouwtype** Appartement, **Gebouwsubtype** Tussendak, **BAGPandIDs**, all NTA numbers as strings, CO₂ / total verbruik, … |
| **`officialApiRecord`** | `null` | Complete structured record (e.g. `BAGVerblijfsobjectID`, `Gebouwklasse` Woningbouw) |

**Takeaway:** for typical **woningbouw** units, scrape and API **align on core metrics** shown on EP-Online. Choose **Official API** when you need **BAG/NTA export fields**, numeric types in `officialApiRecord`, bulk-friendly REST access, or fields that never appear on the HTML card.

##### When to use which

| Choose **scrape** (default) | Choose **officialApi** |
| --- | --- |
| No RVO key; mirror the website UI and filter checkboxes | You have an RVO API key from [apikey.ep-online.nl](https://apikey.ep-online.nl/) |
| OK with HTML-derived formatting (commas, Dutch labels in `rawFields`) | Want `officialApiRecord` + consistent API field names for pipelines |
| Fine with ep-online.nl rate limits / optional proxy | Prefer direct JSON from `public.ep-online.nl` (still rate-limit via `maxRequestsPerMinute`) |

**Search filters** (`searchFilters`) apply in **both** modes after data is fetched (scrape: parsed cards; API: mapped from API fields such as `Gebouwklasse` and `Status`).

### Output

One dataset item **per energy label row** (or one row with `lookupStatus: not_found` when nothing matches).

| Field | Description |
| ----- | ----------- |
| `searchPostcode`, `searchHouseNumber`, `searchHouseNumberAddition`, `searchValue` | Search context |
| `labelClass`, `energyIndex`, `registrationDate`, `surveyDate`, `validUntil`, `certificateHolder` | Registration block (top-level) |
| `performanceMetrics` | Array of `{ label, berekend, eis, unit }` — one entry per grid row (amounts separate from unit) |
| `measuredValues` | Array of `{ label, value, unit }` — e.g. usable floor area `117,49` + `m²` |
| `rawFields` | Other Dutch scalar fields |
| `resultIndex`, `totalResultsAtAddress`, `lookupStatus`, `scrapedAt` | Meta |

Example `performanceMetrics` entry:

```json
{
  "label": "Warmtebehoefte",
  "berekend": "157,04",
  "eis": "-",
  "unit": "kWh/m²⋅jr"
}
```

### Rate limiting

EP-Online uses F5 bot mitigation. Defaults (`maxConcurrency: 1`, `maxRequestsPerMinute: 30`) are conservative. If you see HTTP 429:

- Lower `maxRequestsPerMinute`
- Enable `proxyConfiguration`

Without a proxy, the Actor **aborts** on 429 instead of retrying the same IP indefinitely.

### Pay Per Event billing

| Event | Charged by | Description |
| ----- | ---------- | ----------- |
| `apify-actor-start` | Apify (auto) | Once per run start |
| `apify-default-dataset-item` | Apify (auto) | Once per dataset row pushed |
| `ep-online-lookup` | Custom | Once per input address processed |
| `retry-event` | Custom | Once per retry on a failed lookup request |
| `event-proxy` | Custom | Once per run when using Apify Proxy (no group) |
| `event-proxy-group` | Custom | Once per run when using a proxy group |

In the Apify Console, open this Actor’s **Pricing** tab for current event rates. Cap spend with **Max total charge (USD)** or **Max paid dataset items** when you start a run.

### Disclaimer

This Actor is for lawful use only. By using it you agree to:

- Respect EP-Online / RVO terms and applicable law
- Avoid excessive request rates
- Use data responsibly

This Actor is **not** affiliated with or endorsed by RVO or EP-Online.

### Resources

- [EP-Online](https://ep-online.nl/)
- [EP-Online open data & API key registration](https://www.ep-online.nl/PublicData)
- [Public API v5 (Swagger)](https://public.ep-online.nl/swagger/index.html)
- [Apify Documentation](https://docs.apify.com)
- [Run this Actor via API](https://docs.apify.com/api/v2#tag/ActorsRun-collection)

# Actor input Schema

## `addresses` (type: `array`):

Dutch addresses to look up (postcode + house number). Each row triggers one live EP-Online search.

## `dataSource` (type: `string`):

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.

## `epOnlineApiKey` (type: `string`):

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` (type: `string`):

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.

## `searchFilters` (type: `object`):

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.

## `maxConcurrency` (type: `integer`):

Maximum parallel address lookups. Keep low (1–2) to reduce bot mitigation on ep-online.nl.

## `maxRequestsPerMinute` (type: `integer`):

Maximum address lookups per minute (each lookup may perform 1–2 HTTP calls). Default 30 is conservative for EP-Online.

## `proxyConfiguration` (type: `object`):

Proxy settings. Optional for small runs; recommended if you see rate limiting.

## Actor input object example

```json
{
  "addresses": [
    {
      "postcode": "1221JV",
      "houseNumber": "40"
    }
  ],
  "dataSource": "scrape",
  "addressMatchMode": "exact",
  "searchFilters": {
    "filterEnergyLabel": false,
    "filterTailoredAdvice": false,
    "filterStatusExisting": false,
    "filterStatusNewLicenseApplication": false,
    "filterStatusNewCompletion": false,
    "filterFunctionResidential": false,
    "filterFunctionUtility": false,
    "filterScopeBuilding": false,
    "filterScopeResidence": false,
    "filterDeletedFalse": false
  },
  "maxConcurrency": 1,
  "maxRequestsPerMinute": 30,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `overview` (type: `string`):

Dataset items with all fields

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "addresses": [
        {
            "postcode": "1221JV",
            "houseNumber": "40"
        }
    ],
    "dataSource": "scrape",
    "searchFilters": {
        "filterEnergyLabel": false,
        "filterTailoredAdvice": false,
        "filterStatusExisting": false,
        "filterStatusNewLicenseApplication": false,
        "filterStatusNewCompletion": false,
        "filterFunctionResidential": false,
        "filterFunctionUtility": false,
        "filterScopeBuilding": false,
        "filterScopeResidence": false,
        "filterDeletedFalse": false
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("nocodeventure/ep-online-energy-label-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "addresses": [{
            "postcode": "1221JV",
            "houseNumber": "40",
        }],
    "dataSource": "scrape",
    "searchFilters": {
        "filterEnergyLabel": False,
        "filterTailoredAdvice": False,
        "filterStatusExisting": False,
        "filterStatusNewLicenseApplication": False,
        "filterStatusNewCompletion": False,
        "filterFunctionResidential": False,
        "filterFunctionUtility": False,
        "filterScopeBuilding": False,
        "filterScopeResidence": False,
        "filterDeletedFalse": False,
    },
}

# Run the Actor and wait for it to finish
run = client.actor("nocodeventure/ep-online-energy-label-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "addresses": [
    {
      "postcode": "1221JV",
      "houseNumber": "40"
    }
  ],
  "dataSource": "scrape",
  "searchFilters": {
    "filterEnergyLabel": false,
    "filterTailoredAdvice": false,
    "filterStatusExisting": false,
    "filterStatusNewLicenseApplication": false,
    "filterStatusNewCompletion": false,
    "filterFunctionResidential": false,
    "filterFunctionUtility": false,
    "filterScopeBuilding": false,
    "filterScopeResidence": false,
    "filterDeletedFalse": false
  }
}' |
apify call nocodeventure/ep-online-energy-label-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,nocodeventure/ep-online-energy-label-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/gZyiGOkj4ewgUkPfs/builds/g6Yq7SRZ4Bak1p2MU/openapi.json