# Dutch Real Estate Vector Search API (Funda, VBO, Huispedia,..) (`ramin332/vector-api`) Actor

Semantic vector search over Dutch property listings (Funda, VBO, Huispedia and Pararius). Drop-in Qdrant-compatible API: point qdrant-client at it, send a query vector, get scoped, ranked matches. Build AI property search, RAG, and recommendations. Get an API key at portal.househugger.nl.

- **URL**: https://apify.com/ramin332/vector-api.md
- **Developed by:** [Ramin Ariana](https://apify.com/ramin332) (community)
- **Categories:** Real estate, AI, Developer tools
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Dutch Real Estate Vector Search API — Funda, Vastgoed Nederland & Huispedia listings, AI semantic search

Semantic **vector search over Dutch property listings** (Funda, Vastgoed Nederland, Huispedia, and more),
served as a drop-in **Qdrant-compatible API**. Point the official `qdrant-client` at this
endpoint, send a query vector, and get back the most similar `woningen` — ranked by
meaning, not keywords. Built for developers shipping **AI property search, RAG, and
recommendation** features over the Netherlands housing market.

> Powered by [Househugger](https://portal.househugger.nl). Same infrastructure that runs
> in production — this is a hosted, production endpoint you can call today.

### What you get

- **Semantic / vector search** over Dutch real estate listings — embeddings-based
  similarity, so "licht appartement met tuin bij het water" matches on *intent*, not exact
  words.
- **Qdrant-native** — use the real `qdrant-client` (Python/JS/Rust) unchanged. No new SDK
  to learn. `search`, `query`, `scroll`, retrieve-by-id all supported.
- **Scoped & safe** — every request is filtered to exactly the data slice your key is
  entitled to. You can narrow further; you can never see another tenant's data.
- **Fast, read-optimized** — a thin proxy over a managed Qdrant Cloud collection.

### Use cases

- AI-powered property search & discovery for a portal or app
- Retrieval-Augmented Generation (RAG) over housing data for an LLM assistant
- "Similar homes" / recommendation engines
- Lead enrichment and market analysis over Funda / Vastgoed Nederland listings

### How to call it

This runs in **Standby mode** — a always-on HTTP server, not a batch job. Authenticate
with your API key and use `qdrant-client` as usual:

```python
from qdrant_client import QdrantClient

client = QdrantClient(
    url="https://vectorapi.househugger.nl/",
    api_key="<your-househugger-key>",   # sent as the api-key header
)

hits = client.query_points(
    collection_name="vectors",
    query=my_query_vector,   # bring your own embedding
    limit=10,
).points
```

You bring the query vector (embed with any model you like); the API returns scoped,
ranked matches. Writes and admin calls are rejected — this endpoint is **read-only** by
design.

### Get access

You need a Househugger API key. It's the real gate — calls without a valid key return
`401`.

👉 **[Sign up & get your API key at portal.househugger.nl](https://portal.househugger.nl)**

Pick a plan, self-serve a key, and start querying in minutes.

### Notes

- **Does:** forward semantic reads (search / query / scroll / retrieve-by-id) with your
  entitlement enforced on every filter and prefetch.
- **Does not:** embed text for you, ingest, upsert, or expose data outside your slice.

***

*Keywords: Dutch real estate API, Funda data, Vastgoed Nederland, Huispedia, Netherlands property search,
woning zoeken, vector database, Qdrant, semantic search, embeddings, RAG, AI real estate,
huizen API.*

# Actor input Schema

## Actor input object example

```json
{}
```

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("ramin332/vector-api").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("ramin332/vector-api").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 '{}' |
apify call ramin332/vector-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,ramin332/vector-api"
        }
    }
}

```

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/gTyaeD9d2ebHXWCSL/builds/BHw7P6WyYyrThD46R/openapi.json
