{"openapi":"3.1.0","info":{"title":"Huispedia Data Intelligence API","version":"5.0.0","description":"Home values and property data for every address in the Netherlands: characteristics, transactions, neighbourhood and market."},"servers":[{"url":"https://huispedia.dev","description":"Production"}],"paths":{"/v5/catalog":{"get":{"tags":["Catalogue"],"summary":"The catalogue","description":"The credits per endpoint, the free tier, the limits and the sources. No key needed.","operationId":"getCatalog","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"catalog","x-credits":0,"x-visibility":"public","x-family":"account","x-description-nl":"De openbare catalogus: endpoints, credits, velden, bronnen en bundels.","externalDocs":{"url":"https://huispedia.dev/en/docs/credits/","description":"Credits and pricing"},"x-badges":[{"name":"Free","position":"before"}]}},"/v5/account":{"get":{"tags":["Account"],"summary":"Your account","description":"The balance by bucket, the spend cap, the limits and the entitlements of the account this key belongs to.","operationId":"getAccount","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-product":"account","x-credits":0,"x-visibility":"public","x-family":"account","externalDocs":{"url":"https://huispedia.dev/en/docs/credits/","description":"Credits and pricing"},"x-badges":[{"name":"Free","position":"before"}]}},"/v5/account/usage":{"get":{"tags":["Account"],"summary":"Usage per day, endpoint and key","description":"Calls and credits per day, endpoint or key, at most 92 days per call.","operationId":"getAccountUsage","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"},"description":"Start of the period."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"},"description":"End of the period."},{"name":"group_by","in":"query","required":false,"schema":{"type":"string","pattern":"^(day|endpoint|key)(,(day|endpoint|key))*$","default":"day","title":"Group By"},"description":"Comma list of day, endpoint, key."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"account_usage","x-credits":0,"x-visibility":"public","x-family":"account","externalDocs":{"url":"https://huispedia.dev/en/docs/credits/","description":"Credits and pricing"},"x-badges":[{"name":"Free","position":"before"}]}},"/v5/account/requests":{"get":{"tags":["Account"],"summary":"The request log (30 days)","description":"One row per call of the last 30 days: when, which endpoint, status, credits and duration.","operationId":"getAccountRequests","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"From"},"description":"Start of the period."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"To"},"description":"End of the period."},{"name":"key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"},"description":"Only calls with this key."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status"},"description":"Only calls with this HTTP status."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"},"description":"Rows per page, at most 100."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"description":"The next page: meta.next_cursor of the previous answer."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"account_requests","x-credits":0,"x-visibility":"public","x-family":"account","externalDocs":{"url":"https://huispedia.dev/en/docs/credits/","description":"Credits and pricing"},"x-badges":[{"name":"Free","position":"before"}]}},"/v5/addresses/suggest":{"get":{"tags":["Addresses"],"summary":"Address autocomplete (free)","description":"Finds addresses and streets while you type: by postcode, postcode plus number, street, or street plus number and city. Use the locator of a result on the other endpoints.","operationId":"suggestAddresses","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":100,"title":"Q"},"description":"Postcode, postcode + number, street, or street + number[, city].","example":"Amazonenstraat 12, Amsterdam"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":10,"title":"Limit"},"description":"At most this many results."},{"name":"types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Types"},"description":"Comma list of address, street, postcode (all three by default)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"address_suggest","x-credits":0,"x-visibility":"public","x-family":"addresses","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"Free","position":"before"}]}},"/v5/addresses/reverse":{"get":{"tags":["Addresses"],"summary":"Reverse geocoding","description":"The nearest addresses to a point, nearest first, and the areas the point lies in.","operationId":"reverseGeocode","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":54.0,"minimum":50.0,"title":"Lat"},"description":"Latitude, WGS84.","example":52.34536},{"name":"lon","in":"query","required":true,"schema":{"type":"number","maximum":8.0,"minimum":3.0,"title":"Lon"},"description":"Longitude, WGS84.","example":4.86274},{"name":"radius_m","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Radius M"},"description":"Search radius in metres."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"default":5,"title":"Limit"},"description":"At most this many addresses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReverseOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"address_reverse","x-credits":1,"x-visibility":"public","x-family":"addresses","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/addresses/{locator}":{"get":{"tags":["Addresses"],"summary":"Address validation","description":"Checks an address and returns it in its standard form, with its BAG ids and the areas it lies in. `409 address_ambiguous` lists the homes at a postcode plus number when no extension is given; `all=true` returns them all instead.","operationId":"getAddress","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"all","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"All"},"description":"Return every home at the address instead of a 409 when the address is ambiguous."},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"},"description":"Comma list of the extras this endpoint offers, such as rd."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AddressOut"},{"$ref":"#/components/schemas/AddressesOut"}]}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"address","x-credits":1,"x-visibility":"public","x-family":"addresses","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/properties/{locator}":{"get":{"tags":["Properties"],"summary":"Property characteristics","description":"Up to sixty fields about the home, in groups. `fields` picks groups. The sales of the home are under Transactions.","operationId":"getProperty","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fields"},"description":"Comma list of the groups to return: type, dimensions, rooms, outdoor, construction, energy, ownership, maintenance. All of them by default."},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"},"description":"Comma list of the extras this endpoint offers, such as rd."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"property","x-credits":2,"x-visibility":"public","x-family":"properties","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/properties/{locator}/energy-label":{"get":{"tags":["Properties"],"summary":"Energy label","operationId":"getEnergyLabel","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnergyLabelOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"property_energy_label","x-credits":1,"x-visibility":"public","x-family":"properties","description":"The registered energy label with its recording and validity dates, and earlier labels. A label from a listing when none is registered.","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/properties/{locator}/woz":{"get":{"tags":["Properties"],"summary":"WOZ value and history","operationId":"getWoz","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"index","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Index"},"description":"Also give each value at today's price level (indexed_value)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WozOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"property_woz","x-credits":2,"x-visibility":"public","x-family":"properties","description":"The WOZ value per reference date since 2015, newest first. `index=true` adds each value at today's price level.","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/properties/{locator}/condition":{"get":{"tags":["Properties"],"summary":"Condition score","operationId":"getCondition","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConditionOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"property_condition","x-credits":2,"x-visibility":"public","x-family":"properties","description":"The maintenance state of the home as assessed from its listing photos: overall, modernity and finish on a scale of 1 to 5, with confidence and a short reasoning.","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/properties/{locator}/transactions":{"head":{"tags":["Properties"],"summary":"Transactions available? (free)","description":"200 when the home has transactions, 404 when it has none.","operationId":"headTransactions","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This endpoint comes with a contract; contact sales@huispedia.nl. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"transactions","x-credits":0,"x-visibility":"public","x-family":"properties","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"With contract","position":"before"}]},"get":{"tags":["Properties"],"summary":"Transactions","description":"The sales of the home with their prices, and the listings they came from. Available with a contract; contact sales@huispedia.nl. `X-Kadaster-Records` counts the Kadaster records in the answer.","operationId":"getTransactions","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This endpoint comes with a contract; contact sales@huispedia.nl. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"transactions","x-credits":2,"x-visibility":"public","x-family":"properties","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"With contract","position":"before"}]}},"/v5/buildings/{bag_pand_id}":{"get":{"tags":["Properties"],"summary":"Building and its units","operationId":"getBuilding","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"bag_pand_id","in":"path","required":true,"schema":{"type":"string","title":"Bag Pand Id"},"description":"The 16-digit BAG id of the building.","example":"0363100012138058"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"building","x-credits":1,"x-visibility":"public","x-family":"properties","description":"Every address in a BAG building: house numbers, floor, living area and whether it is a home, with the building's construction year and location.","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/properties/{locator}/valuation":{"get":{"tags":["Valuations"],"summary":"Home valuation","description":"The current Huispedia home value: value, 80% interval and confidence. `as_of_date` gives the value at an earlier month, up to six months back.","operationId":"getValuation","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"as_of_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date"},"description":"A month up to six months back; the value at that month's price level."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"valuation","x-credits":8,"x-visibility":"public","x-family":"valuations","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"8 credits","position":"before"}]}},"/v5/properties/{locator}/references":{"get":{"tags":["Valuations"],"summary":"Reference homes","description":"Comparable homes sold nearby, ranked by similarity, distance or date, within the bounds you set. Kadaster sale prices come with a contract.","operationId":"getReferences","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":3,"default":10,"title":"Limit"},"description":"Number of reference homes, 3 to 30."},{"name":"max_distance_m","in":"query","required":false,"schema":{"type":"integer","maximum":20000,"minimum":50,"default":2000,"title":"Max Distance M"},"description":"No further away than this, in metres."},{"name":"max_age_months","in":"query","required":false,"schema":{"type":"integer","maximum":120,"minimum":1,"default":24,"title":"Max Age Months"},"description":"Sold no longer ago than this many months."},{"name":"same_type","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Same Type"},"description":"Only homes of the same type (house or apartment)."},{"name":"min_living_area_m2","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Min Living Area M2"},"description":"Smallest living area, m²."},{"name":"max_living_area_m2","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Max Living Area M2"},"description":"Largest living area, m²."},{"name":"min_construction_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1000},{"type":"null"}],"title":"Min Construction Year"},"description":"Earliest construction year."},{"name":"max_construction_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100},{"type":"null"}],"title":"Max Construction Year"},"description":"Latest construction year."},{"name":"as_of_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date"},"description":"The date to look back from; today by default."},{"name":"sort","in":"query","required":false,"schema":{"type":"string","pattern":"^(similarity|distance|date)$","default":"similarity","title":"Sort"},"description":"similarity, distance or date."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferencesOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This endpoint comes with a contract; contact sales@huispedia.nl. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"references","x-credits":8,"x-visibility":"public","x-family":"valuations","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"With contract","position":"before"}]}},"/v5/properties/{locator}/valuation/plus":{"get":{"tags":["Valuations"],"summary":"Home valuation plus","description":"The valuation with the five best reference homes, the neighbourhood's market figures and the home's latest WOZ value, in one call.","operationId":"getValuationPlus","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"as_of_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date"},"description":"A month up to six months back; the value at that month's price level."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationPlusOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"This endpoint comes with a contract; contact sales@huispedia.nl. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"valuation_plus","x-credits":12,"x-visibility":"public","x-family":"valuations","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"With contract","position":"before"}]}},"/v5/properties/{locator}/valuation/history":{"get":{"tags":["Valuations"],"summary":"Valuation history","description":"One value per month with its interval, 36 months back by default. `current` carries this month's value when it is newer than the last monthly point. `include=changes` adds what changed about the home between points.","operationId":"getValuationHistory","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"},"description":"First month; 36 months back by default."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"},"description":"Last month; this month by default."},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"},"description":"Comma list of the extras this endpoint offers, such as rd."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationHistoryOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"valuation_history","x-credits":3,"x-visibility":"public","x-family":"valuations","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"3 credits","position":"before"}]}},"/v5/valuations/scenarios":{"post":{"tags":["Valuations"],"summary":"Scenario valuation","description":"Values up to 100 homes with the characteristics you give, and each named scenario against the same base. Each row and each scenario is a valuation of its own; a row that fails carries `error`.","operationId":"createScenarioValuations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenariosIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenariosOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-product":"valuation_scenarios","x-credits":20,"x-visibility":"public","x-family":"valuations","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"20 credits per scenario","position":"before"}]}},"/v5/areas/lookup":{"get":{"tags":["Areas and market"],"summary":"Area lookup","description":"The neighbourhood, district, municipality and province around a point or a postcode.","operationId":"lookupArea","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":54.0,"minimum":50.0},{"type":"null"}],"title":"Lat"},"description":"Latitude, WGS84."},{"name":"lon","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":8.0,"minimum":3.0},{"type":"null"}],"title":"Lon"},"description":"Longitude, WGS84."},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[1-9][0-9]{3}\\s?[A-Za-z]{2}$"},{"type":"null"}],"title":"Postcode"},"description":"A full postcode, such as 1076LJ.","example":"1076LJ"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaLookupOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"area_lookup","x-credits":1,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/areas/{area}":{"get":{"tags":["Areas and market"],"summary":"Area","description":"An area's name, codes, parents and centre; `include=geometry` adds its outline as GeoJSON.","operationId":"getArea","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"area","in":"path","required":true,"schema":{"type":"string","title":"Area"},"description":"level:code, such as neighbourhood:BU0363KH05, municipality:GM0363, postcode4:1076 or national.","example":"neighbourhood:BU0363KH05"},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"},"description":"Comma list of the extras this endpoint offers, such as rd."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"area","x-credits":1,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"1 credit","position":"before"}]}},"/v5/areas/{area}/stats":{"get":{"tags":["Areas and market"],"summary":"Area statistics","description":"Market, housing stock and environment figures for the area over the last twelve months. A larger area combines its neighbourhoods.","operationId":"getAreaStats","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"area","in":"path","required":true,"schema":{"type":"string","title":"Area"},"description":"level:code, such as neighbourhood:BU0363KH05, municipality:GM0363, postcode4:1076 or national.","example":"neighbourhood:BU0363KH05"},{"name":"period","in":"query","required":false,"schema":{"type":"string","pattern":"^last_12_months$","default":"last_12_months","title":"Period"},"description":"last_12_months."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaStatsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"area_stats","x-credits":3,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"3 credits","position":"before"}]}},"/v5/areas/{area}/trends":{"get":{"tags":["Areas and market"],"summary":"Price index","description":"The price per m² per month with its change against a year earlier, five years back by default. `include=parents` adds the district, municipality, province and national series for a neighbourhood.","operationId":"getAreaTrends","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"area","in":"path","required":true,"schema":{"type":"string","title":"Area"},"description":"level:code, such as neighbourhood:BU0363KH05, municipality:GM0363, postcode4:1076 or national.","example":"neighbourhood:BU0363KH05"},{"name":"metric","in":"query","required":false,"schema":{"type":"string","pattern":"^(transaction_price_per_m2|asking_price_per_m2)$","default":"transaction_price_per_m2","title":"Metric"},"description":"transaction_price_per_m2 or asking_price_per_m2."},{"name":"interval","in":"query","required":false,"schema":{"type":"string","pattern":"^month$","default":"month","title":"Interval"},"description":"month."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"},"description":"First month; five years back by default."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"},"description":"Last month; this month by default."},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"},"description":"Comma list of the extras this endpoint offers, such as rd."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaTrendsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"area_trends","x-credits":2,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/areas/{area}/demographics":{"get":{"tags":["Areas and market"],"summary":"Demographics","description":"Population, households and age groups of a neighbourhood, from CBS.","operationId":"getAreaDemographics","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"area","in":"path","required":true,"schema":{"type":"string","title":"Area"},"description":"level:code, such as neighbourhood:BU0363KH05, municipality:GM0363, postcode4:1076 or national.","example":"neighbourhood:BU0363KH05"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"area_demographics","x-credits":2,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/properties/{locator}/surroundings":{"get":{"tags":["Areas and market"],"summary":"Surroundings","description":"The nearest amenity per category (supermarket, school, GP, station and more) with its distance, and the counts in the neighbourhood.","operationId":"getSurroundings","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurroundingsOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"surroundings","x-credits":2,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"2 credits","position":"before"}]}},"/v5/properties/{locator}/environment":{"get":{"tags":["Areas and market"],"summary":"Environment","description":"Foundation risk, subsidence, noise, air quality, heat and light pollution at the address, with the source of each.","operationId":"getEnvironment","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"locator","in":"path","required":true,"schema":{"type":"string","title":"Locator"},"description":"`bag:<nummeraanduiding>` (`bag:0363200000028422`) or `<postcode>-<number>[-<extension>]` (`1076LJ-12-2`).","example":"1076LJ-12-2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentOut"}}}},"400":{"description":"The request is not right: a parameter, a locator or the body. `errors` says which.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"No key, or a key we do not know.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credits, or the spend cap for this month is reached. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"Nothing at this locator. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The locator matches more than one address; `errors` lists the candidates. Nothing is charged.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"Too many requests; wait the number of seconds in `Retry-After`.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}}},"default":{"description":"Any other error, in the same problem shape.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-product":"environment","x-credits":3,"x-visibility":"public","x-family":"areas","externalDocs":{"url":"https://huispedia.dev/en/docs/locators/","description":"Addresses and areas"},"x-badges":[{"name":"3 credits","position":"before"}]}}},"components":{"schemas":{"AccountOut":{"properties":{"account_id":{"type":"string","title":"Account Id"},"type":{"type":"string","title":"Type","description":"user, organisation or internal."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"locale":{"type":"string","title":"Locale"},"plan":{"type":"string","title":"Plan","description":"prepaid or postpaid."},"balance":{"$ref":"#/components/schemas/BalanceOut"},"spend_cap":{"$ref":"#/components/schemas/SpendCapOut"},"limits":{"$ref":"#/components/schemas/LimitsOut"},"entitlements":{"items":{"type":"string"},"type":"array","title":"Entitlements"},"terms_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terms Version"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["account_id","type","locale","plan","balance","spend_cap","limits","entitlements"],"title":"AccountOut"},"AddressBlock":{"properties":{"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id","description":"BAG nummeraanduiding id.","examples":["0363200000028422"],"x-data-point":"bag-id","x-source":"bag"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode","examples":["1076LJ"]},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number","examples":[12]},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext","examples":["2"]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","examples":["Amazonenstraat"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","examples":["Amsterdam"]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality","examples":["Amsterdam"]},"province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Province","examples":["Noord-Holland"]},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"rd":{"anyOf":[{"$ref":"#/components/schemas/RDLocation"},{"type":"null"}],"description":"Only with include=rd."},"huispedia_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Huispedia Url"}},"type":"object","title":"AddressBlock","description":"The address block every property-level response starts with."},"AddressOut":{"properties":{"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id","description":"BAG nummeraanduiding id.","examples":["0363200000028422"],"x-data-point":"bag-id","x-source":"bag"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode","examples":["1076LJ"]},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number","examples":[12]},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext","examples":["2"]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","examples":["Amazonenstraat"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","examples":["Amsterdam"]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality","examples":["Amsterdam"]},"province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Province","examples":["Noord-Holland"]},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"rd":{"anyOf":[{"$ref":"#/components/schemas/RDLocation"},{"type":"null"}],"description":"Only with include=rd."},"huispedia_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Huispedia Url"},"bag_verblijfsobject_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Verblijfsobject Id"},"bag_pand_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Pand Id"},"bag_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Status"},"is_residential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Residential"},"neighbourhood":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"district":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"municipality_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality Code"},"province_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Province Code"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","title":"AddressOut"},"AddressesOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AddressOut"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"AddressesOut"},"AgeShares":{"properties":{"share_0_15":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share 0 15"},"share_25_45":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share 25 45"},"share_65_plus":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share 65 Plus"}},"type":"object","title":"AgeShares"},"Air":{"properties":{"no2_ug_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"No2 Ug M3"},"pm25_ug_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pm25 Ug M3"},"pm10_ug_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pm10 Ug M3"}},"type":"object","title":"Air"},"AreaHierarchy":{"properties":{"neighbourhood":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"district":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"municipality":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"province":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]}},"type":"object","title":"AreaHierarchy"},"AreaLookupOut":{"properties":{"neighbourhood":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"district":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"municipality":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"province":{"anyOf":[{"$ref":"#/components/schemas/AreaRef"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","title":"AreaLookupOut"},"AreaOut":{"properties":{"type":{"type":"string","title":"Type"},"code":{"type":"string","title":"Code","description":"CBS code (BU…, WK…, GM…, PV…), the postcode, or 'NL'."},"huispedia_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Huispedia Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"parents":{"items":{"$ref":"#/components/schemas/AreaParent"},"type":"array","title":"Parents"},"centroid":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"cbs_vintage_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cbs Vintage Year"},"geometry":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Geometry","description":"GeoJSON, with include=geometry."},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["type","code"],"title":"AreaOut"},"AreaParent":{"properties":{"code":{"type":"string","title":"Code","description":"CBS code, e.g. BU0363KH05."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"type":"string","title":"Type"}},"type":"object","required":["code","type"],"title":"AreaParent"},"AreaRef":{"properties":{"code":{"type":"string","title":"Code","description":"CBS code, e.g. BU0363KH05."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["code"],"title":"AreaRef"},"AreaStatsOut":{"properties":{"area":{"$ref":"#/components/schemas/AreaRef"},"type":{"type":"string","title":"Type"},"period":{"type":"string","title":"Period","default":"last_12_months"},"market":{"$ref":"#/components/schemas/MarketStats"},"stock":{"anyOf":[{"$ref":"#/components/schemas/StockStats"},{"type":"null"}]},"environment":{"anyOf":[{"$ref":"#/components/schemas/EnvironmentStats"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["area","type","market"],"title":"AreaStatsOut"},"AreaTrendsOut":{"properties":{"area":{"$ref":"#/components/schemas/AreaRef"},"type":{"type":"string","title":"Type"},"metric":{"type":"string","title":"Metric"},"interval":{"type":"string","title":"Interval","default":"month"},"data":{"items":{"$ref":"#/components/schemas/TrendPoint"},"type":"array","title":"Data"},"parents":{"anyOf":[{"items":{"$ref":"#/components/schemas/TrendSeries"},"type":"array"},{"type":"null"}],"title":"Parents","description":"With include=parents: the district, municipality, province and national series."},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["area","type","metric","data"],"title":"AreaTrendsOut"},"BalanceOut":{"properties":{"total":{"type":"integer","title":"Total","description":"Credits available now, all buckets together."},"buckets":{"items":{"$ref":"#/components/schemas/BucketOut"},"type":"array","title":"Buckets"}},"type":"object","required":["total","buckets"],"title":"BalanceOut"},"BucketOut":{"properties":{"kind":{"type":"string","title":"Kind","description":"allowance, pack, pack_overage, wallet or free."},"remaining":{"type":"integer","title":"Remaining"},"granted":{"type":"integer","title":"Granted"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["kind","remaining","granted"],"title":"BucketOut"},"BuildingOut":{"properties":{"bag_pand_id":{"type":"string","title":"Bag Pand Id"},"construction_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year"},"bag_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Status"},"units_count":{"type":"integer","title":"Units Count"},"residential_units_count":{"type":"integer","title":"Residential Units Count"},"units":{"items":{"$ref":"#/components/schemas/BuildingUnit"},"type":"array","title":"Units"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["bag_pand_id","units_count","residential_units_count","units"],"title":"BuildingOut"},"BuildingUnit":{"properties":{"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id"},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number"},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext"},"floor_level":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floor Level"},"living_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Living Area M2"},"object_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Object Type"},"is_residential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Residential"}},"type":"object","title":"BuildingUnit"},"ConditionOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"available":{"type":"boolean","title":"Available"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"listing_photos."},"assessed_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Assessed At"},"overall":{"anyOf":[{"$ref":"#/components/schemas/Score"},{"type":"null"}]},"modernity":{"anyOf":[{"$ref":"#/components/schemas/Score"},{"type":"null"}]},"finish":{"anyOf":[{"$ref":"#/components/schemas/Score"},{"type":"null"}]},"style":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Style"},"reasoning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address","available"],"title":"ConditionOut"},"Confidence":{"properties":{"score_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score Pct","description":"Probability the value is within 10 percent of a sale price."},"class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class","description":"high (≥80), medium (≥60) or low."},"within_5_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within 5 Pct"},"within_10_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within 10 Pct"},"within_20_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within 20 Pct"}},"type":"object","title":"Confidence"},"ConstructionGroup":{"properties":{"construction_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year","x-data-point":"bouwjaar"},"roof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type"},"roof_material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Material"},"insulation":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Insulation"},"heating":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Heating"},"location_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Location Types"},"is_monument":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Monument"},"monument_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Monument Status"}},"type":"object","title":"ConstructionGroup"},"Credits":{"properties":{"charged":{"type":"integer","title":"Charged","description":"Credits debited for this call."},"balance":{"type":"integer","title":"Balance","description":"Credits remaining on the account after this call."}},"type":"object","required":["charged","balance"],"title":"Credits"},"DemographicsOut":{"properties":{"area":{"$ref":"#/components/schemas/AreaRef"},"population":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Population"},"population_density":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Population Density"},"address_density":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Address Density"},"households":{"anyOf":[{"$ref":"#/components/schemas/Households"},{"type":"null"}]},"age":{"anyOf":[{"$ref":"#/components/schemas/AgeShares"},{"type":"null"}]},"cars_per_household":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cars Per Household"},"cbs_vintage_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cbs Vintage Year"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["area"],"title":"DemographicsOut"},"DimensionsGroup":{"properties":{"living_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Living Area M2","x-data-point":"woonoppervlakte"},"plot_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Plot Area M2","x-data-point":"perceeloppervlakte"},"volume_m3":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Volume M3"},"external_storage_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"External Storage M2"},"building_bound_outdoor_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Building Bound Outdoor M2"},"other_indoor_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Other Indoor M2"},"bag_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bag Area M2","x-source":"bag"}},"type":"object","title":"DimensionsGroup"},"EnergyGroup":{"properties":{"energy_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Energy Label","x-data-point":"energielabel"},"energy_label_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Energy Label Source","description":"rvo, listing or estimated."}},"type":"object","title":"EnergyGroup"},"EnergyLabelHistoryItem":{"properties":{"label":{"type":"string","title":"Label"},"recording_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Recording Date"},"valid_to":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid To"}},"type":"object","required":["label"],"title":"EnergyLabelHistoryItem"},"EnergyLabelOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","x-data-point":"energielabel","x-source":"rvo"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"recording_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Recording Date"},"valid_to":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid To"},"registration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Registration Date"},"is_expired":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Expired"},"history":{"items":{"$ref":"#/components/schemas/EnergyLabelHistoryItem"},"type":"array","title":"History"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address"],"title":"EnergyLabelOut"},"EnvironmentOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"foundation":{"anyOf":[{"$ref":"#/components/schemas/Foundation"},{"type":"null"}]},"subsidence":{"anyOf":[{"$ref":"#/components/schemas/Subsidence"},{"type":"null"}]},"noise":{"anyOf":[{"$ref":"#/components/schemas/Noise"},{"type":"null"}]},"air":{"anyOf":[{"$ref":"#/components/schemas/Air"},{"type":"null"}]},"heat":{"anyOf":[{"$ref":"#/components/schemas/Heat"},{"type":"null"}]},"light_pollution":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Light Pollution"},"environmental_health_risk":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Environmental Health Risk"},"bee_richness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bee Richness"},"sources":{"additionalProperties":{"type":"string"},"type":"object","title":"Sources"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address"],"title":"EnvironmentOut"},"EnvironmentStats":{"properties":{"avg_noise_road_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Noise Road Lden Db"},"avg_pm25_ug_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Pm25 Ug M3"},"avg_no2_ug_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg No2 Ug M3"},"avg_urban_heat_island_c":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Urban Heat Island C"},"share_public_green":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Public Green"},"share_water":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Water"}},"type":"object","title":"EnvironmentStats"},"ErrorRow":{"properties":{"code":{"type":"string","title":"Code"},"message":{"type":"string","title":"Message"}},"type":"object","required":["code","message"],"title":"ErrorRow"},"Foundation":{"properties":{"at_risk":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"At Risk"},"subsoil":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subsoil"}},"type":"object","title":"Foundation"},"Heat":{"properties":{"urban_heat_island_c":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Urban Heat Island C"},"green_cooling_effect":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Green Cooling Effect"}},"type":"object","title":"Heat"},"HistoryPoint":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"value":{"type":"integer","title":"Value"},"lower":{"type":"integer","title":"Lower"},"upper":{"type":"integer","title":"Upper"},"neighbourhood_price_per_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Neighbourhood Price Per M2"},"changed_features":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Changed Features"}},"type":"object","required":["date","value","lower","upper"],"title":"HistoryPoint"},"Households":{"properties":{"avg_size":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Size"},"share_with_children":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share With Children"},"share_single_person":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Single Person"}},"type":"object","title":"Households"},"KadasterPrice":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"A sale price from the Kadaster, in whole euros.","x-kadaster-price":true},"Leasehold":{"properties":{"is_bought_off":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Bought Off"},"buyout_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Buyout End Date"},"yearly_canon":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yearly Canon"},"is_perpetual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Perpetual"},"period_end_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period End Year"},"landowner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landowner"},"general_conditions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"General Conditions"},"is_rate_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Rate Locked"},"has_cost_risk":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Cost Risk"},"years_until_canon_resumes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Years Until Canon Resumes"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"}},"type":"object","title":"Leasehold"},"LimitsOut":{"properties":{"requests_per_second":{"type":"number","title":"Requests Per Second"},"concurrency":{"type":"integer","title":"Concurrency"},"monitored_addresses_max":{"type":"integer","title":"Monitored Addresses Max"}},"type":"object","required":["requests_per_second","concurrency","monitored_addresses_max"],"title":"LimitsOut"},"Location":{"properties":{"lat":{"type":"number","title":"Lat","description":"Latitude, WGS84."},"lon":{"type":"number","title":"Lon","description":"Longitude, WGS84."}},"type":"object","required":["lat","lon"],"title":"Location"},"MaintenanceGroup":{"properties":{"interior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interior"},"exterior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior"}},"type":"object","title":"MaintenanceGroup"},"MarketStats":{"properties":{"for_sale_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"For Sale Count"},"transactions_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transactions Count"},"avg_transaction_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Avg Transaction Price"},"avg_transaction_price_per_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Avg Transaction Price Per M2"},"avg_asking_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Avg Asking Price"},"avg_asking_price_per_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Avg Asking Price Per M2"},"transaction_price_per_m2_yoy_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Transaction Price Per M2 Yoy Pct"},"median_days_on_market":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median Days On Market"},"median_overbid_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median Overbid Pct","x-data-point":"overbieden-per-buurt"},"share_sold_above_asking":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Sold Above Asking"},"listings_per_1000_properties":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Listings Per 1000 Properties"},"median_estimated_home_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Median Estimated Home Value"}},"type":"object","title":"MarketStats"},"Meta":{"properties":{"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id","description":"Unique id of this request; quote it to support."},"as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of","description":"The date the data in this response describes."},"credits":{"anyOf":[{"$ref":"#/components/schemas/Credits"},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for the next page of a list; absent on the last."},"withheld":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Withheld","description":"Fields withheld because a source does not permit onward delivery."}},"type":"object","title":"Meta"},"NearestPlace":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"distance_m":{"type":"number","title":"Distance M"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]}},"type":"object","required":["distance_m"],"title":"NearestPlace"},"NeighbourhoodBlock":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"median_transaction_price_per_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Median Transaction Price Per M2"},"transactions_last_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transactions Last Year"},"median_overbid_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median Overbid Pct"},"median_days_on_market":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median Days On Market"},"price_per_m2_yoy_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per M2 Yoy Pct"}},"type":"object","title":"NeighbourhoodBlock"},"Noise":{"properties":{"road_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Road Lden Db"},"road_lnight_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Road Lnight Db"},"rail_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rail Lden Db"},"rail_lnight_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rail Lnight Db"},"aviation_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Aviation Lden Db"},"industry_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Industry Lden Db"},"wind_turbines_lden_db":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wind Turbines Lden Db"}},"type":"object","title":"Noise"},"OutdoorGroup":{"properties":{"garden_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garden Area M2"},"garden_orientation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Garden Orientation"},"garden_orientation_degrees":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garden Orientation Degrees"},"garage_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Garage Type"},"garage_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage Area M2"},"parking":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parking"}},"type":"object","title":"OutdoorGroup"},"OwnershipGroup":{"properties":{"tenure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenure","description":"freehold (full ownership) or leasehold (erfpacht)."},"leasehold":{"anyOf":[{"$ref":"#/components/schemas/Leasehold"},{"type":"null"}]},"vve_monthly_contribution":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vve Monthly Contribution"},"dwellings_in_building":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dwellings In Building"}},"type":"object","title":"OwnershipGroup"},"PropertyOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"type":{"anyOf":[{"$ref":"#/components/schemas/TypeGroup"},{"type":"null"}]},"dimensions":{"anyOf":[{"$ref":"#/components/schemas/DimensionsGroup"},{"type":"null"}]},"rooms":{"anyOf":[{"$ref":"#/components/schemas/RoomsGroup"},{"type":"null"}]},"outdoor":{"anyOf":[{"$ref":"#/components/schemas/OutdoorGroup"},{"type":"null"}]},"construction":{"anyOf":[{"$ref":"#/components/schemas/ConstructionGroup"},{"type":"null"}]},"energy":{"anyOf":[{"$ref":"#/components/schemas/EnergyGroup"},{"type":"null"}]},"ownership":{"anyOf":[{"$ref":"#/components/schemas/OwnershipGroup"},{"type":"null"}]},"maintenance":{"anyOf":[{"$ref":"#/components/schemas/MaintenanceGroup"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address"],"title":"PropertyOut"},"RDLocation":{"properties":{"x":{"type":"number","title":"X","description":"RD New (EPSG:28992) x in metres."},"y":{"type":"number","title":"Y","description":"RD New (EPSG:28992) y in metres."}},"type":"object","required":["x","y"],"title":"RDLocation"},"ReferenceOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"transaction_id":{"type":"integer","title":"Transaction Id"},"distance_m":{"type":"number","title":"Distance M"},"transaction_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Transaction Date"},"source":{"type":"string","title":"Source","default":"kadaster"},"price":{"anyOf":[{"$ref":"#/components/schemas/KadasterPrice"},{"type":"integer"},{"type":"null"}],"title":"Price","description":"The sale price; for Kadaster sales only with a contract."},"price_indexed":{"anyOf":[{"$ref":"#/components/schemas/KadasterPrice"},{"type":"integer"},{"type":"null"}],"title":"Price Indexed","description":"The sale price at today's price level; for Kadaster sales only with a contract."},"living_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Living Area M2"},"house_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Type"},"construction_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year"},"days_since_transaction":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Since Transaction"}},"type":"object","required":["address","transaction_id","distance_m"],"title":"ReferenceOut"},"ReferenceTarget":{"properties":{"object_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Object Type"},"living_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Living Area M2"},"construction_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Construction Year"}},"type":"object","title":"ReferenceTarget"},"ReferencesOut":{"properties":{"target":{"$ref":"#/components/schemas/ReferenceTarget"},"data":{"items":{"$ref":"#/components/schemas/ReferenceOut"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["target","data"],"title":"ReferencesOut"},"RequestRow":{"properties":{"request_id":{"type":"string","title":"Request Id"},"at":{"type":"string","format":"date-time","title":"At"},"key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"},"key_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Kind"},"method":{"type":"string","title":"Method"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"status":{"type":"integer","title":"Status"},"credits":{"type":"integer","title":"Credits"},"duration_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration Ms"},"client_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Ip"}},"type":"object","required":["request_id","at","key_id","key_kind","method","path","status","credits","duration_ms","client_ip"],"title":"RequestRow"},"RequestsOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RequestRow"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"RequestsOut"},"ReverseItem":{"properties":{"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id","description":"BAG nummeraanduiding id.","examples":["0363200000028422"],"x-data-point":"bag-id","x-source":"bag"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode","examples":["1076LJ"]},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number","examples":[12]},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext","examples":["2"]},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","examples":["Amazonenstraat"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","examples":["Amsterdam"]},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality","examples":["Amsterdam"]},"province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Province","examples":["Noord-Holland"]},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"rd":{"anyOf":[{"$ref":"#/components/schemas/RDLocation"},{"type":"null"}],"description":"Only with include=rd."},"huispedia_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Huispedia Url"},"distance_m":{"type":"number","title":"Distance M"}},"type":"object","required":["distance_m"],"title":"ReverseItem"},"ReverseOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReverseItem"},"type":"array","title":"Data"},"areas":{"anyOf":[{"$ref":"#/components/schemas/AreaHierarchy"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"ReverseOut"},"RoomsGroup":{"properties":{"rooms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rooms"},"bedrooms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedrooms"},"bathrooms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathrooms"},"separate_toilets":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Separate Toilets"},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors"},"floor_level":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floor Level"}},"type":"object","title":"RoomsGroup"},"Scenario":{"properties":{"living_area_m2":{"anyOf":[{"type":"integer","maximum":2000.0,"minimum":10.0},{"type":"null"}],"title":"Living Area M2"},"plot_area_m2":{"anyOf":[{"type":"integer","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Plot Area M2"},"volume_m3":{"anyOf":[{"type":"integer","maximum":10000.0,"minimum":20.0},{"type":"null"}],"title":"Volume M3"},"house_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Type","description":"terraced, corner, semi_detached, detached, apartment"},"energy_label":{"anyOf":[{"type":"string","pattern":"^[A-G](\\+{1,4})?$"},{"type":"null"}],"title":"Energy Label"},"construction_year":{"anyOf":[{"type":"integer","maximum":2100.0,"minimum":1000.0},{"type":"null"}],"title":"Construction Year"},"rooms":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Rooms"},"bedrooms":{"anyOf":[{"type":"integer","maximum":30.0,"minimum":0.0},{"type":"null"}],"title":"Bedrooms"},"bathrooms":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":0.0},{"type":"null"}],"title":"Bathrooms"},"separate_toilets":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":0.0},{"type":"null"}],"title":"Separate Toilets"},"garden_area_m2":{"anyOf":[{"type":"integer","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Garden Area M2"},"garden_orientation_degrees":{"anyOf":[{"type":"integer","maximum":360.0,"minimum":0.0},{"type":"null"}],"title":"Garden Orientation Degrees"},"dwellings_in_building":{"anyOf":[{"type":"integer","maximum":1000.0,"minimum":1.0},{"type":"null"}],"title":"Dwellings In Building"},"maintenance_overall":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Overall"},"maintenance_modernity":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Modernity"},"maintenance_finish":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Finish"},"as_of_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date","description":"Current month or up to six months back; prices are reindexed."},"name":{"type":"string","maxLength":60,"minLength":1,"title":"Name","description":"Your name for the scenario; it comes back in the answer."}},"additionalProperties":false,"type":"object","required":["name"],"title":"Scenario"},"ScenarioResult":{"properties":{"name":{"type":"string","title":"Name"},"valuation":{"anyOf":[{"$ref":"#/components/schemas/ValuationBlock"},{"type":"null"}]},"confidence":{"anyOf":[{"$ref":"#/components/schemas/Confidence"},{"type":"null"}]},"delta":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Delta","description":"Scenario value minus the base value."},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorRow"},{"type":"null"}]}},"type":"object","required":["name"],"title":"ScenarioResult"},"ScenarioRow":{"properties":{"living_area_m2":{"anyOf":[{"type":"integer","maximum":2000.0,"minimum":10.0},{"type":"null"}],"title":"Living Area M2"},"plot_area_m2":{"anyOf":[{"type":"integer","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Plot Area M2"},"volume_m3":{"anyOf":[{"type":"integer","maximum":10000.0,"minimum":20.0},{"type":"null"}],"title":"Volume M3"},"house_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Type","description":"terraced, corner, semi_detached, detached, apartment"},"energy_label":{"anyOf":[{"type":"string","pattern":"^[A-G](\\+{1,4})?$"},{"type":"null"}],"title":"Energy Label"},"construction_year":{"anyOf":[{"type":"integer","maximum":2100.0,"minimum":1000.0},{"type":"null"}],"title":"Construction Year"},"rooms":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Rooms"},"bedrooms":{"anyOf":[{"type":"integer","maximum":30.0,"minimum":0.0},{"type":"null"}],"title":"Bedrooms"},"bathrooms":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":0.0},{"type":"null"}],"title":"Bathrooms"},"separate_toilets":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":0.0},{"type":"null"}],"title":"Separate Toilets"},"garden_area_m2":{"anyOf":[{"type":"integer","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Garden Area M2"},"garden_orientation_degrees":{"anyOf":[{"type":"integer","maximum":360.0,"minimum":0.0},{"type":"null"}],"title":"Garden Orientation Degrees"},"dwellings_in_building":{"anyOf":[{"type":"integer","maximum":1000.0,"minimum":1.0},{"type":"null"}],"title":"Dwellings In Building"},"maintenance_overall":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Overall"},"maintenance_modernity":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Modernity"},"maintenance_finish":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Maintenance Finish"},"as_of_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date","description":"Current month or up to six months back; prices are reindexed."},"locator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locator","description":"bag:<nummeraanduiding> or <postcode>-<number>[-<extension>].","examples":["1076LJ-12-2"]},"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode"},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number"},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext"},"scenarios":{"items":{"$ref":"#/components/schemas/Scenario"},"type":"array","maxItems":10,"title":"Scenarios","description":"Up to ten named scenarios against the same base."}},"additionalProperties":false,"type":"object","title":"ScenarioRow"},"ScenarioRowOut":{"properties":{"address":{"anyOf":[{"$ref":"#/components/schemas/AddressBlock"},{"type":"null"}]},"valuation":{"anyOf":[{"$ref":"#/components/schemas/ValuationBlock"},{"type":"null"}]},"confidence":{"anyOf":[{"$ref":"#/components/schemas/Confidence"},{"type":"null"}]},"scenarios":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScenarioResult"},"type":"array"},{"type":"null"}],"title":"Scenarios"},"error":{"anyOf":[{"$ref":"#/components/schemas/ErrorRow"},{"type":"null"}]}},"type":"object","title":"ScenarioRowOut"},"ScenariosIn":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ScenarioRow"},"type":"array","maxItems":100,"minItems":1,"title":"Data"}},"type":"object","required":["data"],"title":"ScenariosIn","examples":[{"data":[{"locator":"1076LJ-12-2","scenarios":[{"energy_label":"A","name":"Label A"},{"bedrooms":4,"name":"Extra bedroom"}]}]}]},"ScenariosOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ScenarioRowOut"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"ScenariosOut"},"Score":{"properties":{"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"1 (poor) to 5 (excellent)."},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"}},"type":"object","title":"Score"},"SpendCapOut":{"properties":{"monthly_credits":{"type":"integer","title":"Monthly Credits"},"used_this_month":{"type":"integer","title":"Used This Month","description":"Paid credits spent this month."}},"type":"object","required":["monthly_credits","used_this_month"],"title":"SpendCapOut"},"StockStats":{"properties":{"properties_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Properties Count"},"median_construction_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Median Construction Year"},"share_prewar":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Prewar"},"share_built_after_2000":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Built After 2000"},"median_living_area_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median Living Area M2"},"share_under_75_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Under 75 M2"},"share_multi_family":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Multi Family"},"share_detached":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Detached"},"share_terraced":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Terraced"},"share_energy_label_a_or_better":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Energy Label A Or Better"}},"type":"object","title":"StockStats"},"Subsidence":{"properties":{"ground_elevation_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ground Elevation Change"},"unit":{"type":"string","title":"Unit","default":"mm_per_year"},"source":{"type":"string","title":"Source","default":"skygeo"}},"type":"object","title":"Subsidence"},"SuggestItem":{"properties":{"type":{"type":"string","title":"Type","description":"address, street or postcode."},"label":{"type":"string","title":"Label"},"bag_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bag Id"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode"},"house_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"House Number"},"house_number_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Number Ext"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"municipality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipality"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"address_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Address Count"}},"type":"object","required":["type","label"],"title":"SuggestItem"},"SuggestOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SuggestItem"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"SuggestOut"},"SurroundingsOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"nearest":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/NearestPlace"},{"type":"null"}]},"type":"object","title":"Nearest"},"counts_in_neighbourhood":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"integer"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Counts In Neighbourhood"},"mobility":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Mobility","description":"Walk, bike and transit scores; not available yet."},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address","nearest"],"title":"SurroundingsOut"},"TransactionRow":{"properties":{"transaction_id":{"type":"integer","title":"Transaction Id"},"price_agreement_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Price Agreement Date"},"transaction_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Transaction Date"},"asking_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Asking Price"},"listing_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Listing Date"},"delisted_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Delisted Date"},"living_area_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Living Area M2"},"price_per_m2":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per M2"},"source":{"type":"string","title":"Source","description":"kadaster or huispedia."},"price":{"anyOf":[{"$ref":"#/components/schemas/KadasterPrice"},{"type":"integer"},{"type":"null"}],"title":"Price","description":"The sale price."},"price_indexed":{"anyOf":[{"$ref":"#/components/schemas/KadasterPrice"},{"type":"integer"},{"type":"null"}],"title":"Price Indexed","description":"The sale price at today's price level."}},"type":"object","required":["transaction_id","source"],"title":"TransactionRow"},"TransactionsOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"data":{"items":{"$ref":"#/components/schemas/TransactionRow"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address","data"],"title":"TransactionsOut"},"TrendPoint":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"value":{"type":"number","title":"Value"},"yoy_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yoy Pct"}},"type":"object","required":["date","value"],"title":"TrendPoint"},"TrendSeries":{"properties":{"type":{"type":"string","title":"Type"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"items":{"$ref":"#/components/schemas/TrendPoint"},"type":"array","title":"Data"}},"type":"object","required":["type","data"],"title":"TrendSeries"},"TypeGroup":{"properties":{"object_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Object Type","description":"house or apartment."},"house_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Type","description":"terraced, corner, semi_detached, detached, apartment or other."},"house_type_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Type Detail","description":"The Dutch house type, e.g. bovenwoning."},"house_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Kind"},"construction_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Construction Kind"},"construction_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Construction Period"}},"type":"object","title":"TypeGroup"},"UsageOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UsageRow"},"type":"array","title":"Data"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["data"],"title":"UsageOut"},"UsageRow":{"properties":{"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint","description":"Product id, when grouped by endpoint."},"key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"},"calls":{"type":"integer","title":"Calls"},"succeeded":{"type":"integer","title":"Succeeded"},"failed":{"type":"integer","title":"Failed"},"credits":{"type":"integer","title":"Credits"},"kadaster_records":{"type":"integer","title":"Kadaster Records"}},"type":"object","required":["calls","succeeded","failed","credits","kadaster_records"],"title":"UsageRow"},"ValuationBlock":{"properties":{"value":{"type":"integer","title":"Value","description":"Point estimate in euros.","x-data-point":"woningwaarde","x-source":"avm4"},"lower":{"type":"integer","title":"Lower"},"upper":{"type":"integer","title":"Upper"},"interval":{"type":"number","title":"Interval","description":"Probability that the true value lies between lower and upper.","default":0.8},"price_per_m2":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Per M2"},"as_of_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of Date"},"model":{"type":"string","title":"Model","default":"avm4"},"model_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version","description":"The month the value was last determined, as year.month."}},"type":"object","required":["value","lower","upper"],"title":"ValuationBlock"},"ValuationHistoryOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"data":{"items":{"$ref":"#/components/schemas/HistoryPoint"},"type":"array","title":"Data"},"current":{"anyOf":[{"$ref":"#/components/schemas/HistoryPoint"},{"type":"null"}],"description":"Present when the latest valuation is newer than the first of this month."},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address","data"],"title":"ValuationHistoryOut"},"ValuationOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"valuation":{"$ref":"#/components/schemas/ValuationBlock"},"confidence":{"anyOf":[{"$ref":"#/components/schemas/Confidence"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address","valuation"],"title":"ValuationOut"},"ValuationPlusOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"valuation":{"$ref":"#/components/schemas/ValuationBlock"},"confidence":{"anyOf":[{"$ref":"#/components/schemas/Confidence"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]},"references":{"items":{"$ref":"#/components/schemas/ReferenceOut"},"type":"array","title":"References"},"neighbourhood":{"anyOf":[{"$ref":"#/components/schemas/NeighbourhoodBlock"},{"type":"null"}]},"woz":{"anyOf":[{"$ref":"#/components/schemas/WozValue"},{"type":"null"}]}},"type":"object","required":["address","valuation"],"title":"ValuationPlusOut"},"WozOut":{"properties":{"address":{"$ref":"#/components/schemas/AddressBlock"},"latest":{"anyOf":[{"$ref":"#/components/schemas/WozValue"},{"type":"null"}]},"values":{"items":{"$ref":"#/components/schemas/WozValue"},"type":"array","title":"Values"},"meta":{"anyOf":[{"$ref":"#/components/schemas/Meta"},{"type":"null"}]}},"type":"object","required":["address"],"title":"WozOut"},"WozValue":{"properties":{"reference_date":{"type":"string","format":"date","title":"Reference Date"},"value":{"type":"integer","title":"Value","x-data-point":"woz-waarde","x-source":"woz"},"indexed_value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Indexed Value","description":"Only with index=true: the value at today's price level."}},"type":"object","required":["reference_date","value"],"title":"WozValue"},"Problem":{"type":"object","title":"Problem","description":"An error, as RFC 9457 problem details (`application/problem+json`). `code` is the stable error code; `type` links to its row on the errors page.","required":["type","title","status","code"],"properties":{"type":{"type":"string","format":"uri","description":"The errors page, at the row for this code."},"title":{"type":"string","description":"A short name for the error, in the language of the request."},"status":{"type":"integer","description":"The HTTP status."},"code":{"type":"string","description":"The stable error code, for example `insufficient_credits`."},"detail":{"type":["string","null"],"description":"What went wrong and what to do next, in the language of the request."},"request_id":{"type":["string","null"],"description":"Quote this when you contact us about the request."},"errors":{"type":"array","description":"For a 400: one entry per field that is not right; for a 409: the candidate addresses.","items":{"type":"object","additionalProperties":true}}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your key, hp_…"},"BearerAuth":{"type":"http","scheme":"bearer","description":"The same key, as `Authorization: Bearer hp_…`"}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-credit-price-eur":0.05,"tags":[{"name":"Valuations","x-displayName":"Valuations","description":"The Huispedia home value, its history, reference homes and scenarios with your own inputs."},{"name":"Properties","x-displayName":"Properties","description":"What is known about a home: characteristics, energy label, WOZ, condition, transactions, the building."},{"name":"Addresses","x-displayName":"Addresses","description":"Find, check and locate addresses."},{"name":"Areas and market","x-displayName":"Neighbourhoods and market","description":"Neighbourhood to national: statistics, price index, demographics, amenities and environment."},{"name":"Account","x-displayName":"Balance and usage","description":"Your balance, usage and request log; free."},{"name":"Catalogue","x-displayName":"Prices and limits","description":"The credits per endpoint, the free tier, the limits and the sources."}],"x-tagGroups":[{"name":"Endpoints","tags":["Valuations","Properties","Addresses","Areas and market"]},{"name":"Technical","tags":["Account","Catalogue"]}]}