Skip to main content
POST
/
api
/
funda
/
listings
/
search
/funda/listings/search
curl --request POST \
  --url https://api.anysite.io/api/funda/listings/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "area": "<string>",
  "count": 2,
  "timeout": 300,
  "mode": "koop"
}
'
[
  {
    "id": "<string>",
    "@type": "@funda_search_listing",
    "url": "<string>",
    "object_type": "<string>",
    "offering_type": "<string>",
    "status": "<string>",
    "address": {
      "@type": "@funda_search_address",
      "street": "<string>",
      "house_number": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "neighbourhood": "<string>",
      "province": "<string>",
      "country": "<string>"
    },
    "price": 123,
    "price_label": "<string>",
    "living_area_m2": 123,
    "room_count": 123,
    "bedroom_count": 123,
    "energy_label": "<string>",
    "construction_type": "<string>",
    "blikvanger": "<string>",
    "available_media_types": [],
    "images": [],
    "agent": {
      "@type": "@funda_search_agent",
      "id": "<string>",
      "name": "<string>",
      "association": "<string>",
      "url": "<string>"
    },
    "publish_date": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
area
string
required

Area to search in: a city, or city/neighbourhood

Minimum string length: 1
Examples:

"amsterdam"

"utrecht"

"amsterdam/cremerbuurt-west"

count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
mode
enum<string>
default:koop

Listing mode

Available options:
koop,
huur,
nieuwbouw,
recreatie

Response

Successful Response

id
string
required
@type
string
default:@funda_search_listing
url
string | null
object_type
string | null
offering_type
string | null
status
string | null
address
FundaSearchAddress · object
price
integer | null
price_label
string | null
living_area_m2
integer | null
room_count
integer | null
bedroom_count
integer | null
energy_label
string | null
construction_type
string | null
blikvanger
string | null
available_media_types
string[]
images
string[]
agent
FundaSearchAgent · object
publish_date
string | null