Authenticatie, invoer en resultaat

Haal de laatste status van het object op met betrekking tot het vastgoedaanbod

POST https://api.altum.ai/movedata

Haal de laatste status van de vastgoedlijst op.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key	string	Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description
postcode*	string	Postcode van het object
housenumber*	number	Huisnummer van het object
addition	string	Toevoeging huisnummer

200: OK Succesvolle reactie

{
    "Output": {
        "BagID": "637010000264937",
        "PostCode": "2728KH",
        "HouseNumber": "5",
        "HouseAddition": null,
        "City": "Zoetermeer",
        "Street": "Bellefleurhof",
        "HouseType": "Tussenwoning",
        "BuildingType": "Eengezinswoning",
        "BuildingPeriod": 1906-1930,
        "BuildYear": "2001",
        "InnerSurfaceArea": "151",
        "OuterSurfaceArea": "136",
        "Volume": "429",
        "ParcelSize": "1223",
        "Longitude": "4.524624609",
        "Latitude": "52.070925902",
        "EnergyLabel": F,
        "ProvisionalEnergyLabel": C,
        "AskingPrice": 123345,
        "ListedSince": 
        "Rooms: "4",
        "Bedrooms": 3,
        "NumberOfFloors": 5,
        "Floor": 4,
        "NumberOfBathrooms": 3,
        "SeparateToilet": 2,
        "EnergyInsulation": "Dakisolatie, dubbel glas en vloerisolatie",
        "Heating": "Cv-ketel",
        "WaterHeating": "Cv-ketel",
        "BoilerType": "Nefit (gas gestookt combiketel uit 2008, eigendom)",
        "LocationType": "Aan water en in woonwijk",
        "GardenType": "Achtertuin, voortuin en zonneterras",
        "Balcony": "Yes",
        "BackyardSize": 71,
        "RoofTerrace": "Yes",
        "SideYardSize": 80,
        "PatioAtriumSize": 12,
        "SunTerraceSize": 29,
        "FrontYardSize": 52,
        "CourtYardSize": 4,
        "StorageType": "Vrijstaande stenen berging, inpanding",
        "StorageRoomFacilities": "Elektra, verwarming en stromend water",
        "ParkingType": "Op eigen terrein en openbaar parkeren",
        "GarageType": "Aangebouwde stenen garage",
        "GarageCapacity": 1,
        "QualityRemarks": "Geen",
        "ConstructionAccessability": "Toegankelijk voor ouderen",
        "Furnishing": "Gedeeltelijk gestoffeerd",
        "Apartment": "Yes",
        "ApartmentType": "Portiekflat",
        "BuildingFacilities": "Dakraam en TV kabel",
        "AskingPricePerM2": 2314,
        "GardenOrientation": "South-West",
        "ObjectStatus": "Verblijfsobject in gebruik",
        "NeighbourhoodCode": "BU05230003",
        "NeighbourhoodName": "Kern Oost-Souburg West",
        "MunicipalityCode": "523",
        "MunicipalityName": "Amsterdam",
        "SourceURL": funda.nl,
        "Realtor Name": "Elfsteden Makelaars en Taxateurs",
        "Realtor URL": "https://funda.nl/makelaars/leeuwarden/60987-elfsteden-makelaars-en-taxateurs/"
    }
}

400: Bad Request Mislukte reactie

