# Address Profile (`polder-data/address-profile`) Actor

- **URL**: https://apify.com/polder-data/address-profile.md
- **Developed by:** [Rob Schulte](https://apify.com/polder-data) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.00 / 1,000 address profiles

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## Address profile

This Actor turns a Dutch address into 1 profile item. One call gives you building facts and neighbourhood figures.

### What you send

Send a list called `items`. It holds at most 1000 items per run.
Each item is one of these:

- A postcode and a house number. You may add a house letter and a house number addition.
- A BAG `nummeraanduidingId` on its own.

No other field is allowed.

### What you get

You get 1 dataset item for each input item, in the same order. A profile item holds:

- The BAG ids of the address, the unit and the building.
- Building facts: construction year, use purpose, floor area, status and the number of units in the building.
- The `buurtcode`, `wijkcode` and `gemeentecode`.
- A fixed list of neighbourhood figures, such as inhabitants, households, home ownership and average energy use.
- A `sources` field with each source, its licence and its credit line.

The Actor gives no property tax value and no energy label.

A bad input item or an address that is not found gives an error item with the code `invalid_input` or `address_not_found`. The run still succeeds.
A source that keeps failing gives an error item with the code `source_unavailable`. It costs nothing.

At the end of each run the Actor writes the record `RUN_SUMMARY`. It holds counts only.
When a run reaches your maximum charge per run, it stops and delivers no more items. `RUN_SUMMARY` then shows `charge_limit_reached` as true.

### Price

A test run of 1,000 items used 0.04689 compute units.
The Actor charges USD 0.002 for each profile item. That is USD 2.00 per 1,000 profile items.
It charges USD 0.0005 for each `invalid_input` or `address_not_found` error item.
A `source_unavailable` item charges nothing.

### Sources and licences

- Basisregistratie Adressen en Gebouwen (BAG), from the Kadaster. Licence: Public Domain Mark 1.0. Credit: BAG: public domain.
- PDOK Locatieserver. Free and open use. Credit: PDOK.
- CBS Kerncijfers wijken en buurten 2024, table 85984NED. Licence: CC BY 4.0. Credit: Bron: CBS.

CBS does not endorse this Actor.

### Fair use

The Actor sends at most 5 requests a second to each source host. It retries a failed request up to 3 times, with a pause between tries.

### Your data

The addresses you send stay in your own run. The Actor stores nothing of them outside your run. The run log holds counts, codes and ids only.

# Actor input Schema

## `items` (type: `array`):

A list of addresses. Each one is a postcode with a house number, or a BAG nummeraanduidingId. The code checks the values and allows at most 1000 items.

## Actor input object example

```json
{
  "items": [
    {
      "postcode": "1011PN",
      "houseNumber": 1
    },
    {
      "postcode": "3011AD",
      "houseNumber": 40
    }
  ]
}
```

# Actor output Schema

## `results` (type: `string`):

The profile of each address in this run, one item per address.

## `runSummary` (type: `string`):

A short summary of this run, with the counts of addresses done.

# 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 = {
    "items": [
        {
            "postcode": "1011PN",
            "houseNumber": 1
        },
        {
            "postcode": "3011AD",
            "houseNumber": 40
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("polder-data/address-profile").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 = { "items": [
        {
            "postcode": "1011PN",
            "houseNumber": 1,
        },
        {
            "postcode": "3011AD",
            "houseNumber": 40,
        },
    ] }

# Run the Actor and wait for it to finish
run = client.actor("polder-data/address-profile").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 '{
  "items": [
    {
      "postcode": "1011PN",
      "houseNumber": 1
    },
    {
      "postcode": "3011AD",
      "houseNumber": 40
    }
  ]
}' |
apify call polder-data/address-profile --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,polder-data/address-profile"
        }
    }
}
```

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/Gb3t0x9dVN8wo5rOy/builds/VEpsyKRVdKShHiHqF/openapi.json