{"openapi":"3.0.2","info":{"title":"AVM API","description":"Predicts the transaction value for a given house address.","version":"1.0"},"paths":{"/avm":{"post":{"tags":["v1"],"summary":"Displays the AVM data as well as the prediction.","operationId":"output_avm_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1__models__AVM"}}},"required":true},"responses":{"200":{"description":"Prediction for the given house address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1__models__AVMSuccessfulResponse"},"example":{"Output":{"BagID":"str","PostCode":"str","HouseNumber":"int","HouseAddition":"str","City":"str","Street":"str","HouseType":"str","BuildYear":"int","InnerSurfaceArea":"int","OuterSurfaceArea":"int","Volume":"int","EnergyLabel":"str","Longitude":"float","Latitude":"float","Rooms":"int","Image":"str","ValuationDate":"int","PriceEstimation":"int","Confidence":"str","AccuracyIndicator":"str"}}}}},"400":{"description":"The given house address was not found in database.","content":{"application/json":{"example":{"Output":"The given house address was not found in database."}}}},"422":{"description":"Validation Error.","content":{"application/json":{"example":{"detail":[{"loc":["query","housenumber"],"msg":"ensure this value is greater than 0","type":"value_error.number.not_gt","ctx":{"limit_value":0}}]}}}}}}},"/avm/bulk":{"post":{"tags":["v1"],"summary":"Submit a bulk AVM job.","operationId":"submit_bulk_avm_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1__models__AVMBulkRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/avm/bulk/{job_id}":{"get":{"tags":["v1"],"summary":"Poll status and result URL of a bulk AVM job.","operationId":"get_bulk_status_avm_bulk__job_id__get","parameters":[{"required":true,"schema":{"title":"Job Id","type":"string"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/avm":{"post":{"tags":["v2"],"summary":"Displays the AVM data as well as the prediction.","operationId":"output_v2_avm_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2__models__AVM"}}},"required":true},"responses":{"200":{"description":"Prediction for the given house address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2__models__AVMSuccessfulResponse"},"example":{"Output":{"BagID":"str","PostCode":"str","HouseNumber":"int","HouseAddition":"str","City":"str","Street":"str","HouseType":"str","BuildYear":"int","InnerSurfaceArea":"int","OuterSurfaceArea":"int","Volume":"int","EnergyLabel":"str","Longitude":"float","Latitude":"float","Rooms":"int","Image":"str","ValuationDate":"int","PriceEstimation":"int","Confidence":"str","AccuracyIndicator":"str"}}}}},"400":{"description":"The given house address was not found in database.","content":{"application/json":{"example":{"Output":"The given house address was not found in database."}}}},"422":{"description":"Validation Error.","content":{"application/json":{"example":{"detail":[{"loc":["query","housenumber"],"msg":"ensure this value is greater than 0","type":"value_error.number.not_gt","ctx":{"limit_value":0}}]}}}}}}},"/v2/avm/bulk":{"post":{"tags":["v2"],"summary":"Submit a bulk AVM job.","operationId":"submit_bulk_v2_avm_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2__models__AVMBulkRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/avm/bulk/{job_id}":{"get":{"tags":["v2"],"summary":"Poll status and result URL of a bulk AVM job.","operationId":"get_bulk_status_v2_avm_bulk__job_id__get","parameters":[{"required":true,"schema":{"title":"Job Id","type":"string"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"v1__models__AVM":{"title":"AVM","required":["postcode","housenumber"],"type":"object","properties":{"postcode":{"title":"Postcode of the given house.","pattern":"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$","type":"string","example":"1234AB"},"housenumber":{"title":"House number of the given house.","minimum":1.0,"type":"integer","example":1},"houseaddition":{"title":"House addition of the given house.","type":"string","default":""},"valuationdate":{"title":"Valuationdate","type":"string","format":"date","default":""},"buildyear":{"title":"Buildyear","maximum":2026.0,"minimum":1800.0,"type":"integer"},"innersurfacearea":{"title":"Innersurfacearea","minimum":1.0,"type":"number"},"outersurfacearea":{"title":"Outersurfacearea","minimum":0.0,"type":"number"},"volume":{"title":"Volume","minimum":1.0,"type":"number"},"housetype":{"title":"Housetype","enum":["Vrijstaande woning","2 onder 1 kap woning","Geschakelde 2 onder 1 kapwoning","Geschakelde woning","Tussen/rijwoning","Hoekwoning","Eindwoning","Galerijflat","Portiekflat","Corridorflat","Maisonnette","Benedenwoning","Bovenwoning","Portiekwoning","Halfvrijstaande woning"],"type":"string"},"energylabel":{"title":"Energylabel","enum":["G","F","E","D","C","B","A","A+","A++","A+++","A++++","A+++++"],"type":"string"},"image":{"title":"Image","enum":[0,1],"type":"integer","default":0}}},"v1__models__AVMBulkRequest":{"title":"AVMBulkRequest","required":["items"],"type":"object","properties":{"items":{"title":"Items","type":"array","items":{"$ref":"#/components/schemas/v1__models__AVM"}}}},"v1__models__AVMSuccessfulResponse":{"title":"AVMSuccessfulResponse","required":["Output"],"type":"object","properties":{"Output":{"$ref":"#/components/schemas/v1__models__Output"}}},"v1__models__Output":{"title":"Output","required":["PostCode","HouseNumber","ValuationDate","PriceEstimation"],"type":"object","properties":{"BagID":{"title":"Bagid","type":"string"},"PostCode":{"title":"Postcode","type":"string"},"HouseNumber":{"title":"Housenumber","type":"integer"},"HouseAddition":{"title":"Houseaddition","type":"string"},"City":{"title":"City","type":"string"},"Street":{"title":"Street","type":"string"},"HouseType":{"title":"Housetype","type":"string"},"BuildYear":{"title":"Buildyear","type":"integer"},"InnerSurfaceArea":{"title":"Innersurfacearea","type":"integer"},"OuterSurfaceArea":{"title":"Outersurfacearea","type":"integer"},"Volume":{"title":"Volume","type":"integer"},"EnergyLabel":{"title":"Energylabel","type":"string"},"Longitude":{"title":"Longitude","type":"number"},"Latitude":{"title":"Latitude","type":"number"},"Rooms":{"title":"Rooms","type":"integer"},"Image":{"title":"Image","type":"string"},"ValuationDate":{"title":"Valuationdate","type":"integer"},"PriceEstimation":{"title":"Priceestimation","type":"integer"},"Confidence":{"title":"Confidence","type":"string"},"AccuracyIndicator":{"title":"Accuracyindicator","type":"string"}},"example":{"BagID":"0637010000206955","PostCode":"2728KH","HouseNumber":9,"HouseAddition":"A","City":"Zoetermeer","Street":"Bellefleurhof","HouseType":"Tussen/rijwoning","BuildYear":2001,"InnerSurfaceArea":133,"OuterSurfaceArea":136,"Volume":467,"EnergyLabel":"A","Longitude":4.524755810289617,"Latitude":52.070850461775926,"ValuationDate":20230811,"PriceEstimation":463257,"Confidence":"90% Confidence Interval is 416931-509582.","AccuracyIndicator":"3"}},"v2__models__AVM":{"title":"AVM","required":["postcode","housenumber"],"type":"object","properties":{"postcode":{"title":"Postcode of the given house.","pattern":"^(?!1000|1001|1002|1003|1004|1005|1006|1007|1008|1009|1010)[1-9][0-9]{3}[A-Z]{2}$","type":"string","example":"1234AB"},"housenumber":{"title":"House number of the given house.","minimum":1.0,"type":"integer","example":1},"houseaddition":{"title":"House addition of the given house.","type":"string","default":""},"valuationdate":{"title":"Valuationdate","type":"string","format":"date","default":""},"buildyear":{"title":"Buildyear","maximum":2026.0,"minimum":1800.0,"type":"integer"},"innersurfacearea":{"title":"Innersurfacearea","minimum":1.0,"type":"number"},"outersurfacearea":{"title":"Outersurfacearea","minimum":0.0,"type":"number"},"housetype":{"title":"Housetype","enum":["Vrijstaande woning","2 onder 1 kap woning","Geschakelde 2 onder 1 kapwoning","Geschakelde woning","Tussen/rijwoning","Hoekwoning","Eindwoning","Galerijflat","Portiekflat","Corridorflat","Maisonnette","Benedenwoning","Bovenwoning","Portiekwoning","Halfvrijstaande woning"],"type":"string"},"energylabel":{"title":"Energylabel","enum":["G","F","E","D","C","B","A","A+","A++","A+++","A++++","A+++++"],"type":"string"},"image":{"title":"Image","enum":[0,1],"type":"integer","default":0}}},"v2__models__AVMBulkRequest":{"title":"AVMBulkRequest","required":["items"],"type":"object","properties":{"items":{"title":"Items","type":"array","items":{"$ref":"#/components/schemas/v2__models__AVM"}}}},"v2__models__AVMSuccessfulResponse":{"title":"AVMSuccessfulResponse","required":["Output"],"type":"object","properties":{"Output":{"$ref":"#/components/schemas/v2__models__Output"}}},"v2__models__Output":{"title":"Output","required":["postcode","housenumber","valuation_date","price_estimation"],"type":"object","properties":{"bag_id":{"title":"Bag Id","type":"string"},"postcode":{"title":"Postcode","type":"string"},"housenumber":{"title":"Housenumber","type":"integer"},"houseaddition":{"title":"Houseaddition","type":"string"},"city":{"title":"City","type":"string"},"street":{"title":"Street","type":"string"},"house_type":{"title":"House Type","type":"string"},"build_year":{"title":"Build Year","type":"integer"},"inner_surface_area":{"title":"Inner Surface Area","type":"integer"},"outer_surface_area":{"title":"Outer Surface Area","type":"integer"},"volume":{"title":"Volume","type":"integer"},"energy_label":{"title":"Energy Label","type":"string"},"longitude":{"title":"Longitude","type":"number"},"latitude":{"title":"Latitude","type":"number"},"image":{"title":"Image","type":"string"},"valuation_date":{"title":"Valuation Date","type":"integer"},"price_estimation":{"title":"Price Estimation","type":"integer"},"confidence":{"title":"Confidence","type":"string"},"accuracy_indicator":{"title":"Accuracy Indicator","type":"string"},"model_version":{"title":"Model Version","type":"string"}},"example":{"bag_id":"0637010000206955","postcode":"2728KH","housenumber":9,"houseaddition":"A","city":"Zoetermeer","street":"Bellefleurhof","house_type":"Tussen/rijwoning","build_year":2001,"inner_surface_area":133,"outer_surface_area":136,"volume":467,"energy_label":"A","longitude":4.524755810289617,"latitude":52.070850461775926,"valuation_date":20230811,"price_estimation":463257,"confidence":"90% Confidence Interval is 416931-509582.","accuracy_indicator":"3","model_version":"202606_ch8956"}}}}}