{
    "detail": "The requested object is currently not on the market."
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

422: Unprocessable Entity Verkeerd invoerformaat

{
    "detail": [{
        "loc": ["body", 40],
        "msg": "Expecting value: line 3 column 17 (char 40)",
        "type": "value_error.jsondecode",
        "ctx": {
            "msg": "Expecting value",
            "doc": "{\n\t\"postcode\":\"3038VX\",\n\t\"housenumber\": re,\n\t\"addition\": \"A01\"\n}",
            "pos": 40,
            "lineno": 3,
            "colno": 17
        }
    }]
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

429: Too Many Requests API-sleutellimiet overschreden

Ontvang 5 objecten die te huur/verhuurd zijn binnen een postcode

GET https://api.altum.ai/movedata/rent?search=

De 'search'-queryparameter gebruikt PC4-, PC5- of PC6-postcodes. Hierdoor worden 5 objecten weergegeven in termen van relevantie.

Query Parameters

Name	Type	Description
search*	string	Deze parameter gebruikt de postcode die moet worden opgevraagd

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

200: OK Succesvolle reactie

{
  "Output(Rent)": {
    "Listed object(s) within 5104": {
      "ForRent/Rented": 5
    },
    "1": {
      "PostCode": "5104DH",
      "HouseNumber": 34,
      "HouseAddition": null,
      "City": "Dongen",
      "Street": "Jan Mertenslaan",
      "HouseType": "tussenwoning",
      "BuildingType": "Eengezinswoning, tussenwoning",
      "BuildingPeriod": null,
      "BuildYear": 2016,
      "InnerSurfaceArea": "118 m²",
      "OuterSurfaceArea": null,
      "Volume": "421 m³",
      "ParcelSize": "117 m²",
      "EnergyLabel": "A",
      "ProvisionalEnergyLabel": "",
      "AskingPriceSale": "Laatste vraagprijs",
      "AskingPriceRent": "€ 1.100 per maand (geen servicekosten)",
      "ListedSince": "december 4, 2020",
      "SourceURL": "https://www.funda.nl/huur/dongen/huis-41124696-jan-mertenslaan-34/"
    },
    "2": {
      "PostCode": "5104DH",
      "HouseNumber": 34,
      "HouseAddition": null,
      "City": "Dongen",
      "Street": "Jan Mertenslaan",
      "HouseType": "tussenwoning",
      "BuildingType": "Eengezinswoning, tussenwoning",
      "BuildingPeriod": null,
      "BuildYear": 2016,
      "InnerSurfaceArea": "118 m²",
      "OuterSurfaceArea": null,
      "Volume": "421 m³",
      "ParcelSize": "117 m²",
      "EnergyLabel": "A",
      "ProvisionalEnergyLabel": "",
      "AskingPriceSale": "Laatste vraagprijs",
      "AskingPriceRent": "",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/huur/verhuurd/dongen/huis-41124696-jan-mertenslaan-34/"
    },
    "3": {
      "PostCode": "5104KK",
      "HouseNumber": 27,
      "HouseAddition": null,
      "City": "Dongen",
      "Street": "Binnenhoven",
      "HouseType": "tussenwoning",
      "BuildingType": "Eengezinswoning, tussenwoning",
      "BuildingPeriod": null,
      "BuildYear": "Na 2011",
      "InnerSurfaceArea": "125 m²",
      "OuterSurfaceArea": null,
      "Volume": "375 m³",
      "ParcelSize": "",
      "EnergyLabel": "Niet beschikbaar",
      "ProvisionalEnergyLabel": "",
      "AskingPriceSale": "Laatste vraagprijs",
      "AskingPriceRent": "",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/huur/verhuurd/dongen/huis-41011448-binnenhoven-27/"
    },
    "4": {
      "PostCode": "5104DB",
      "HouseNumber": 2,
      "HouseAddition": null,
      "City": "Dongen",
      "Street": "Wagenmaker",
      "HouseType": "eindwoning",
      "BuildingType": "Eengezinswoning, eindwoning",
      "BuildingPeriod": null,
      "BuildYear": 1986,
      "InnerSurfaceArea": "107 m²",
      "OuterSurfaceArea": null,
      "Volume": "375 m³",
      "ParcelSize": "120 m²",
      "EnergyLabel": "D",
      "ProvisionalEnergyLabel": "",
      "AskingPriceSale": "Laatste vraagprijs",
      "AskingPriceRent": "",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/huur/verhuurd/dongen/huis-41156958-wagenmaker-2/"
    },
    "5": {
      "PostCode": "5104GM",
      "HouseNumber": 56,
      "HouseAddition": null,
      "City": "Dongen",
      "Street": "Tramstraat",
      "HouseType": "tussenwoning",
      "BuildingType": "Eengezinswoning, tussenwoning",
      "BuildingPeriod": null,
      "BuildYear": 1966,
      "InnerSurfaceArea": "120 m²",
      "OuterSurfaceArea": null,
      "Volume": "500 m³",
      "ParcelSize": "392 m²",
      "EnergyLabel": "",
      "ProvisionalEnergyLabel": "E",
      "AskingPriceSale": "Laatste vraagprijs",
      "AskingPriceRent": "",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/huur/verhuurd/dongen/huis-41112748-tramstraat-56/"
    }
  }
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

400: Bad Request Mislukte reactie

{
    "detail": "The requested object is currently not on the market."
}

422: Unprocessable Entity Verkeerd invoerformaat

{
  "detail": [
    {
      "loc": [
        "query",
        "search"
      ],
      "msg": "ensure this value has at least 4 characters",
      "type": "value_error.any_str.min_length",
      "ctx": {
        "limit_value": 4
      }
    }
  ]
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

429: Too Many Requests API-sleutellimiet overschreden

Ontvang 5 objecten die te koop/verkocht zijn binnen een postcode

GET https://api.altum.ai/movedata/sale?search=

De zoekparameter 'search' gebruikt postcodes PC4, PC5 of PC6. Hierdoor worden 5 objecten weergegeven in termen van relevantie.

Query Parameters

Name	Type	Description
search*	string	Deze parameter gebruikt de postcode die moet worden opgevraagd

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

200: OK Succesvolle reactie

{
  "Output(Sale)": {
    "Listed object(s) within 4841ES": {
      "ForSale/Sold": 3
    },
    "1": {
      "PostCode": "4841ES",
      "HouseNumber": 126,
      "HouseAddition": null,
      "City": "Prinsenbeek",
      "Street": "Heikantsestraat",
      "HouseType": "eindwoning",
      "BuildingType": "Eengezinswoning, eindwoning",
      "BuildingPeriod": null,
      "BuildYear": 2012.0,
      "InnerSurfaceArea": "116 m²",
      "OuterSurfaceArea": null,
      "Volume": "419 m³",
      "ParcelSize": "132 m²",
      "EnergyLabel": "A",
      "ProvisionalEnergyLabel": null,
      "AskingPriceSale": "€ 350.000 kosten koper",
      "AskingPriceRent": "Overdracht-Laatste huurprijs",
      "ListedSince": "januari 1, 2021",
      "SourceURL": "https://www.funda.nl/koop/prinsenbeek/huis-41258322-heikantsestraat-126/"
    },
    "2": {
      "PostCode": "4841ES",
      "HouseNumber": 124,
      "HouseAddition": null,
      "City": "Prinsenbeek",
      "Street": "Heikantsestraat",
      "HouseType": "eindwoning",
      "BuildingType": "Eengezinswoning, eindwoning",
      "BuildingPeriod": null,
      "BuildYear": 2012.0,
      "InnerSurfaceArea": "117 m²",
      "OuterSurfaceArea": null,
      "Volume": "419 m³",
      "ParcelSize": "132 m²",
      "EnergyLabel": "A",
      "ProvisionalEnergyLabel": null,
      "AskingPriceSale": "",
      "AskingPriceRent": "Overdracht-Laatste huurprijs",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/koop/verkocht/prinsenbeek/huis-41086873-heikantsestraat-124/"
    },
    "3": {
      "PostCode": "4841ES",
      "HouseNumber": 126,
      "HouseAddition": null,
      "City": "Prinsenbeek",
      "Street": "Heikantsestraat",
      "HouseType": "eindwoning",
      "BuildingType": "Eengezinswoning, eindwoning",
      "BuildingPeriod": null,
      "BuildYear": 2012.0,
      "InnerSurfaceArea": "116 m²",
      "OuterSurfaceArea": null,
      "Volume": "419 m³",
      "ParcelSize": "132 m²",
      "EnergyLabel": "A",
      "ProvisionalEnergyLabel": null,
      "AskingPriceSale": "",
      "AskingPriceRent": "Overdracht-Laatste huurprijs",
      "ListedSince": "",
      "SourceURL": "https://www.funda.nl/koop/verkocht/prinsenbeek/huis-41258322-heikantsestraat-126/"
    },
    "4": "No object",
    "5": "No object"
  }
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

422: Unprocessable Entity Verkeerd invoerformaat

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}

429: Too Many Requests API-sleutellimiet overschreden

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

400: Bad Request Mislukte reactie

{
    "detail": "The requested object is currently not on the market."
}

Ontvang het totaalaantal en details van objecten die te koop/verkocht en te huur/verhuurd zijn binnen een postcode

GET https://api.altum.ai/movedata/count?search=

Query Parameters

Name	Type	Description
search*	string	Deze parameter gebruikt de postcode die moet worden opgevraagd

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)

200: OK Succesvolle reactie

{
    "Count": {
        "Postcode": "4841ES",
        "Total": 3,
        "ForSale": 3,
        "ForRent": 0
    },
    "ForSale": {
        "1": {
            "PostCode": "4841ES",
            "HouseNumber": 126,
            "HouseAddition": null,
            "City": "Prinsenbeek",
            "Street": "Heikantsestraat",
            "HouseType": "eindwoning",
            "BuildingType": "Eengezinswoning, eindwoning",
            "BuildingPeriod": null,
            "BuildYear": 2012.0,
            "InnerSurfaceArea": "116 m²",
            "OuterSurfaceArea": null,
            "Volume": "419 m³",
            "ParcelSize": "132 m²",
            "EnergyLabel": "A",
            "ProvisionalEnergyLabel": null,
            "AskingPriceSale": "€ 350.000 kosten koper",
            "AskingPriceRent": "Overdracht-Laatste huurprijs",
            "ListedSince": "januari 1, 2021",
            "SourceURL": "https://www.funda.nl/koop/prinsenbeek/huis-41258322-heikantsestraat-126/"
        },
        "2": {
            "PostCode": "4841ES",
            "HouseNumber": 124,
            "HouseAddition": null,
            "City": "Prinsenbeek",
            "Street": "Heikantsestraat",
            "HouseType": "eindwoning",
            "BuildingType": "Eengezinswoning, eindwoning",
            "BuildingPeriod": null,
            "BuildYear": 2012.0,
            "InnerSurfaceArea": "117 m²",
            "OuterSurfaceArea": null,
            "Volume": "419 m³",
            "ParcelSize": "132 m²",
            "EnergyLabel": "A",
            "ProvisionalEnergyLabel": null,
            "AskingPriceSale": "",
            "AskingPriceRent": "Overdracht-Laatste huurprijs",
            "ListedSince": "",
            "SourceURL": "https://www.funda.nl/koop/verkocht/prinsenbeek/huis-41086873-heikantsestraat-124/"
        },
        "3": {
            "PostCode": "4841ES",
            "HouseNumber": 126,
            "HouseAddition": null,
            "City": "Prinsenbeek",
            "Street": "Heikantsestraat",
            "HouseType": "eindwoning",
            "BuildingType": "Eengezinswoning, eindwoning",
            "BuildingPeriod": null,
            "BuildYear": 2012.0,
            "InnerSurfaceArea": "116 m²",
            "OuterSurfaceArea": null,
            "Volume": "419 m³",
            "ParcelSize": "132 m²",
            "EnergyLabel": "A",
            "ProvisionalEnergyLabel": null,
            "AskingPriceSale": "",
            "AskingPriceRent": "Overdracht-Laatste huurprijs",
            "ListedSince": "",
            "SourceURL": "https://www.funda.nl/koop/verkocht/prinsenbeek/huis-41258322-heikantsestraat-126/"
        },
        "4": "No object",
        "5": "No object"
    },
    "ForRent": {
        "1": "No object",
        "2": "No object",
        "3": "No object",
        "4": "No object",
        "5": "No object"
    }
}

400: Bad Request Mislukte reactie

{
    "detail": "The requested object is currently not on the market."
}

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

403: Forbidden Verboden

{
	"message": "Missing Authentication Token"
}

500: Internal Server Error Service is niet beschikbaar en/of niet beschikbaar

{
	"message": "Internal server error"
}

Untitled

422: Unprocessable Entity Verkeerd invoerformaat

{
  "detail": [
    {
      "loc": [
        "body",
        "postcode"
      ],
      "msg": "string does not match regex \"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$\"",
      "type": "value_error.str.regex",
      "ctx": {
        "pattern": "^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$"
      }
    }
  ]
}

429: Too Many Requests API-sleutellimiet overschreden

Request body

Voorbeeld verzoek

Post

{
	"postcode":"3038VX",
	"housenumber": 26,
	"addition": "A01"
}

Get

https://api.altum.ai/movedata/rent?search=5104

https://api.altum.ai/movedata/sale?search=4841ES

https://api.altum.ai/movedata/count?search=4841ES

Krijg suggesties van objecten die te koop/verkocht zijn met een zoekopdracht

GET https://api.altum.ai/movedata/autosearch?search=

Query Parameters

Name	Type	Description
search*	string	Deze parameter gebruikt de postcode die moet worden opgevraagd
sort	string	Sorteer op "datum" of "relevantie". Standaard is datum
limit	int	Maximaal aantal objecten in reactie

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai).ai)

Respons

De uitvoer van de zoekopdracht is een lijst van objecten met de volgende velden:

Naam	Type	Omschrijving
postcode	string	Postcode van de locatie.
housenumber	int	Huisnummer van de locatie.
houseaddition	string	Eventuele toevoeging aan het huisnummer (bijv. "Hs+1")
city	string	Stad of dorp van de locatie.
street	string	Straatnaam van de locatie
province	string	Provincie van de locatie.
asking_price	int	Vraagprijs van het pand.
date_listed	string	Datum waarop het pand is vermeld (dd/mm/jj).
image	string	URL van de afbeelding van het pand (indien beschikbaar).
market_status	string	De huidige marktstatus van het eigendom en de mogelijke waarden: 'Beschikbaar', 'Verkocht onder voorbehoud', 'Onder bod', 'Onder optie', 'Verkocht', 'Alleen bij goed bod', 'Op termijn te koop'.

Voorbeeld Output

200: OK Succesvolle reactie

{
		"postcode": "1053BM",
		"housenumber": 26,
		"houseaddition": "Hs+1",
		"city": "Amsterdam Bellamybuurt-Zuid",
		"street": "Bellamystraat",
		"province": "Noord-Holland",
		"asking_price": 925000,
		"date_listed": "18/04/24",
		"image": "https://altum-ai.s3.amazonaws.com/image-16258e96-e073-4d61-aec5-555f38c33ca7.png?AWSAccessKeyId=AKIAY5UV7ISWPAGUXLWJ&Signature=GiTJzLIiCNtTzvw%2Fldm%2B9MpQw94%3D&Expires=1715031394"
	},
	{
		"postcode": "1053BP",
		"housenumber": 72,
		"houseaddition": null,
		"city": "Amsterdam Bellamybuurt-Zuid",
		"street": "Bellamystraat",
		"province": "Noord-Holland",
		"asking_price": 1150000,
		"date_listed": "30/03/24",
		"image": "https://altum-ai.s3.amazonaws.com/image-cbfa1bb7-ae54-4852-87f4-f69574f27155.png?AWSAccessKeyId=AKIAY5UV7ISWPAGUXLWJ&Signature=PWujtF1kL7ZwKdmHhfoy2qTt7Qk%3D&Expires=1715031394"
	},
	{
		"postcode": "1974AR",
		"housenumber": 30,
		"houseaddition": null,
		"city": "IJmuiden Bellatrixbuurt",
		"street": "Bellatrixstraat",
		"province": "Noord-Holland",
		"asking_price": 385000,
		"date_listed": "27/07/22",
		"image": "https://altum-ai.s3.amazonaws.com/image-e9407135-d1e6-4b42-99d8-dae3fe2e2ec9.png?AWSAccessKeyId=AKIAY5UV7ISWPAGUXLWJ&Signature=BHd4QoCROK342bt2DWfEn%2BDYHE0%3D&Expires=1715031395"
	},
	{
		"postcode": "8066PX",
		"housenumber": 54,
		"houseaddition": null,
		"city": "Belt-Schutsloot",
		"street": "Belterweg",
		"province": "Overijssel",
		"asking_price": 198000,
		"date_listed": "04/12/20",
		"image": null
	},
	{
		"postcode": "8066PT",
		"housenumber": 14,
		"houseaddition": null,
		"city": "Belt-Schutsloot",
		"street": "Vaste Belterweg",
		"province": "Overijssel",
		"asking_price": 369000,
		"date_listed": "17/09/20",
		"image": null
	}

400: Bad Request Mislukte reactie

{ "detail": "The requested object is currently not on the market." }

422: Unprocessable Entity Verkeerd invoerformaat

{ "detail": [ { "loc": [ "query", "search" ], "msg": "ensure this value has at least 4 characters", "type": "value_error.any_str.min_length", "ctx": { "limit_value": 4 } } ] }

401: Unauthorized Geen toegang

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}