API Referentie

Technische referentie voor de Voseno API eindpunten.

Authenticatie

Alle API-verzoeken vereisen een API-sleutel in de header X-API-Key.

curl "https://api.voseno.com/v1/listings" \
  -H "X-API-Key: jouw_api_sleutel_hier"

Eindpunten

Aanbod (Listings)

`GET /v1/listings`

Zoek naar woningaanbod over alle aangesloten bronnen.

Parameters

Naam	Type	Vereist	Beschrijving
`city`	string	Nee	Filter op stadsnaam (bijv. “Amsterdam”)
`min_price`	number	Nee	Minimumprijs in Euro’s
`max_price`	number	Nee	Maximumprijs in Euro’s
`type`	string	Nee	`rent` (huur) of `buy` (oop)

Reactie

{
  "data": [
    {
      "id": "lis_123456789",
      "address": {
        "street": "Keizersgracht",
        "number": "123",
        "city": "Amsterdam",
        "postcode": "1015 CJ"
      },
      "price": 2500,
      "surface_area": 85,
      "source": {
        "name": "Funda",
        "url": "https://funda.nl/..."
      }
    }
  ],
  "meta": {
    "total": 124,
    "page": 1
  }
}

Woningen (Properties)

`GET /v1/properties/{bag_id}`

Haal het Gouden Record op voor een specifieke woning met behulp van de BAG ID.

Reactie (Voorbeeld)

{
  "bag_id": "0363010000xxxxxx",
  "building": {
    "year_built": 1905,
    "energy_label": "C",
    "woz_value": 545000
  },
  "valuation": {
    "estimated_price": 560000,
    "confidence": "high"
  }
}

Fouten

De API gebruikt standaard HTTP-statuscodes om het succes of falen van een API-verzoek aan te geven.

200 OK: Verzoek geslaagd.
400 Bad Request: Ongeldige parameters.
401 Unauthorized: Ongeldige API-sleutel.
404 Not Found: Bron niet gevonden.
429 Too Many Requests: Snelheidslimiet overschreden.