{"openapi":"3.0.2","info":{"title":"Fragua public API","description":"API pública de Fragua.","contact":{"name":"Fragua Support","url":"https://fragua.atlas-reanalytics.com/"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"0.0.48"},"servers":[{"url":"/public"}],"paths":{"/login":{"post":{"tags":["Authentication"],"summary":"Login","operationId":"login_login_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_login_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/login":{"post":{"tags":["Authentication"],"summary":"Login V2","operationId":"login_v2_v2_login_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_v2_v2_login_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/secured-endpoint":{"post":{"tags":["Authentication"],"summary":"Secured Endpoint","operationId":"secured_endpoint_secured_endpoint_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/.well-known/jwks.json":{"get":{"tags":["Authentication"],"summary":"Public JWKS endpoint for token validation","operationId":"jwks__well_known_jwks_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/auth/mcp-token":{"post":{"tags":["Authentication"],"summary":"Mcp Token","description":"Exchange a validated Auth0 access token for a Fragua API JWT.\n\nUsed by the MCP server before forwarding tool calls to the public API.\nAuth0 Custom Database login uses existing ``POST /v2/login`` (no separate route).","operationId":"mcp_token_auth_mcp_token_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}}}}},"/valuation/":{"post":{"tags":["Valuation"],"summary":"Get Valuation","description":"Get a valuation based on the provided cadastre reference.\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_valuation__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation","description":"Get a valuation based on the provided cadastre reference or address and others property characteristics.\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `bedrooms`: The number of rooms in the property.\n- `lift`: The presence of a lift in the property.\n- `operation`: The operation to calculate the valuation.\n- `property_type`: The type of property.\n- `new_construction`: The property is new construction.\n- `status`: The status of the property.\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_valuation_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/assets/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Assets V2","description":"Get a valuation for any asset based on the provided cadastre reference or address and other property characteristics.\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `asset_class`: Logical group of the asset (e.g. residential, retail, office, industrial, other).\n- `size`: The size of the property.\n- `bedrooms`: The number of rooms in the property.\n- `lift`: The presence of a lift in the property.\n- `operation`: The operation to calculate the valuation.\n- `property_type`: The type of property.\n- `new_construction`: The property is new construction.\n- `status`: The status of the property.\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_assets_v2_valuation_assets_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/retail/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Retail V2","description":"Get a valuation for retail premises (property_type is always \"premises\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `new_construction`: The property is new construction.\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_retail_v2_valuation_retail_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/storage/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Storage V2","description":"Get a valuation for storage units (property_type is always \"storage\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `new_construction`: The property is new construction.\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_storage_v2_valuation_storage_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/office/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Office V2","description":"Get a valuation for offices (property_type is always \"premises\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_office_v2_valuation_office_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/building/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Building V2","description":"Get a valuation for buildings (property_type is always \"building\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_building_v2_valuation_building_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/industrial/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Industrial V2","description":"Get a valuation for industrial assets (property_type is always \"industrial\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_industrial_v2_valuation_industrial_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/garage/v2":{"post":{"tags":["Valuation"],"summary":"Get Valuation Garage V2","description":"Get a valuation for garages (property_type is always \"garage\").\n\n- `cadastre_reference`: The cadastre reference required to calculate the valuation.\n- `address`: The address required to calculate the valuation.\n- `size`: The size of the property.\n- `operation`: The operation to calculate the valuation (buy/rent).\n- `latitude`: The latitude of the property.\n- `longitude`: The longitude of the property.\n- `postal_code`: The postal code of the property.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_valuation_garage_v2_valuation_garage_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherAssetsValuationInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/valuation/generate_valuation_report":{"post":{"tags":["Valuation"],"summary":"Generate Valuation Report","description":"Generate a comprehensive PDF valuation report for a property.\n\nThis endpoint collects various property valuation data including:\n- Automatic valuation metrics\n- Nearby places information\n- Demographic data for the area\n- Market KPIs and comparables\n- Demand analysis data\n- Rating plots for buy/rent markets\n\nThe data is compiled into a professional PDF report which is returned as a file download.\n\nReturns:\n    FileResponse: A PDF file containing the complete valuation report.\n\n### Authorization\nRequires user authentication. The report will be customized based on the user's profile.","operationId":"generate_valuation_report_valuation_generate_valuation_report_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRequest"}}},"required":true},"responses":{"200":{"description":"Valuation report PDF file","content":{"application/json":{"schema":{}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"500":{"description":"Server error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/province":{"get":{"tags":["Cadastre data"],"summary":"Get Province","description":"Get a list of provinces based on the provided input string.\n\n- `input_string`: The string to search for in the provinces.\n\nThis endpoint finds all provinces that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_province_cadastre_province_get","parameters":[{"required":true,"schema":{"title":"Input String","type":"string"},"example":"Madrid","name":"input_string","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Province Cadastre Province Get","type":"array","items":{"$ref":"#/components/schemas/ProvinceOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/municipality":{"get":{"tags":["Cadastre data"],"summary":"Get Municipality","description":"Get a list of municipalities based on the provided input string and province id.\n\n- `input_string`: The string to search for in the municipalities.\n- `province_id`: The id of the province to search in.\n\nThis endpoint finds all municipalities in the province whit id equal to **province_id** that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_municipality_cadastre_municipality_get","parameters":[{"required":true,"schema":{"title":"Input String","type":"string"},"example":"Madrid","name":"input_string","in":"query"},{"required":true,"schema":{"title":"Province Id","type":"integer"},"example":28,"name":"province_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Municipality Cadastre Municipality Get","type":"array","items":{"$ref":"#/components/schemas/MunicipalityOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/street":{"get":{"tags":["Cadastre data"],"summary":"Get Street","description":"Get a list of streets based on the provided input string, province id and municipality id.\n\n- `input_string`: The string to search for in the streets.\n- `province_id`: The id of the province to search in.\n- `municipality_id`: The id of the municipality to search in.\n\nThis endpoint finds all streets in the municipality with id equal to **municipality_id** that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_street_cadastre_street_get","parameters":[{"required":true,"schema":{"title":"Input String","type":"string"},"example":"Embajadores","name":"input_string","in":"query"},{"required":true,"schema":{"title":"Province Id","type":"integer"},"example":28,"name":"province_id","in":"query"},{"required":true,"schema":{"title":"Municipality Id","type":"integer"},"example":79,"name":"municipality_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Street Cadastre Street Get","type":"array","items":{"$ref":"#/components/schemas/StreetOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/v2/street":{"get":{"tags":["Cadastre data"],"summary":"Get Street V2","description":"Get a list of streets based on the provided input string, province id and municipality id.\n\n- `input_string`: The string to search for in the streets.\n- `province_id`: The id of the province to search in.\n- `municipality_id`: The id of the municipality to search in.\n\nThis endpoint finds all streets in the municipality with id equal to **municipality_id** that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_street_v2_cadastre_v2_street_get","parameters":[{"required":true,"schema":{"title":"Input String","type":"string"},"example":"Embajadores","name":"input_string","in":"query"},{"required":true,"schema":{"title":"Province Id","type":"integer"},"example":28,"name":"province_id","in":"query"},{"required":true,"schema":{"title":"Municipality Id","type":"integer"},"example":79,"name":"municipality_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Street V2 Cadastre V2 Street Get","type":"array","items":{"$ref":"#/components/schemas/StreetOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/street_number":{"get":{"tags":["Cadastre data"],"summary":"Get Street Number","description":"Get a list of street numbers based on the provided street name, province id and municipality id.\n\n- `province_id`: The id of the province to search in.\n- `municipality_id`: The id of the municipality to search in.\n- `street_name`: The name of the street to search in.\n- `street_type`: The type of the street to search in.\n- `street_number`: The number of the street to search in.\n\nThis endpoint finds all street numbers in the street with name equal to **street_name**.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_street_number_cadastre_street_number_get","parameters":[{"required":true,"schema":{"title":"Province Id","type":"integer"},"example":28,"name":"province_id","in":"query"},{"required":true,"schema":{"title":"Municipality Id","type":"integer"},"example":79,"name":"municipality_id","in":"query"},{"required":true,"schema":{"title":"Street Name","type":"string"},"example":"Embajadores","name":"street_name","in":"query"},{"required":false,"schema":{"title":"Street Type","type":"string"},"example":"CL","name":"street_type","in":"query"},{"required":false,"schema":{"title":"Street Number","type":"integer"},"example":58,"name":"street_number","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Street Number Cadastre Street Number Get","type":"array","items":{"$ref":"#/components/schemas/StreetNameOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/address_info":{"get":{"tags":["Cadastre data"],"summary":"Get Address Info","description":"Get the address information based on the provided address details.\n\n- `province_id`: The id of the province to search in.\n- `municipality_id`: The id of the municipality to search in.\n- `street_type`: The type of the street to search in.\n- `street_name`: The name of the street to search in.\n- `street_number`: The number of the street to search in.\n- `block`: The block of the address.\n- `stair`: The stair of the address.\n- `floor`: The floor of the address.\n- `door`: The door of the address.\n\nThis endpoint finds the address information based on the provided details.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_address_info_cadastre_address_info_get","parameters":[{"required":true,"schema":{"title":"Province Id","type":"integer"},"example":28,"name":"province_id","in":"query"},{"required":true,"schema":{"title":"Municipality Id","type":"integer"},"example":79,"name":"municipality_id","in":"query"},{"required":true,"schema":{"title":"Street Type","type":"string"},"example":"CL","name":"street_type","in":"query"},{"required":true,"schema":{"title":"Street Name","type":"string"},"example":"Embajadores","name":"street_name","in":"query"},{"required":true,"schema":{"title":"Street Number","type":"string"},"example":"58","name":"street_number","in":"query"},{"required":false,"schema":{"title":"Block","type":"string"},"name":"block","in":"query"},{"required":false,"schema":{"title":"Stair","type":"string"},"name":"stair","in":"query"},{"required":false,"schema":{"title":"Floor","type":"string"},"name":"floor","in":"query"},{"required":false,"schema":{"title":"Door","type":"string"},"name":"door","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressInfoOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/ref_cat_info":{"get":{"tags":["Cadastre data"],"summary":"Get Ref Cat Info","description":"Get the address information based on the provided reference catastral.\n\n- `ref_cat`: The reference catastral to search for.\n\nThis endpoint finds the address information based on the provided reference catastral.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_ref_cat_info_cadastre_ref_cat_info_get","parameters":[{"required":true,"schema":{"title":"Ref Cat","type":"string"},"example":"0334804VK4703C0001OT","name":"ref_cat","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Ref Cat Info Cadastre Ref Cat Info Get","type":"array","items":{"$ref":"#/components/schemas/AddressInfoOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/ref_cat_coordinates":{"get":{"tags":["Cadastre data"],"summary":"Get Ref Cat Coordinates","description":"Get the coordinates based on the provided reference catastral.\n\n- `ref_cat`: The reference catastral to search for.\n\nThis endpoint finds the coordinates based on the provided reference catastral.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_ref_cat_coordinates_cadastre_ref_cat_coordinates_get","parameters":[{"required":true,"schema":{"title":"Ref Cat","type":"string"},"example":"0334804VK4703C0001OT","name":"ref_cat","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefCatCoordinatesOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/ref_cat_from_coordinates":{"get":{"tags":["Cadastre data"],"summary":"Get Ref Cat From Coordinates","description":"Get the reference catastral based on the provided coordinates.\n\n- `longitude`: The longitude of the coordinates.\n- `latitude`: The latitude of the coordinates.\n\nThis endpoint finds the reference catastral based on the provided coordinates.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_ref_cat_from_coordinates_cadastre_ref_cat_from_coordinates_get","parameters":[{"required":true,"schema":{"title":"Longitude","type":"number"},"example":-3.7045648625266945,"name":"longitude","in":"query"},{"required":true,"schema":{"title":"Latitude","type":"number"},"example":40.40754489730971,"name":"latitude","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefCatFromCoordinatesOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/cadastre/land_properties":{"post":{"tags":["Cadastre data"],"summary":"Get Land Properties","description":"Get the properties geometry based on the provided reference catastral.\n\n- `refcat`: The reference catastral to search for.\n\nThis endpoint finds the properties geometry based on the provided reference catastral.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_land_properties_cadastre_land_properties_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandPropertiesOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/metrics":{"get":{"tags":["Demographics data"],"summary":"Get Metrics","description":"Get demographics metrics for the provided postal code.\n\n- `postal_code`: The postal code for which to obtain the metrics.\n\nThis endpoint returns a list of demographics metrics for the provided postal code.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_metrics_demographics_metrics_get","parameters":[{"required":true,"schema":{"title":"Postal Code","type":"string"},"example":"28012","name":"postal_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Metrics Demographics Metrics Get","type":"array","items":{"$ref":"#/components/schemas/app__schemas__demographics_schemas__MetricsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/interest_places":{"get":{"tags":["Demographics data"],"summary":"Get Interest Places","description":"Get interest places for the provided postal code and geo coordinates.\n\n- `postal_code`: The postal code for which to obtain the interest places.\n- `latitude`: The latitude of the location for which to obtain the interest places.\n- `longitude`: The longitude of the location for which to obtain the interest places.\n\nThis endpoint returns a list of interest places for the provided postal code and geo coordinates.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_interest_places_demographics_interest_places_get","parameters":[{"required":true,"schema":{"title":"Postal Code","type":"string"},"example":"28012","name":"postal_code","in":"query"},{"required":true,"schema":{"title":"Latitude","type":"number"},"example":40.4165,"name":"latitude","in":"query"},{"required":true,"schema":{"title":"Longitude","type":"number"},"example":-3.7026,"name":"longitude","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Interest Places Demographics Interest Places Get","type":"array","items":{"$ref":"#/components/schemas/InteresPlacesOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/ratings":{"get":{"tags":["Demographics data"],"summary":"Get Ratings","description":"Get ratings for the provided postal code.\n\n- `postal_code`: The postal code for which to obtain the ratings.\n- `operation`: The operation for which to obtain the ratings. Either \"buy\" or \"rent\".\n- `user_colors`: The colors to use in the ratings plot.\n\nThis endpoint returns ratings for the provided postal code.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_ratings_demographics_ratings_get","parameters":[{"required":true,"schema":{"title":"Postal Code","type":"string"},"example":"28012","name":"postal_code","in":"query"},{"required":true,"schema":{"title":"Operation","enum":["buy","rent"],"type":"string"},"example":"buy","name":"operation","in":"query"},{"required":false,"schema":{"title":"User Colors","type":"string","default":"132A87,2EA3F2,23DBDB"},"name":"user_colors","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingsOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/trends/demographics_employment":{"post":{"tags":["Demographics data"],"summary":"Get Employment Trend","description":"Get employment trend data .\n\n- `aggregation`: The aggregation level for which to obtain the trend data.\n- `postal_code`: The postal code for which to obtain the ratings.\n- `historical_aggregation`: The date aggregation level. Either \"month\", \"quarter\", or \"year\".\n- `historical_range`: The range of historical data to obtain.\n- `type`: The type of data to obtain. Either \"comparison\" or \"aggregated\".\n\nThis endpoint returns employment trend for provided data.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_employment_trend_demographics_trends_demographics_employment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/trends/demographics_gdp":{"post":{"tags":["Demographics data"],"summary":"Get Gdp Trend","description":"Get gdp trend data .\n\n- `aggregation`: The aggregation level for which to obtain the trend data.\n- `postal_code`: The postal code for which to obtain the ratings.\n- `historical_aggregation`: The date aggregation level. Either \"month\", \"quarter\", or \"year\".\n- `historical_range`: The range of historical data to obtain.\n- `type`: The type of data to obtain. Either \"comparison\" or \"aggregated\".\n\nThis endpoint returns gdp trend for provided data.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_gdp_trend_demographics_trends_demographics_gdp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/trends/demographics_rent":{"post":{"tags":["Demographics data"],"summary":"Get Rent Trend","description":"Get rent trend data .\n\n- `aggregation`: The aggregation level for which to obtain the trend data.\n- `postal_code`: The postal code for which to obtain the ratings.\n- `historical_aggregation`: The date aggregation level. Either \"month\", \"quarter\", or \"year\".\n- `historical_range`: The range of historical data to obtain.\n- `type`: The type of data to obtain. Either \"comparison\" or \"aggregated\".\n\nThis endpoint returns rent trend for provided data.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_rent_trend_demographics_trends_demographics_rent_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demographics/trends/demographics_population":{"post":{"tags":["Demographics data"],"summary":"Get Population Trend","description":"Get population trend data .\n\n- `aggregation`: The aggregation level for which to obtain the trend data.\n- `postal_code`: The postal code for which to obtain the ratings.\n- `historical_aggregation`: The date aggregation level. Either \"month\", \"quarter\", or \"year\".\n- `historical_range`: The range of historical data to obtain.\n- `type`: The type of data to obtain. Either \"comparison\" or \"aggregated\".\n\nThis endpoint returns population trend for provided data.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_population_trend_demographics_trends_demographics_population_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/metrics/general":{"post":{"tags":["Market data"],"summary":"Get General Metrics","description":"Get the general metrics of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `operation`: The operation type. Defaults to \"buy\".\n - `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n - `new_construction`: The new construction type. Defaults to [0, 1].\n - `attic`: If it is an attic. Defaults to [0, 1].\n - `duplex`: If it is a duplex. Defaults to [0, 1].\n - `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n - `garage`: If it has a garage. Defaults to [0, 1].\n - `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n - `storage`: If it has a storage. Defaults to [0, 1].\n - `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n\n\nThis endpoint returns market general metrics for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_general_metrics_market_metrics_general_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsExtendInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get General Metrics Market Metrics General Post","type":"array","items":{"$ref":"#/components/schemas/app__schemas__market_schemas__MetricsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/metrics/absortion":{"post":{"tags":["Market data"],"summary":"Get Absortion Metrics","description":"Get the absorption metrics of the market.\n\n- `postal_code`: The postal code for which to obtain the absorption metrics.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n\nThis endpoint returns market absorption metrics for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_absortion_metrics_market_metrics_absortion_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbsortionMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Absortion Metrics Market Metrics Absortion Post","type":"array","items":{"$ref":"#/components/schemas/app__schemas__market_schemas__MetricsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/trends/asking_closing":{"get":{"tags":["Market data"],"summary":"Get Asking Closing Trend","description":"Get the asking closing trends of the market.\n\n- `postal_code`: The postal code for which to obtain the asking closing trends.\n\nThis endpoint returns market asking closing trends for the provided postal code.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_asking_closing_trend_market_trends_asking_closing_get","parameters":[{"required":true,"schema":{"title":"Postal Code","type":"string"},"example":"28001","name":"postal_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Asking Closing Trend Market Trends Asking Closing Get","type":"array","items":{"$ref":"#/components/schemas/AskingClosingOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/bedrooms_supply":{"post":{"tags":["Market data"],"summary":"Get Bedrooms Supply Charts","description":"Get the bedrooms supply chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market bedrooms supply chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_bedrooms_supply_charts_market_charts_bedrooms_supply_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartBedroomsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Bedrooms Supply Charts Market Charts Bedrooms Supply Post","type":"array","items":{"$ref":"#/components/schemas/ChartBedroomsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/bedrooms_price":{"post":{"tags":["Market data"],"summary":"Get Bedrooms Price Charts","description":"Get the bedrooms price chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market bedrooms price chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_bedrooms_price_charts_market_charts_bedrooms_price_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartBedroomsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Bedrooms Price Charts Market Charts Bedrooms Price Post","type":"array","items":{"$ref":"#/components/schemas/ChartBedroomsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/bedrooms_price_m2":{"post":{"tags":["Market data"],"summary":"Get Bedrooms Price M2 Charts","description":"Get the bedrooms price m2 chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market bedrooms price m2 chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_bedrooms_price_m2_charts_market_charts_bedrooms_price_m2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartBedroomsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Bedrooms Price M2 Charts Market Charts Bedrooms Price M2 Post","type":"array","items":{"$ref":"#/components/schemas/ChartBedroomsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/amenities_percent":{"post":{"tags":["Market data"],"summary":"Get Amenities Percent Charts","description":"Get the amenities percent chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n- `amenities`: The amenities to obtain the percent chart. Defaults to [\"swimming_pool\",\"storage\",\"garage\",\"lift\",\"air_conditioning\",\"terrace\"].\n\nThis endpoint returns market amenities percent chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_amenities_percent_charts_market_charts_amenities_percent_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmenitiesOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/surface_vs_price_regression":{"post":{"tags":["Market data"],"summary":"Get Surface Vs Price Regression Charts","description":"Get the surface vs price regression chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market surface vs price regression chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_surface_vs_price_regression_charts_market_charts_surface_vs_price_regression_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/price_m2_trends":{"post":{"tags":["Market data"],"summary":"Get Price M2 Trends Charts","description":"Get the price m2 trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market price m2 trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_price_m2_trends_charts_market_charts_price_m2_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/price_trends":{"post":{"tags":["Market data"],"summary":"Get Price Trends Charts","description":"Get the price trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market price trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_price_trends_charts_market_charts_price_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/supply_trends":{"post":{"tags":["Market data"],"summary":"Get Supply Trends Charts","description":"Get the supply trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market supply trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_supply_trends_charts_market_charts_supply_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/yield_trends":{"post":{"tags":["Market data"],"summary":"Get Yield Trends Charts","description":"Get the yield trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market yield trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_yield_trends_charts_market_charts_yield_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/charts/price_intervals":{"post":{"tags":["Market data"],"summary":"Get Price Intervals Charts","description":"Get the price intervals chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market price intervals chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_price_intervals_charts_market_charts_price_intervals_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/metrics/general":{"post":{"tags":["Market data"],"summary":"Get Retail General Metrics","description":"Get the retail general metrics of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `operation`: The operation type. Defaults to \"buy\".\n - `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n - `new_construction`: The new construction type. Defaults to [0, 1].\n - `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market retail general metrics for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_retail_general_metrics_market_retail_metrics_general_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsRetailInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Retail General Metrics Market Retail Metrics General Post","type":"array","items":{"$ref":"#/components/schemas/app__schemas__market_schemas__MetricsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/price_intervals":{"post":{"tags":["Market data"],"summary":"Get Retail Price Intervals Charts","description":"Get the retail price intervals chart of the market.\n\n- `postal_code`: The postal code for which to obtain the general metrics.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n- `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\nThis endpoint returns market retail price intervals chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_price_intervals_charts_market_retail_charts_price_intervals_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsRetailInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/price_m2_trends":{"post":{"tags":["Market data"],"summary":"Get Retail Price M2 Trends Charts","description":"Get the retail price m2 trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market retail price m2 trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_price_m2_trends_charts_market_retail_charts_price_m2_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInputRetail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/price_trends":{"post":{"tags":["Market data"],"summary":"Get Retail Price Trends Charts","description":"Get the retail price trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market retail price trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_price_trends_charts_market_retail_charts_price_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInputRetail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/supply_trends":{"post":{"tags":["Market data"],"summary":"Get Retail Supply Trends Charts","description":"Get the retail supply trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market retail supply trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_supply_trends_charts_market_retail_charts_supply_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInputRetail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/yield_trends":{"post":{"tags":["Market data"],"summary":"Get Retail Yield Trends Charts","description":"Get the retail yield trends chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market retail yield trends chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_yield_trends_charts_market_retail_charts_yield_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInputRetail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/retail/charts/surface_vs_price_regression":{"post":{"tags":["Market data"],"summary":"Get Retail Surface Vs Price Regression Charts","description":"Get the retail surface vs price regression chart of the market.\n\n- `postal_code`: The postal code for which to obtain the bedrooms supply chart.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction type. Defaults to [0, 1].\n- `attic`: If it is an attic. Defaults to [0, 1].\n- `duplex`: If it is a duplex. Defaults to [0, 1].\n- `ground_floor`: If it is a ground floor. Defaults to [0, 1].\n- `garage`: If it has a garage. Defaults to [0, 1].\n- `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].\n- `storage`: If it has a storage. Defaults to [0, 1].\n- `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n- `area`: The area of the property. Defaults to [0, 500].\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n\nThis endpoint returns market retail surface vs price regression chart for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_retail_surface_vs_price_regression_charts_market_retail_charts_surface_vs_price_regression_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartGeneralMetricsInputRetail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/metrics/general":{"post":{"tags":["Market data"],"summary":"Get Flex General Metrics","description":"Get the flex general metrics of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market flex general metrics for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_general_metrics_market_flex_metrics_general_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Flex General Metrics Market Flex Metrics General Post","type":"array","items":{"$ref":"#/components/schemas/app__schemas__market_schemas__MetricsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/charts/price_m2_trends":{"post":{"tags":["Market data"],"summary":"Get Flex Price M2 Trends Charts","description":"Get the flex price m2 trends chart of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market price m2 trends chart for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_price_m2_trends_charts_market_flex_charts_price_m2_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/charts/yield_trends":{"post":{"tags":["Market data"],"summary":"Get Flex Yield Trends Charts","description":"Get the flex yield trends chart of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market yield trends chart for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_yield_trends_charts_market_flex_charts_yield_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/charts/price_by_stay_duration":{"post":{"tags":["Market data"],"summary":"Get Flex Price By Stay Duration Charts","description":"Get the flex price by stay duration chart of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market flex price by stay duration chart for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_price_by_stay_duration_charts_market_flex_charts_price_by_stay_duration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/charts/bedrooms_supply":{"post":{"tags":["Market data"],"summary":"Get Flex Bedrooms Supply Charts","description":"Get the flex bedrooms supply chart of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n\n\nThis endpoint returns market flex bedrooms supply chart for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_bedrooms_supply_charts_market_flex_charts_bedrooms_supply_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralMetricsFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/flex/charts/amenities_percent":{"post":{"tags":["Market data"],"summary":"Get Flex Amenities Percent Charts","description":"Get the flex amenities percent chart of the market.\n\n - `postal_code`: The postal code for which to obtain the general metrics.\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4+\"].\n - `area`: The area of the property. Defaults to [0, 500].\n - `aggregation`: The aggregation type. Defaults to \"postal_code\".\n - `coordinates`: The coordinates of the polygon to obtain the general metrics.\n - `amenities`: The amenities to obtain the percent chart.\n\nThis endpoint returns market flex amenities percent chart for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_flex_amenities_percent_charts_market_flex_charts_amenities_percent_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmenityFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/metrics/beds_summary":{"post":{"tags":["Market data"],"summary":"Get Pbsa Beds Summary Table","description":"Get the pbsa beds summary table.\n\n - `postal_code`: The postal code for which to obtain beds summary metrics.\n - `coordinates`: The coordinates of the polygon to obtain  beds summary metrics.\n - `pbsa_type`: The pbsa type to obtain beds summary metrics. \n\nThis endpoint returns market pbsa beds summary table for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_beds_summary_table_market_pbsa_metrics_beds_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Pbsa Beds Summary Table Market Pbsa Metrics Beds Summary Post","type":"array","items":{"$ref":"#/components/schemas/PbsaBedsSummaryOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/metrics/residences_table":{"post":{"tags":["Market data"],"summary":"Get Pbsa Residences Table","description":"Get the pbsa beds residences table.\n\n - `postal_code`: The postal code for which to obtain residences metrics.\n - `coordinates`: The coordinates of the polygon to obtain  residences metrics.\n - `pbsa_type`: The pbsa type to obtain residences metrics. \n\nThis endpoint returns market pbsa residences table for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_residences_table_market_pbsa_metrics_residences_table_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Pbsa Residences Table Market Pbsa Metrics Residences Table Post","type":"array","items":{"$ref":"#/components/schemas/PbsaResidencesOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/metrics/provision_rate":{"post":{"tags":["Market data"],"summary":"Get Pbsa Residences Table","description":"Get the pbsa provision rate overview.\n\n - `postal_code`: The postal code for which to obtain residences metrics.\n - `coordinates`: The coordinates of the polygon to obtain  residences metrics.\n - `pbsa_type`: The pbsa type to obtain residences metrics. \n\nThis endpoint returns market pbsa  provision rate overview for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_residences_table_market_pbsa_metrics_provision_rate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Pbsa Residences Table Market Pbsa Metrics Provision Rate Post","type":"array","items":{"$ref":"#/components/schemas/PbsaProvisionRateOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/metrics/bedrooms_metrics":{"post":{"tags":["Market data"],"summary":"Get Pbsa Bedrooms Metrics","description":"Get the bedrooms summary metrics.\n\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n- `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6\", \"7+\"].\n- `coordinates`: The coordinates of the polygon to obtain rooms residences metrics.\n- `postal_code`: The postal code for which to obtain rooms residences metrics.\n- `price_m2_range`: The price_m2 of the property.\n\nThis endpoint returns bedrooms pbsa residences metrics for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_bedrooms_metrics_market_pbsa_metrics_bedrooms_metrics_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaBedroomsMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaBedroomsMetricsOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/charts/bedrooms_price_trends":{"post":{"tags":["Market data"],"summary":"Get Pbsa Bedrooms Price Trend","description":"Get the price trends chart of the market.\n\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n- `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6\", \"7+\"].\n- `coordinates`: The coordinates of the polygon to obtain rooms residences trends.\n- `historical_aggregation`: The historical aggregation type. Defaults to \"month\".\n- `historical_range`: The historical range.\n- `postal_code`: The postal code for which to obtain rooms residences trends.\n- `price_m2_range`: The price_m2 of the property.\n- `property_type`: The property type. Defaults to [\"room\"].\n- `type`: Aggregated or Comparison type. Defaults to \"aggregated\".\n\nThis endpoint returns bedrooms pbsa residences price trend for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_bedrooms_price_trend_market_pbsa_charts_bedrooms_price_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaBedroomsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market/pbsa/charts/bedrooms_supply_trends":{"post":{"tags":["Market data"],"summary":"Get Pbsa Bedrooms Supply Trend","description":"Get the supply trends chart of the market.\n\n- `aggregation`: The aggregation type. Defaults to \"postal_code\".\n- `bedrooms`: The number of bedrooms. Defaults to [\"0\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6\", \"7+\"].\n- `coordinates`: The coordinates of the polygon to obtain rooms residences trends.\n- `historical_aggregation`: The historical aggregation type. Defaults to \"month\".\n- `historical_range`: The historical range.\n- `postal_code`: The postal code for which to obtain rooms residences trends.\n- `price_m2_range`: The price_m2 of the property.\n- `property_type`: The property type. Defaults to [\"room\"].\n- `type`: Aggregated or Comparison type. Defaults to \"aggregated\".\n\nThis endpoint returns bedrooms pbsa residences supply trend for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_bedrooms_supply_trend_market_pbsa_charts_bedrooms_supply_trends_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaBedroomsTrendsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demand/summary":{"post":{"tags":["Demand data"],"summary":"Get Summary","description":"Get demand summary for the provided inputs.\n\n- `postal_code`: The postal code for which to obtain the demand summary.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `period`: The period for which to obtain the demand summary.\n\nThis endpoint returns a demand summary for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_summary_demand_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demand/pbsa/summary":{"post":{"tags":["Demand data"],"summary":"Get Pbsa Summary","description":"Get pbsa demand summary for the provided inputs.\n\n - `postal_code`: The postal code for which to obtain residences metrics.\n - `coordinates`: The coordinates of the polygon to obtain  residences metrics.\n\nThis endpoint returns pbsa demand summary for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_summary_demand_pbsa_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demand/pbsa/origin":{"post":{"tags":["Demand data"],"summary":"Get Pbsa Origin","description":"Get pbsa demand studens origin for the provided inputs.\n\n - `postal_code`: The postal code for which to obtain residences metrics.\n - `coordinates`: The coordinates of the polygon to obtain  residences metrics.\n\nThis endpoint returns pbsa demand studens origin for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_origin_demand_pbsa_origin_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/demand/pbsa/campus_info":{"post":{"tags":["Demand data"],"summary":"Get Pbsa Campus Info","description":"Get pbsa demand campus info for the provided inputs.\n\n - `postal_code`: The postal code for which to obtain residences metrics.\n - `coordinates`: The coordinates of the polygon to obtain  residences metrics.\n\nThis endpoint returns pbsa demand campus info for the provided inputs.\n\n ### Authorization\n Ensure that the current user is authorized to access this endpoint.","operationId":"get_pbsa_campus_info_demand_pbsa_campus_info_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PbsaInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: The number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: The number of bathrooms for which to obtain the comparable data.\n- `features`: The features for which to obtain the comparable data.\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Data Comparable Data Post","type":"array","items":{"$ref":"#/components/schemas/PublicApiComparableOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get register closings data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the register closings data.\n- `date_range`: The date range for which to obtain the register closings data.\n- `price_range`: The price range for which to obtain the register closings data.\n- `size_range`: The surface range for which to obtain the register closings data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `type`: The type of asset class to obtain. Defaults to \"residential\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns register closings data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint","operationId":"get_data_comparable_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Data Comparable Register Closings Data Post","type":"array","items":{"$ref":"#/components/schemas/PublicApiRegisterClosingsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/retail/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns retail comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_retail_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/retail/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get retail register closings data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `postal_code`: The postal code for which to obtain the comparable data.\n- `price_m2_range`: The price m2 range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `limit`: The limit for the number of records to return. Defaults to 10.\n- `offset`: The offset for the number of records to return. Defaults to 0.\n- `coordinates`: The coordinates for which to obtain the comparable data if aggregation is \"polygon\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns retail register closings data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_retail_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/flex/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","operationId":"get_data_comparable_flex_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicFlexInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/storage/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get storage comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns storage comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_storage_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/storage/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `postal_code`: The postal code for which to obtain the comparable data.\n- `price_m2_range`: The price m2 range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `limit`: The limit for the number of records to return. Defaults to 10.\n- `offset`: The offset for the number of records to return. Defaults to 0.\n- `coordinates`: The coordinates for which to obtain the comparable data if aggregation is \"polygon\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns storage comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_storage_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/industrial/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get industrial comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns industrial comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_industrial_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/industrial/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get industrial comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `postal_code`: The postal code for which to obtain the comparable data.\n- `price_m2_range`: The price m2 range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `limit`: The limit for the number of records to return. Defaults to 10.\n- `offset`: The offset for the number of records to return. Defaults to 0.\n- `coordinates`: The coordinates for which to obtain the comparable data if aggregation is \"polygon\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns industrial comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_industrial_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/garage/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get garage comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns garage comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_garage_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/garage/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get garage comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `postal_code`: The postal code for which to obtain the comparable data.\n- `price_m2_range`: The price m2 range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `limit`: The limit for the number of records to return. Defaults to 10.\n- `offset`: The offset for the number of records to return. Defaults to 0.\n- `coordinates`: The coordinates for which to obtain the comparable data if aggregation is \"polygon\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns garage comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_garage_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/building/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get building comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns building comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_building_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/office/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get office comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns office comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_office_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/landplot/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get landplot comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n\nThis endpoint returns landplot comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_landplot_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/assets/data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `asset_class`: The asset class for which to obtain the comparable data. Defaults to \"residentials\". Can be \"garages\", \"storages\", \"buildings\", \"offices\", \"retail\", \"industrial\", \"landplots\" or \"residentials\".\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: Optional; The property type. Defaults to None.\n- `new_construction`: The new construction filter. Defaults to None.\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: Optional; the number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: Optional; The number of bathrooms for which to obtain the comparable data.\n- `features`: Optional; The features for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: Optional; The list of IDs for which to obtain the comparable data.\n- `illegally_occupied`: Optional; The illegally occupied filter.\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_assets_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/assets/register_closings_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get register closings data for the provided inputs.\n\n- `asset_class`: The asset class for which to obtain the comparable data. Defaults to \"residentials\". Can be \"garages\", \"storages\", \"retail\", \"industrial\" or \"residentials\".\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns comparable register closings for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_assets_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiComparableRegisterClosingsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetsRegisterClosingsOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/assets/historical_data":{"post":{"tags":["Comparable data"],"summary":"Get Assets Historical","description":"Get historical comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: The number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: The number of bathrooms for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: The list of IDs for which to obtain the comparable data.\n\nThis endpoint returns historical comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_assets_historical_comparable_assets_historical_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiHistoricalComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/built_to_rent/data":{"post":{"tags":["Comparable data"],"summary":"Get Built To Rent","description":"Get Built-to-Rent asset data for the provided postal codes.\n\n- `postal_codes`: List of postal codes to query.\n- `status`: Filter by asset status (accepted but not used by the upstream endpoint).\n- `sub_asset_class`: Filter by sub-asset class. Allowed values: \"BTR\", \"PRS\", \"Protected BTR (VPO)\", \"Affordable Housing BTR\".\n\nReturns assets split into `operating` and `pipeline` categories.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_built_to_rent_comparable_built_to_rent_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuiltToRentAssetsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuiltToRentAssetsOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/senior_living/data":{"post":{"tags":["Comparable data"],"summary":"Get Senior Living","description":"Get Senior Living asset data for the provided postal codes.\n\n- `postal_codes`: List of postal codes to query.\n- `ownership`: Filter by ownership type (e.g. \"private\", \"public\").\n- `operator`: Filter by operator type (e.g. \"main_operator\", \"granular_operators\").\n- `sub_asset_class`: Filter by sub-asset class. Allowed values: \"care_home\", \"independent\", \"mixed\", \"mental_health\".\n- `status`: Filter by asset status (accepted but not used by the upstream endpoint).\n- `province`: Province filter (not used by this upstream endpoint).\n\nReturns assets split into `operating` and `pipeline` categories.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_senior_living_comparable_senior_living_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeniorLivingAssetsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeniorLivingAssetsOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/institutional_flex_living/data":{"post":{"tags":["Comparable data"],"summary":"Get Institutional Flex Living","description":"Get Institutional Flex Living asset data for the provided filters.\n\n- `aggregation`: Spatial aggregation mode. Allowed values: \"polygon\", \"postal_code\", \"municipality\", \"province\", \"ccaa\".\n- `postal_code`: List of postal codes to filter by. Pass an empty list to skip this filter.\n- `coordinates`: List of polygon areas (list of coordinate objects with lat/lng). Only used when aggregation is \"polygon\".\n- `sub_asset_class`: Filter by sub-asset class. Allowed values: \"serviced_apartments\", \"coliving\", \"flex_living\", \"short_stays\".\n- `status`: Filter by unit status. Known values: \"operating\", \"pipeline\".\n- `flat_units`: Min/max range for the units field, e.g. [0, 500].\n\nReturns assets split into `operating_units` and `pipeline_units` categories.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_institutional_flex_living_comparable_institutional_flex_living_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionalFlexLivingInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionalFlexLivingOutput"}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/zones/provinces":{"get":{"tags":["Comparable data"],"summary":"Get Data","description":"Get idealista provinces.\n\n- `input_string`: The string to search for in the provinces. \n\nThis endpoint finds all provinces that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_zones_provinces_get","parameters":[{"required":false,"schema":{"title":"Input String","type":"string","default":""},"example":"Madrid","name":"input_string","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"example":10,"name":"limit","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"example":0,"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/zones/municipalities":{"get":{"tags":["Comparable data"],"summary":"Get Data","description":"Get idealista municipalities.\n\n- `input_string`: The string to search for in the municipalities. \n\nThis endpoint finds all municipalities that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_zones_municipalities_get","parameters":[{"required":false,"schema":{"title":"Input String","type":"string","default":""},"example":"Madrid","name":"input_string","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"example":10,"name":"limit","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"example":0,"name":"offset","in":"query"},{"required":false,"schema":{"title":"Province","type":"string"},"example":"Madrid","name":"province","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/zones/districts":{"get":{"tags":["Comparable data"],"summary":"Get Data","description":"Get idealista municipalities.\n\n- `input_string`: The string to search for in the districts. \n\nThis endpoint finds all districts that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_zones_districts_get","parameters":[{"required":false,"schema":{"title":"Input String","type":"string","default":""},"example":"Madrid","name":"input_string","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"example":10,"name":"limit","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"example":0,"name":"offset","in":"query"},{"required":false,"schema":{"title":"Province","type":"string"},"example":"Madrid","name":"province","in":"query"},{"required":false,"schema":{"title":"Municipality","type":"string"},"example":"Madrid","name":"municipality","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/zones/neighbourhoods":{"get":{"tags":["Comparable data"],"summary":"Get Data","description":"Get idealista municipalities.\n\n- `input_string`: The string to search for in the neighbourhoods. \n\nThis endpoint finds all neighbourhoods that contain **input_string** as a substring.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_zones_neighbourhoods_get","parameters":[{"required":false,"schema":{"title":"Input String","type":"string","default":""},"example":"Sol, Madrid","name":"input_string","in":"query"},{"required":false,"schema":{"title":"Limit","type":"integer","default":10},"example":10,"name":"limit","in":"query"},{"required":false,"schema":{"title":"Offset","type":"integer","default":0},"example":0,"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/comparable/idealista/estimated_price_data":{"post":{"tags":["Comparable data"],"summary":"Get Data","description":"Get idealista data with estimated rent price.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_comparable_idealista_estimated_price_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicEstimatedPriceInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/v2/comparable/data":{"post":{"tags":["Comparable V2 data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: The number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: The number of bathrooms for which to obtain the comparable data.\n- `features`: The features for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: The list of IDs for which to obtain the comparable data.\n- `illegally_occupied`: The illegally occupied filter.\n\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_v2_comparable_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiComparableInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Data V2 Comparable Data Post","type":"array","items":{"$ref":"#/components/schemas/PublicApiComparableOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/v2/comparable/register_closings_data":{"post":{"tags":["Comparable V2 data"],"summary":"Get Data","description":"Get register closings data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `postal_code`: The postal code for which to obtain the comparable data.\n- `price_m2_range`: The price m2 range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `limit`: The limit for the number of records to return. Defaults to 10.\n- `offset`: The offset for the number of records to return. Defaults to 0.\n- `coordinates`: The coordinates for which to obtain the comparable data if aggregation is \"polygon\".\n- `sort`: Optional. Sort results by field (`sort_by`: \"date\", \"price\", \"price_m2\", \"size\", \"date_formatted\") and direction (`sort_order`: \"asc\" or \"desc\").\n\nThis endpoint returns register closings data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint","operationId":"get_data_v2_comparable_register_closings_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiRegisterClosingsInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Data V2 Comparable Register Closings Data Post","type":"array","items":{"$ref":"#/components/schemas/PublicApiRegisterClosingsOutput"}}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/v3/comparable/data":{"post":{"tags":["Comparable V3 data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: The number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: The number of bathrooms for which to obtain the comparable data.\n- `features`: The features for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: The list of IDs for which to obtain the comparable data.\n- `illegally_occupied`: The illegally occupied filter.\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_v3_comparable_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiComparableInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/v3/comparable/fotocasa_data":{"post":{"tags":["Comparable V3 data"],"summary":"Get Data","description":"Get comparable fotcasa data for the provided inputs.\n\n- `asset_class`: The asset class for which to obtain the comparable data. Defaults to \"residentials\". Can be \"garages\", \"storages\", \"buildings\", \"offices\", \"retail\", \"industrial\", \"landplots\" or \"residentials\".\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: Optional; The property type. Defaults to None.\n- `new_construction`: The new construction filter. Defaults to None.\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: Optional; the number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: Optional; The number of bathrooms for which to obtain the comparable data.\n- `features`: Optional; The features for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: Optional; The list of IDs for which to obtain the comparable data.\n- `illegally_occupied`: Optional; The illegally occupied filter.\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_v3_comparable_fotocasa_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiAssetsComparableInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/v3/comparable/portals_data":{"post":{"tags":["Comparable V3 data"],"summary":"Get Data","description":"Get comparable data for the provided inputs.\n\n- `aggregation`: The aggregation level for the data. Defaults to \"postal_code\".\n- `input`: The input data for which to obtain the comparable data.\n- `operation`: The operation type. Defaults to \"buy\".\n- `property_type`: The property type. Defaults to [\"flat\", \"house\"].\n- `new_construction`: The new construction filter. Defaults to [0, 1].\n- `date_range`: The date range for which to obtain the comparable data.\n- `price_range`: The price range for which to obtain the comparable data.\n- `size_range`: The surface range for which to obtain the comparable data.\n- `geo_point_radius`: The radius for the geo point aggregation. Defaults to 500.\n- `bedrooms`: The number of bedrooms for which to obtain the comparable data.\n- `bathrooms`: The number of bathrooms for which to obtain the comparable data.\n- `features`: The features for which to obtain the comparable data.\n- `limit`: The limit for the number of results. Defaults to 10.\n- `offset`: The offset for the results. Defaults to 0.\n- `list_ids`: The list of IDs for which to obtain the comparable data.\n\nThis endpoint returns comparable data for the provided inputs.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_data_v3_comparable_portals_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiComparableInputV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/open_data/trends/demographics":{"get":{"tags":["Open municipality data"],"summary":"Get Demographics Trends","operationId":"get_demographics_trends_open_data_trends_demographics_get","parameters":[{"required":false,"schema":{"title":"Metric","enum":["unemployment"],"type":"string","default":"unemployment"},"name":"metric","in":"query"},{"required":false,"schema":{"title":"Municipality","enum":["Madrid","Barcelona","Valencia","Sevilla","Bilbao"],"type":"string","default":"Madrid"},"name":"municipality","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrendTextOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/open_data/trends/market":{"get":{"tags":["Open municipality data"],"summary":"Get Market Trends","operationId":"get_market_trends_open_data_trends_market_get","parameters":[{"required":false,"schema":{"title":"Metric","enum":["price","yield","stock_ratio"],"type":"string","default":"yield"},"name":"metric","in":"query"},{"required":false,"schema":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"name":"operation","in":"query"},{"required":false,"schema":{"title":"Municipality","enum":["Madrid","Barcelona","Valencia","Sevilla","Bilbao"],"type":"string","default":"Madrid"},"name":"municipality","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrendTextOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/open_data/static/market":{"get":{"tags":["Open municipality data"],"summary":"Get Market Static","operationId":"get_market_static_open_data_static_market_get","parameters":[{"required":false,"schema":{"title":"Metric","enum":["bedrooms"],"type":"string","default":"bedrooms"},"name":"metric","in":"query"},{"required":false,"schema":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"name":"operation","in":"query"},{"required":false,"schema":{"title":"Municipality","enum":["Madrid","Barcelona","Valencia","Sevilla","Bilbao"],"type":"string","default":"Madrid"},"name":"municipality","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BedroomsSupplyTextOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/open_data/trends/demand":{"get":{"tags":["Open municipality data"],"summary":"Get Demand Trends","operationId":"get_demand_trends_open_data_trends_demand_get","parameters":[{"required":false,"schema":{"title":"Metric","enum":["time"],"type":"string","default":"time"},"name":"metric","in":"query"},{"required":false,"schema":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"name":"operation","in":"query"},{"required":false,"schema":{"title":"Municipality","enum":["Madrid","Barcelona","Valencia","Sevilla","Bilbao"],"type":"string","default":"Madrid"},"name":"municipality","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrendTextOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/newsroom/data":{"post":{"tags":["Newsroom"],"summary":"Get Data","operationId":"get_data_newsroom_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__newsroom_schemas__DataOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/user/profile":{"get":{"tags":["User"],"summary":"Get Profile","operationId":"get_profile_user_profile_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/user/portfolio":{"get":{"tags":["User"],"summary":"Get Data","operationId":"get_data_user_portfolio_get","parameters":[{"required":false,"schema":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Offset","minimum":0.0,"type":"integer","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__user_schemas__DataOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"put":{"tags":["User"],"summary":"Update Portfolio","operationId":"update_portfolio_user_portfolio_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"post":{"tags":["User"],"summary":"Post Data","operationId":"post_data_user_portfolio_post","requestBody":{"content":{"application/json":{"schema":{"title":"Post","type":"array","items":{"$ref":"#/components/schemas/Portfolio"}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__user_schemas__DataOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["User"],"summary":"Delete Portfolio","operationId":"delete_portfolio_user_portfolio_delete","parameters":[{"required":true,"schema":{"title":"Id","type":"integer"},"name":"id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/user/api_calls":{"get":{"tags":["User"],"summary":"Get Api Calls","operationId":"get_api_calls_user_api_calls_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserApiCallsResponse"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/user/create_limited_user":{"post":{"tags":["User"],"summary":"Create Limited User","operationId":"create_limited_user_user_create_limited_user_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/user/get-by-email":{"get":{"tags":["User"],"summary":"Get User By Email Endpoint","description":"Get user information by email address.\n\n- `email`: The email address to search for\n\nThis endpoint fetches user information from the user data API based on the provided email.\n\n### Authorization\nEnsure that the current user is authorized to access this endpoint.","operationId":"get_user_by_email_endpoint_user_get_by_email_get","parameters":[{"required":true,"schema":{"title":"Email","type":"string"},"example":"user@example.com","name":"email","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market_place/province_list":{"get":{"tags":["Market Place data"],"summary":"Get Province List","operationId":"get_province_list_market_place_province_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceListResponse"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market_place/province_market":{"post":{"tags":["Market Place data"],"summary":"Get Province Market Metrics","operationId":"get_province_market_metrics_market_place_province_market_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketDatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market_place/province_demand":{"post":{"tags":["Market Place data"],"summary":"Get Province Demand Metrics","operationId":"get_province_demand_metrics_market_place_province_demand_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemandDatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market_place/province_demographics":{"post":{"tags":["Market Place data"],"summary":"Get Province Demographics Metrics","operationId":"get_province_demographics_metrics_market_place_province_demographics_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceMetricsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DemographicsDatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/market_place/province_comparables":{"post":{"tags":["Market Place data"],"summary":"Get Province Comparables","operationId":"get_province_comparables_market_place_province_comparables_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvinceComparableInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComparablesDatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/fragua-ai/new-chat":{"get":{"tags":["Fragua AI"],"summary":"New Chat","description":"Create a new chat.\n\nThis endpoint creates a new chat and returns the chat ID.","operationId":"new_chat_fragua_ai_new_chat_get","parameters":[{"required":false,"schema":{"title":"Country","type":"string","default":"es"},"name":"country","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response New Chat Fragua Ai New Chat Get","anyOf":[{"$ref":"#/components/schemas/ChatResponse"},{"$ref":"#/components/schemas/ChatResponseUsa"}]}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Chat error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/fragua-ai/new-message":{"post":{"tags":["Fragua AI"],"summary":"New Message","description":"Create a new message.\n\nThis endpoint creates a new message and returns the response message from the chatbot. The response message is always a data message with the response data based on the user's input.","operationId":"new_message_fragua_ai_new_message_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewChatMessage"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response New Message Fragua Ai New Message Post","anyOf":[{"$ref":"#/components/schemas/NewMessageResponse"},{"$ref":"#/components/schemas/NewMessageResponseUsa"},{}]}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Chat error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/fragua-ai/chat-history":{"post":{"tags":["Fragua AI"],"summary":"Chat History","description":"Get chat history.\n\nThis endpoint returns the chat history for the current user. It only returns the first message of each chat. To get all the messages from an specific chat, use the get-chat endpoint.","operationId":"chat_history_fragua_ai_chat_history_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pagination"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Chat History Fragua Ai Chat History Post","anyOf":[{"$ref":"#/components/schemas/ChatHistoryResponse"},{"$ref":"#/components/schemas/ChatHistoryResponseUsa"}]}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Chat error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/fragua-ai/get-chat":{"get":{"tags":["Fragua AI"],"summary":"Get Chat","description":"Get chat.\n\nThis endpoint returns all the messages for a specific chat.","operationId":"get_chat_fragua_ai_get_chat_get","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string"},"name":"chat_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Chat Fragua Ai Get Chat Get","anyOf":[{"$ref":"#/components/schemas/ChatResponse"},{"$ref":"#/components/schemas/ChatResponseUsa"}]}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Chat error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/fragua-ai/delete-chat":{"delete":{"tags":["Fragua AI"],"summary":"Delete Chat","description":"Delete chat.\n\nThis endpoint deletes a chat.","operationId":"delete_chat_fragua_ai_delete_chat_delete","parameters":[{"required":true,"schema":{"title":"Chat Id","type":"string"},"name":"chat_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found","content":{"application/json":{"example":{"detail":"No data found"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"detail":"You have exceeded the maximum number of API calls"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Chat error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/skill/update":{"get":{"tags":["Skill Updates"],"summary":"Get Skill Updates","operationId":"get_skill_updates_skill_update_get","parameters":[{"required":true,"schema":{"title":"From Version","minLength":1,"type":"string"},"name":"from_version","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AbsortionMetricsInput":{"title":"AbsortionMetricsInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]}},"example":{"postal_code":["28001"],"operation":"buy","property_type":["flat"],"new_construction":[0,1],"bedrooms":[0,1,2,3,"4+"]}},"AddressInfoOutput":{"title":"AddressInfoOutput","required":["id","municipality_id","postal_code_cadastre","province_id","ref_cat","street_type","street_name","street_number","build_year","area_property","area_building"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"municipality_id":{"title":"Municipality Id","type":"integer"},"postal_code_cadastre":{"title":"Postal Code Cadastre","type":"string"},"municipality_district":{"title":"Municipality District","type":"string"},"province_id":{"title":"Province Id","type":"integer"},"ref_cat":{"title":"Ref Cat","type":"string"},"street_type":{"title":"Street Type","type":"string"},"street_name":{"title":"Street Name","type":"string"},"street_number":{"title":"Street Number","type":"string"},"stair":{"title":"Stair","type":"string"},"door":{"title":"Door","type":"string"},"block":{"title":"Block","type":"string"},"floor":{"title":"Floor","type":"string"},"build_year":{"title":"Build Year","type":"integer"},"use":{"title":"Use","type":"string"},"area_property":{"title":"Area Property","type":"integer"},"area_building":{"title":"Area Building","type":"integer"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"fragua_postal_code":{"title":"Fragua Postal Code","type":"string"},"fragua_district_name":{"title":"Fragua District Name","type":"string"},"fragua_district_id":{"title":"Fragua District Id","type":"integer"},"sscc":{"title":"Sscc","type":"string"}},"example":{"id":21661767,"municipality_id":79,"postal_code_cadastre":"28012","municipality_district":"01","province_id":28,"ref_cat":"0334804VK4703C0001OT","street_type":"CL","street_name":"EMBAJADORES","street_number":"58","stair":"","door":"DR","block":"","floor":"00","build_year":1900,"use":"C","area_property":86,"area_building":647,"latitude":40.40754489730971,"longitude":-3.7045648625266945,"fragua_postal_code":"28005","fragua_district_name":"Madrid (SCD Embajadores-1)","fragua_district_id":1237,"sscc":"2807901037"}},"AmenitiesOutput":{"title":"AmenitiesOutput","type":"object","properties":{"air_conditioning":{"title":"Air Conditioning","type":"number"},"garage":{"title":"Garage","type":"number"},"lift":{"title":"Lift","type":"number"},"swimming_pool":{"title":"Swimming Pool","type":"number"},"storage":{"title":"Storage","type":"number"},"terrace":{"title":"Terrace","type":"number"}},"example":{"air_conditioning":50.0,"garage":75.0,"lift":100.0,"swimming_pool":0.0,"storage":100.0,"terrace":25.0}},"AmenityFlexInput":{"title":"AmenityFlexInput","required":["postal_code","price","price_m2","amenities"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":["0","1","2","3","4+"],"type":"string"},"default":["0","1","2","3","4+"]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"price":{"title":"Price","type":"array","items":{"type":"integer"}},"price_m2":{"title":"Price M2","type":"array","items":{"type":"integer"}},"terrace":{"title":"Terrace","type":"array","items":{"enum":[0,1],"type":"integer"}},"electricity":{"title":"Electricity","type":"array","items":{"enum":[0,1],"type":"integer"}},"wifi":{"title":"Wifi","type":"array","items":{"enum":[0,1],"type":"integer"}},"water":{"title":"Water","type":"array","items":{"enum":[0,1],"type":"integer"}},"cleaning":{"title":"Cleaning","type":"array","items":{"enum":[0,1],"type":"integer"}},"heating":{"title":"Heating","type":"array","items":{"enum":[0,1],"type":"integer"}},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"}},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"}},"pets_allowed":{"title":"Pets Allowed","type":"array","items":{"enum":[0,1],"type":"integer"}},"air_conditioning":{"title":"Air Conditioning","type":"array","items":{"enum":[0,1],"type":"integer"}},"lift":{"title":"Lift","type":"array","items":{"enum":[0,1],"type":"integer"}},"type":{"title":"Type","type":"string"},"duration":{"$ref":"#/components/schemas/DurationField"},"amenities":{"title":"Amenities","type":"array","items":{"enum":["water","wifi","heating","terrace","lift","pets_allowed","swimming_pool","garage","electricity","cleaning","gas","air_conditioning"],"type":"string"}}},"example":{"postal_code":["28001"],"operation":"buy","bedrooms":["0","1","2","3","4+"],"aggregation":"postal_code","coordinates":[],"price":[0,4900000],"price_m2":[0,19000]}},"AskingClosingOutput":{"title":"AskingClosingOutput","required":["x_value","Asking","Closing"],"type":"object","properties":{"x_value":{"title":"X Value","type":"integer"},"Asking":{"title":"Asking","type":"number"},"Closing":{"title":"Closing","type":"number"}},"example":{"x_value":2012,"Asking":2423.6667,"Closing":2002.9652}},"AssetData":{"title":"AssetData","required":["size","latitude","longitude"],"type":"object","properties":{"size":{"title":"Size","type":"integer"},"property_type":{"title":"Property Type","enum":["flat","house"],"type":"string","default":"flat"},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"status":{"title":"Status","type":"array","items":{"enum":[2,4,5],"type":"integer"},"default":[2,4,5]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":[0,1,2,3,4,5,6,7,8,9,10],"type":"integer"},"default":[0,1,2,3,4,5,6,7,8,9,10]},"lift":{"title":"Lift","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"}}},"AssetValuationInput":{"title":"AssetValuationInput","type":"object","properties":{"size":{"title":"Size","type":"integer"},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"address":{"title":"Address","type":"string"},"cadastre_reference":{"title":"Cadastre Reference","type":"string"},"property_type":{"title":"Property Type","enum":["flat","house","premises","storage","garage","office","building","industrial"],"type":"string"},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"status":{"title":"Status","type":"array","items":{"enum":[2,4,5],"type":"integer"},"default":[2,4,5]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":[0,1,2,3,4,5,6,7,8,9,10],"type":"integer"},"default":[0,1,2,3,4,5,6,7,8,9,10]},"lift":{"title":"Lift","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"postal_code":{"title":"Postal Code","type":"string"},"asset_class":{"title":"Asset Class","enum":["garages","storages","buildings","offices","retail","industrial","residentials"],"type":"string","default":"residentials"}},"example":{"size":100,"operation":"buy","address":"Calle de la Princesa, 3","asset_class":"residentials","new_construction":[0,1],"status":[2,4,5],"bedrooms":[0,1,2,3,4,5,6,7,8,9,10],"lift":[0,1]}},"AssetsRegisterClosings":{"title":"AssetsRegisterClosings","type":"object","properties":{"ID":{"title":"Id","type":"integer"},"short_writing_date":{"title":"Short Writing Date","type":"string"},"street":{"title":"Street","type":"string"},"build_year":{"title":"Build Year","type":"integer"},"size":{"title":"Size","type":"integer"},"price":{"title":"Price","type":"number"},"price_m2":{"title":"Price M2","type":"number"},"type":{"title":"Type","type":"string"},"description":{"title":"Description","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"postal_code":{"title":"Postal Code","type":"string"},"municipality":{"title":"Municipality","type":"string"},"province":{"title":"Province","type":"string"},"ccaa":{"title":"Ccaa","type":"string"},"date":{"title":"Date","type":"string"},"date_formatted":{"title":"Date Formatted","type":"string"},"coordinates":{"title":"Coordinates","type":"object"}},"example":{"ID":2876596,"short_writing_date":"07/2023","street":"RELATORES, 12","build_year":1880,"size":128,"price":555880.0,"price_m2":4340.1,"type":"flat","description":"Vivienda libre","latitude":40.4130962497,"longitude":-3.7032928805,"postal_code":"28012","municipality":"Madrid","province":"Madrid","ccaa":"Comunidad de Madrid","date":"2023-07-01T00:00:00","date_formatted":"2023-07-01","coordinates":{"lat":40.4130962497,"lon":-3.7032928805}}},"AssetsRegisterClosingsOutput":{"title":"AssetsRegisterClosingsOutput","required":["total","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/AssetsRegisterClosings"}}}},"BedroomsSupplyOutput":{"title":"BedroomsSupplyOutput","required":["bedrooms","supply"],"type":"object","properties":{"bedrooms":{"title":"Bedrooms","type":"string"},"supply":{"title":"Supply","type":"integer"}}},"BedroomsSupplyTextOutput":{"title":"BedroomsSupplyTextOutput","required":["data","text","text_en"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/BedroomsSupplyOutput"}},"text":{"title":"Text","type":"string"},"text_en":{"title":"Text En","type":"string"}}},"Body_login_login_post":{"title":"Body_login_login_post","required":["username","password"],"type":"object","properties":{"grant_type":{"title":"Grant Type","pattern":"password","type":"string"},"username":{"title":"Username","type":"string"},"password":{"title":"Password","type":"string"},"scope":{"title":"Scope","type":"string","default":""},"client_id":{"title":"Client Id","type":"string"},"client_secret":{"title":"Client Secret","type":"string"}}},"Body_login_v2_v2_login_post":{"title":"Body_login_v2_v2_login_post","required":["username","password"],"type":"object","properties":{"grant_type":{"title":"Grant Type","pattern":"password","type":"string"},"username":{"title":"Username","type":"string"},"password":{"title":"Password","type":"string"},"scope":{"title":"Scope","type":"string","default":""},"client_id":{"title":"Client Id","type":"string"},"client_secret":{"title":"Client Secret","type":"string"}}},"BtrAsset":{"title":"BtrAsset","type":"object","properties":{"asset_id":{"title":"Asset Id","type":"string"},"name":{"title":"Name","type":"string"},"postal_code":{"title":"Postal Code","type":"string"},"municipality":{"title":"Municipality","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"last_modification":{"title":"Last Modification","type":"string"},"address":{"title":"Address","type":"string"},"asset_class":{"title":"Asset Class","type":"string"},"sub_asset_class":{"title":"Sub Asset Class","type":"string"},"country":{"title":"Country","type":"string"},"status":{"title":"Status","type":"string"},"operator":{"title":"Operator","type":"string"},"management":{"title":"Management","type":"string"},"units":{"title":"Units","type":"integer"},"owner":{"title":"Owner","type":"string"},"developer":{"title":"Developer","type":"string"},"ccaa":{"title":"Ccaa","type":"string"},"province":{"title":"Province","type":"string"},"base_price":{"title":"Base Price","type":"number"},"opening_year":{"title":"Opening Year","type":"integer"},"inclusion_date":{"title":"Inclusion Date","type":"string"},"base_price_studios":{"title":"Base Price Studios","type":"number"},"base_price_1bd":{"title":"Base Price 1Bd","type":"number"},"base_price_2bd":{"title":"Base Price 2Bd","type":"number"},"base_price_3bd":{"title":"Base Price 3Bd","type":"number"},"base_price_4plusbd":{"title":"Base Price 4Plusbd","type":"number"}}},"BuiltToRentAssetsInput":{"title":"BuiltToRentAssetsInput","required":["postal_codes"],"type":"object","properties":{"postal_codes":{"title":"Postal Codes","type":"array","items":{"type":"string"}},"status":{"title":"Status","type":"array","items":{"type":"string"}},"sub_asset_class":{"title":"Sub Asset Class","type":"array","items":{"type":"string"}}},"example":{"postal_codes":["28001","28002"],"sub_asset_class":["BTR","PRS"]}},"BuiltToRentAssetsOutput":{"title":"BuiltToRentAssetsOutput","required":["operating","pipeline"],"type":"object","properties":{"operating":{"title":"Operating","type":"array","items":{"$ref":"#/components/schemas/BtrAsset"}},"pipeline":{"title":"Pipeline","type":"array","items":{"$ref":"#/components/schemas/BtrAsset"}}}},"ChartBedroomsInput":{"title":"ChartBedroomsInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house","premises"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"attic":{"title":"Attic","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"duplex":{"title":"Duplex","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"ground_floor":{"title":"Ground Floor","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"storage":{"title":"Storage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"type":{"title":"Type","enum":["comparison"],"type":"string","default":"comparison"},"amenities":{"title":"Amenities","type":"array","items":{"enum":["swimming_pool","storage","garage","lift","air_conditioning","terrace"],"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]}},"description":"This class is used to validate the input of the bedrooms chart.","example":{"postal_code":["28001"],"operation":"buy","property_type":["flat"],"new_construction":[0,1],"attic":[0,1],"duplex":[0,1],"ground_floor":[0,1],"garage":[0,1],"swimming_pool":[0,1],"storage":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"area":[0,500]}},"ChartBedroomsOutput":{"title":"ChartBedroomsOutput","required":["x_value","Agregado"],"type":"object","properties":{"x_value":{"title":"X Value","type":"integer"},"Agregado":{"title":"Agregado","type":"number"}},"example":{"x_value":0,"Agregado":2}},"ChartGeneralMetricsInput":{"title":"ChartGeneralMetricsInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house","premises"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"attic":{"title":"Attic","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"duplex":{"title":"Duplex","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"ground_floor":{"title":"Ground Floor","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"storage":{"title":"Storage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"type":{"title":"Type","enum":["comparison","aggregated"],"type":"string","default":"aggregated"},"amenities":{"title":"Amenities","type":"array","items":{"enum":["swimming_pool","storage","garage","lift","air_conditioning","terrace"],"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]}},"description":"This class is used to validate the input of the general metrics chart.","example":{"postal_code":["28001"],"operation":"buy","property_type":["flat"],"new_construction":[0,1],"attic":[0,1],"duplex":[0,1],"ground_floor":[0,1],"garage":[0,1],"swimming_pool":[0,1],"storage":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"area":[0,500]}},"ChartGeneralMetricsInputRetail":{"title":"ChartGeneralMetricsInputRetail","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["premises"],"type":"string"},"default":["premises"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"attic":{"title":"Attic","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"duplex":{"title":"Duplex","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"ground_floor":{"title":"Ground Floor","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"storage":{"title":"Storage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"type":{"title":"Type","enum":["comparison","aggregated"],"type":"string","default":"aggregated"},"amenities":{"title":"Amenities","type":"array","items":{"enum":["swimming_pool","storage","garage","lift","air_conditioning","terrace"],"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]}},"description":"This class is used to validate the input of the retail chart.","example":{"postal_code":["28001"],"operation":"buy","property_type":["premises"],"new_construction":[0,1],"attic":[0,1],"duplex":[0,1],"ground_floor":[0,1],"garage":[0,1],"swimming_pool":[0,1],"storage":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"area":[0,500]}},"ChatHistoryResponse":{"title":"ChatHistoryResponse","required":["chat_history"],"type":"object","properties":{"chat_history":{"title":"Chat History","type":"array","items":{"$ref":"#/components/schemas/ChatResponse"},"description":"List of chats."}}},"ChatHistoryResponseUsa":{"title":"ChatHistoryResponseUsa","required":["chat_history"],"type":"object","properties":{"chat_history":{"title":"Chat History","type":"array","items":{"$ref":"#/components/schemas/ChatResponseUsa"},"description":"List of chats."}}},"ChatResponse":{"title":"ChatResponse","required":["user_id","chat_id","timestamp","messages"],"type":"object","properties":{"user_id":{"title":"User Id","type":"integer","description":"User identifier."},"chat_id":{"title":"Chat Id","type":"string","description":"Chat identifier."},"timestamp":{"title":"Timestamp","type":"string","description":"Time of the chat."},"assistant_id":{"title":"Assistant Id","type":"string","description":"Assistant identifier.","default":""},"thread_id":{"title":"Thread Id","type":"string","description":"Thread identifier.","default":""},"messages":{"title":"Messages","type":"array","items":{"$ref":"#/components/schemas/FraguaAIMessage"},"description":"List of chat messages."}}},"ChatResponseUsa":{"title":"ChatResponseUsa","required":["user_id","chat_id","timestamp","messages"],"type":"object","properties":{"user_id":{"title":"User Id","type":"integer","description":"User identifier."},"chat_id":{"title":"Chat Id","type":"string","description":"Chat identifier."},"timestamp":{"title":"Timestamp","type":"string","description":"Time of the chat."},"assistant_id":{"title":"Assistant Id","type":"string","description":"Assistant identifier.","default":""},"thread_id":{"title":"Thread Id","type":"string","description":"Thread identifier.","default":""},"messages":{"title":"Messages","type":"array","items":{"$ref":"#/components/schemas/FraguaAIMessageUsa"},"description":"List of chat messages."}}},"ComparableData":{"title":"ComparableData","required":["air_conditioning","attic","bathrooms","bedrooms","characteristics","datasource_name","floor","furnished","garage","garden","is_exterior","latitude","lift","longitude","new_construction","operation","post_date","postal_code","price_m2","price","property_type","property_url","size","sports","status","storage","swimming_pool","terrace","title"],"type":"object","properties":{"air_conditioning":{"title":"Air Conditioning","type":"integer"},"attic":{"title":"Attic","type":"integer"},"bathrooms":{"title":"Bathrooms","type":"integer"},"bedrooms":{"title":"Bedrooms","type":"integer"},"characteristics":{"title":"Characteristics","type":"string"},"commercial_complete_name":{"title":"Commercial Complete Name","type":"string"},"datasource_name":{"title":"Datasource Name","type":"string"},"description":{"title":"Description","type":"string"},"energy_certification_type":{"title":"Energy Certification Type","type":"string"},"floor":{"title":"Floor","type":"integer"},"furnished":{"title":"Furnished","type":"integer"},"garage":{"title":"Garage","type":"integer"},"garden":{"title":"Garden","type":"integer"},"is_exterior":{"title":"Is Exterior","type":"integer"},"latitude":{"title":"Latitude","type":"number"},"lift":{"title":"Lift","type":"integer"},"longitude":{"title":"Longitude","type":"number"},"new_construction":{"title":"New Construction","type":"integer"},"operation":{"title":"Operation","type":"string"},"post_date":{"title":"Post Date","type":"string","format":"date-time"},"postal_code":{"title":"Postal Code","type":"string"},"price_m2":{"title":"Price M2","type":"integer"},"price":{"title":"Price","type":"integer"},"property_type":{"title":"Property Type","type":"string"},"property_url":{"title":"Property Url","type":"string"},"size":{"title":"Size","type":"integer"},"sports":{"title":"Sports","type":"integer"},"status":{"title":"Status","type":"integer"},"storage":{"title":"Storage","type":"integer"},"swimming_pool":{"title":"Swimming Pool","type":"integer"},"terrace":{"title":"Terrace","type":"integer"},"title":{"title":"Title","type":"string"}}},"ComparablesDatasetResponse":{"title":"ComparablesDatasetResponse","required":["data"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/ComparableData"}}}},"Coordinates":{"title":"Coordinates","required":["lat","lon"],"type":"object","properties":{"lat":{"title":"Lat","type":"number"},"lon":{"title":"Lon","type":"number"}}},"DataDemand":{"title":"DataDemand","required":["market"],"type":"object","properties":{"market":{"title":"Market","type":"array","items":{"$ref":"#/components/schemas/MarketDataDemand"}}}},"DataDemographics":{"title":"DataDemographics","required":["market","demographics"],"type":"object","properties":{"market":{"title":"Market","type":"array","items":{"$ref":"#/components/schemas/MarketDataDemographics"}},"demographics":{"$ref":"#/components/schemas/DemographicsData"}}},"DataInput":{"title":"DataInput","required":["scope"],"type":"object","properties":{"limit":{"title":"Limit","type":"integer","default":0},"offset":{"title":"Offset","type":"integer","default":10},"filter_origin":{"title":"Filter Origin","type":"string"},"filtered_ids":{"title":"Filtered Ids","type":"array","items":{},"default":[]},"scope":{"title":"Scope","enum":["national","international",""],"type":"string"},"date_range":{"$ref":"#/components/schemas/app__schemas__newsroom_schemas__DateRange"}}},"DataMarket":{"title":"DataMarket","required":["market"],"type":"object","properties":{"market":{"title":"Market","type":"array","items":{"$ref":"#/components/schemas/MarketData"}}}},"DateRangeAssets":{"title":"DateRangeAssets","type":"object","properties":{"start_date":{"title":"Start Date","type":"string","default":"2024-01-01"},"end_date":{"title":"End Date","type":"string","default":"2026-12-31"}},"description":"Date range for the API"},"DemandDatasetResponse":{"title":"DemandDatasetResponse","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataDemand"}}},"DemographicsData":{"title":"DemographicsData","required":["date","household_income","percent_people_renting","population_density","one_people_households","two_people_households","people_average_age","percent_age_20_30","unemployment","high_education_people","empty_households","population"],"type":"object","properties":{"date":{"title":"Date","type":"string"},"household_income":{"title":"Household Income","type":"number"},"percent_people_renting":{"title":"Percent People Renting","type":"number"},"population_density":{"title":"Population Density","type":"number"},"one_people_households":{"title":"One People Households","type":"number"},"two_people_households":{"title":"Two People Households","type":"number"},"people_average_age":{"title":"People Average Age","type":"number"},"percent_age_20_30":{"title":"Percent Age 20 30","type":"number"},"unemployment":{"title":"Unemployment","type":"number"},"high_education_people":{"title":"High Education People","type":"number"},"empty_households":{"title":"Empty Households","type":"number"},"population":{"title":"Population","type":"integer"}}},"DemographicsDatasetResponse":{"title":"DemographicsDatasetResponse","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataDemographics"}}},"DemographicsTrendsInput":{"title":"DemographicsTrendsInput","required":["aggregation","historical_aggregation","historical_range","postal_code","type"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","province"],"type":"string"},"historical_aggregation":{"title":"Historical Aggregation","enum":["month","quarter","year"],"type":"string"},"historical_range":{"title":"Historical Range","type":"string"},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"type":{"title":"Type","type":"string"}},"example":{"aggregation":"postal_code","historical_aggregation":"year","historical_range":"2000-01-01,2024-08-01","postal_code":["28001"],"type":"comparison"}},"DurationField":{"title":"DurationField","required":["midTerm","shortTerm"],"type":"object","properties":{"midTerm":{"title":"Midterm","type":"boolean"},"shortTerm":{"title":"Shortterm","type":"boolean"}}},"Filters":{"title":"Filters","type":"object","properties":{"metric":{"title":"Metric","type":"array","items":{"type":"string"},"description":"Metric(s) being queried."},"selected_location_type":{"title":"Selected Location Type","type":"string","description":"Type of location selected.","default":""},"aggregation":{"title":"Aggregation","type":"string","description":"Aggregation type.","default":""},"operation":{"title":"Operation","type":"array","items":{"type":"string"},"description":"Operations (e.g., 'rent', 'buy')."},"property_type":{"title":"Property Type","type":"array","items":{"type":"string"},"description":"Property types (e.g., 'flat', 'house')."},"new_construction":{"title":"New Construction","type":"array","items":{"type":"integer"},"description":"Indicates whether the property is new construction (0 or 1)."},"bedrooms":{"title":"Bedrooms","type":"array","items":{},"description":"Number of bedrooms."},"final_date":{"title":"Final Date","type":"string","description":"Final date for the filter in YYYY-MM-DD format.","default":""},"starting_date":{"title":"Starting Date","type":"string","description":"Starting date for the filter in YYYY-MM-DD format.","default":""},"result_limit":{"title":"Result Limit","type":"integer","description":"Maximum number of results to returned based on the query.","default":0},"sorting":{"title":"Sorting","type":"string","description":"Sorting order (e.g., 'ASC', 'DESC').","default":""},"language":{"title":"Language","type":"string","description":"Language for the results (e.g., 'es').","default":"es"},"country":{"title":"Country","type":"string","description":"Country for the results (e.g., 'es').","default":"es"},"cadastre_reference":{"title":"Cadastre Reference","type":"array","items":{"type":"string"},"description":"Cadastre reference specified on the question."},"street":{"title":"Street","type":"array","items":{"type":"string"},"description":"Streets specified on the question."},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"},"description":"Postal codes specified on the question."},"neighbourhood":{"title":"Neighbourhood","type":"array","items":{"type":"string"},"description":"Neighbourhoods specified on the question."},"district":{"title":"District","type":"array","items":{"type":"string"},"description":"Districts specified on the question."},"municipality":{"title":"Municipality","type":"array","items":{"type":"string"},"description":"Municipalities specified on the question."},"province":{"title":"Province","type":"array","items":{"type":"string"},"description":"Provinces specified on the question."},"ccaa":{"title":"Ccaa","type":"array","items":{"type":"string"},"description":"Autonomous communities specified on the question."}}},"FiltersUsa":{"title":"FiltersUsa","type":"object","properties":{"metric":{"title":"Metric","type":"array","items":{"type":"string"},"description":"Metric(s) being queried."},"selected_location_type":{"title":"Selected Location Type","type":"string","description":"Type of location selected.","default":""},"aggregation":{"title":"Aggregation","type":"string","description":"Aggregation type.","default":""},"operation":{"title":"Operation","type":"array","items":{"type":"string"},"description":"Operations (e.g., 'rent', 'buy')."},"property_type":{"title":"Property Type","type":"array","items":{"type":"string"},"description":"Property types (e.g., 'flat', 'house')."},"new_construction":{"title":"New Construction","type":"array","items":{"type":"integer"},"description":"Indicates whether the property is new construction (0 or 1)."},"bedrooms":{"title":"Bedrooms","type":"array","items":{},"description":"Number of bedrooms."},"final_date":{"title":"Final Date","type":"string","description":"Final date for the filter in YYYY-MM-DD format.","default":""},"starting_date":{"title":"Starting Date","type":"string","description":"Starting date for the filter in YYYY-MM-DD format.","default":""},"result_limit":{"title":"Result Limit","type":"integer","description":"Maximum number of results to returned based on the query.","default":0},"sorting":{"title":"Sorting","type":"string","description":"Sorting order (e.g., 'ASC', 'DESC').","default":""},"language":{"title":"Language","type":"string","description":"Language for the results (e.g., 'es').","default":"es"},"country":{"title":"Country","type":"string","description":"Country for the results (e.g., 'es').","default":"es"},"zip_code":{"title":"Zip Code","type":"array","items":{"type":"string"},"description":"Zip codes specified on the question."},"cdp":{"title":"Cdp","type":"array","items":{"type":"string"},"description":"Census Designated Places specified on the question."},"village":{"title":"Village","type":"array","items":{"type":"string"},"description":"Villages specified on the question."},"town":{"title":"Town","type":"array","items":{"type":"string"},"description":"Towns specified on the question."},"city":{"title":"City","type":"array","items":{"type":"string"},"description":"Cities specified on the question."},"county":{"title":"County","type":"array","items":{"type":"string"},"description":"Counties specified on the question."},"state":{"title":"State","type":"array","items":{"type":"string"},"description":"States specified on the question."}}},"FlexInstitutionalCoordinate":{"title":"FlexInstitutionalCoordinate","required":["lat","lng"],"type":"object","properties":{"lat":{"title":"Lat","type":"number"},"lng":{"title":"Lng","type":"number"}}},"FraguaAIMessage":{"title":"FraguaAIMessage","required":["id","sender","message","type","messageTime","data"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique identifier for the message."},"sender":{"title":"Sender","type":"string","description":"Sender of the message (e.g., 'fragua_ai')."},"message":{"title":"Message","type":"string","description":"Text message from FraguaAI (only if returned, otherwise empty)."},"type":{"title":"Type","type":"string","description":"Type of message (e.g., 'data')."},"messageTime":{"title":"Messagetime","type":"string","description":"Timestamp of the message."},"data":{"title":"Data","type":"array","items":{},"description":"List of data columns returned by the API."},"filters":{"title":"Filters","allOf":[{"$ref":"#/components/schemas/Filters"}],"description":"Filters applied in the query based on the user's question."}}},"FraguaAIMessageUsa":{"title":"FraguaAIMessageUsa","required":["id","sender","message","type","messageTime","data"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique identifier for the message."},"sender":{"title":"Sender","type":"string","description":"Sender of the message (e.g., 'fragua_ai')."},"message":{"title":"Message","type":"string","description":"Text message from FraguaAI (only if returned, otherwise empty)."},"type":{"title":"Type","type":"string","description":"Type of message (e.g., 'data')."},"messageTime":{"title":"Messagetime","type":"string","description":"Timestamp of the message."},"data":{"title":"Data","type":"array","items":{},"description":"List of data columns returned by the API."},"filters":{"title":"Filters","allOf":[{"$ref":"#/components/schemas/FiltersUsa"}],"description":"Filters applied in the query based on the user's question."}}},"GeneralMetricsExtendInput":{"title":"GeneralMetricsExtendInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house","premises"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"attic":{"title":"Attic","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"duplex":{"title":"Duplex","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"ground_floor":{"title":"Ground Floor","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"storage":{"title":"Storage","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"historical_aggregation":{"title":"Historical Aggregation","type":"string","default":"2020-04-01,2026-07-03"},"historical_range":{"title":"Historical Range","type":"string","default":"month"},"type":{"title":"Type","enum":["comparison"],"type":"string","default":"comparison"},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"amenities":{"title":"Amenities","type":"array","items":{"enum":["swimming_pool","storage","garage","lift","air_conditioning","terrace"],"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]}},"description":"This class is used to validate the input of the general metrics table.","example":{"postal_code":["28001"],"operation":"buy","property_type":["flat"],"new_construction":[0,1],"attic":[0,1],"duplex":[0,1],"ground_floor":[0,1],"garage":[0,1],"swimming_pool":[0,1],"storage":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"area":[0,500],"aggregation":"postal_code","coordinates":[]}},"GeneralMetricsFlexInput":{"title":"GeneralMetricsFlexInput","required":["postal_code","price","price_m2"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":["0","1","2","3","4+"],"type":"string"},"default":["0","1","2","3","4+"]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"price":{"title":"Price","type":"array","items":{"type":"integer"}},"price_m2":{"title":"Price M2","type":"array","items":{"type":"integer"}},"terrace":{"title":"Terrace","type":"array","items":{"enum":[0,1],"type":"integer"}},"electricity":{"title":"Electricity","type":"array","items":{"enum":[0,1],"type":"integer"}},"wifi":{"title":"Wifi","type":"array","items":{"enum":[0,1],"type":"integer"}},"water":{"title":"Water","type":"array","items":{"enum":[0,1],"type":"integer"}},"cleaning":{"title":"Cleaning","type":"array","items":{"enum":[0,1],"type":"integer"}},"heating":{"title":"Heating","type":"array","items":{"enum":[0,1],"type":"integer"}},"swimming_pool":{"title":"Swimming Pool","type":"array","items":{"enum":[0,1],"type":"integer"}},"garage":{"title":"Garage","type":"array","items":{"enum":[0,1],"type":"integer"}},"pets_allowed":{"title":"Pets Allowed","type":"array","items":{"enum":[0,1],"type":"integer"}},"air_conditioning":{"title":"Air Conditioning","type":"array","items":{"enum":[0,1],"type":"integer"}},"lift":{"title":"Lift","type":"array","items":{"enum":[0,1],"type":"integer"}},"type":{"title":"Type","type":"string"},"duration":{"$ref":"#/components/schemas/DurationField"}},"example":{"postal_code":["28001"],"operation":"buy","bedrooms":["0","1","2","3","4+"],"aggregation":"postal_code","coordinates":[],"price":[0,4900000],"price_m2":[0,19000]}},"GeneralMetricsRetailInput":{"title":"GeneralMetricsRetailInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"area":{"title":"Area","type":"array","items":{"type":"integer"},"default":[0,500]},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house","premises","room"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]}},"example":{"postal_code":["28001"],"operation":"buy","property_type":["premises"],"new_construction":[0,1],"bedrooms":[0,1,2,3,"4+"],"aggregation":"postal_code","coordinates":[]}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"Image":{"title":"Image","required":["image_number","image_url","image_detail","height","width"],"type":"object","properties":{"image_number":{"title":"Image Number","type":"integer"},"image_url":{"title":"Image Url","type":"string"},"image_detail":{"title":"Image Detail","type":"string"},"height":{"title":"Height","type":"integer"},"width":{"title":"Width","type":"integer"}}},"InstitutionalFlexLivingInput":{"title":"InstitutionalFlexLivingInput","required":["aggregation","postal_code"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["polygon","postal_code","municipality","province","ccaa"],"type":"string"},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/FlexInstitutionalCoordinate"}},"default":[]},"sub_asset_class":{"title":"Sub Asset Class","type":"array","items":{"enum":["serviced_apartments","coliving","flex_living","short_stays"],"type":"string"}},"status":{"title":"Status","type":"array","items":{"type":"string"}},"flat_units":{"title":"Flat Units","type":"array","items":{"type":"integer"}}},"example":{"aggregation":"postal_code","postal_code":["28001","28002"],"coordinates":[],"sub_asset_class":["serviced_apartments","coliving","flex_living","short_stays"],"status":["operating","pipeline"],"flat_units":[0,500]}},"InstitutionalFlexLivingOutput":{"title":"InstitutionalFlexLivingOutput","required":["operating_units","pipeline_units"],"type":"object","properties":{"operating_units":{"title":"Operating Units","type":"array","items":{"$ref":"#/components/schemas/InstitutionalFlexLivingUnit"}},"pipeline_units":{"title":"Pipeline Units","type":"array","items":{"$ref":"#/components/schemas/InstitutionalFlexLivingUnit"}}}},"InstitutionalFlexLivingUnit":{"title":"InstitutionalFlexLivingUnit","type":"object","properties":{"name":{"title":"Name","type":"string"},"address":{"title":"Address","type":"string"},"sub_asset_class":{"title":"Sub Asset Class","type":"string"},"operator":{"title":"Operator","type":"string"},"units":{"title":"Units","type":"integer"},"owner":{"title":"Owner","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"price":{"title":"Price","type":"number"}}},"InteresPlacesOutput":{"title":"InteresPlacesOutput","required":["type","type_format","n_places","rating","user_ratings_total"],"type":"object","properties":{"type":{"title":"Type","type":"string"},"type_format":{"title":"Type Format","type":"string"},"n_places":{"title":"N Places","type":"integer"},"rating":{"title":"Rating","type":"number"},"user_ratings_total":{"title":"User Ratings Total","type":"integer"}},"example":{"type":"Comercios","type_format":"commerces","n_places":11,"rating":4.2364,"user_ratings_total":29730}},"LandPropertiesOutput":{"title":"LandPropertiesOutput","required":["results"],"type":"object","properties":{"results":{"title":"Results","type":"array","items":{"type":"object"}}},"example":{"results":[{"_id":"0334804VK4703C","geometry":{"type":"Polygon","coordinates":[[]]},"properties":{},"type":"Feature","refcat_coordinates":[-3.7045648625266945,40.40754489730971]}]}},"MarketData":{"title":"MarketData","required":["date","buy_price","buy_price_m2","rent_price","rent_price_m2","yield_data"],"type":"object","properties":{"date":{"title":"Date","type":"string"},"buy_price":{"title":"Buy Price","type":"number"},"buy_price_m2":{"title":"Buy Price M2","type":"number"},"rent_price":{"title":"Rent Price","type":"number"},"rent_price_m2":{"title":"Rent Price M2","type":"number"},"yield_data":{"title":"Yield Data","type":"number"}}},"MarketDataDemand":{"title":"MarketDataDemand","required":["date","absorption_buy","absorption_rent","vacancy_rate_buy","vacancy_rate_rent"],"type":"object","properties":{"date":{"title":"Date","type":"string"},"absorption_buy":{"title":"Absorption Buy","type":"number"},"absorption_rent":{"title":"Absorption Rent","type":"number"},"vacancy_rate_buy":{"title":"Vacancy Rate Buy","type":"number"},"vacancy_rate_rent":{"title":"Vacancy Rate Rent","type":"number"}}},"MarketDataDemographics":{"title":"MarketDataDemographics","required":["date","effort_rate","years_to_pay"],"type":"object","properties":{"date":{"title":"Date","type":"string"},"effort_rate":{"title":"Effort Rate","type":"number"},"years_to_pay":{"title":"Years To Pay","type":"integer"}}},"MarketDatasetResponse":{"title":"MarketDatasetResponse","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataMarket"}}},"MunicipalityOutput":{"title":"MunicipalityOutput","required":["municipality","municipality_id","province_id"],"type":"object","properties":{"municipality":{"title":"Municipality","type":"string"},"municipality_id":{"title":"Municipality Id","type":"integer"},"province_id":{"title":"Province Id","type":"integer"}},"example":{"municipality":"MADRID","municipality_id":79,"province_id":28}},"NewChatMessage":{"title":"NewChatMessage","required":["message","chat_id","thread_id","assistant_id"],"type":"object","properties":{"message":{"title":"Message","type":"string"},"chat_id":{"title":"Chat Id","type":"string"},"thread_id":{"title":"Thread Id","type":"string"},"assistant_id":{"title":"Assistant Id","type":"string"},"country":{"title":"Country","type":"string","default":"es"}}},"NewMessageResponse":{"title":"NewMessageResponse","required":["response_type","fragua_ai_message"],"type":"object","properties":{"response_type":{"title":"Response Type","type":"string","description":"Type of response (e.g., 'function')."},"task_id":{"title":"Task Id","type":"string","description":"Task identifier, if applicable."},"fragua_ai_message":{"title":"Fragua Ai Message","allOf":[{"$ref":"#/components/schemas/FraguaAIMessage"}],"description":"Details of the FraguaAI message."}}},"NewMessageResponseUsa":{"title":"NewMessageResponseUsa","required":["response_type","fragua_ai_message"],"type":"object","properties":{"response_type":{"title":"Response Type","type":"string","description":"Type of response (e.g., 'function')."},"task_id":{"title":"Task Id","type":"string","description":"Task identifier, if applicable."},"fragua_ai_message":{"title":"Fragua Ai Message","allOf":[{"$ref":"#/components/schemas/FraguaAIMessageUsa"}],"description":"Details of the FraguaAI message."}}},"News":{"title":"News","required":["id","title","date","origin","url"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"title":{"title":"Title","type":"string"},"date":{"title":"Date","type":"string","format":"date"},"origin":{"title":"Origin","type":"string"},"url":{"title":"Url","type":"string"},"image_url":{"title":"Image Url","type":"string"}}},"OtherAssetsValuationInput":{"title":"OtherAssetsValuationInput","type":"object","properties":{"cadastre_reference":{"title":"Cadastre Reference","type":"string"},"address":{"title":"Address","type":"string"},"size":{"title":"Size","type":"integer"},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"postal_code":{"title":"Postal Code","type":"string"}},"description":"Generic input schema for non-residential assets (retail, storage, garage, offices).","example":{"cadastre_reference":"0863905VK4706D0010LW","address":"Calle Mayor, 1","operation":"buy","latitude":40.4168,"longitude":-3.7038,"postal_code":"28013"}},"Pagination":{"title":"Pagination","type":"object","properties":{"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"offset":{"title":"Offset","minimum":0.0,"type":"integer","default":0}}},"PbsaBedroomsMetricsInput":{"title":"PbsaBedroomsMetricsInput","required":["postal_code"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":["0","1","2","3","4","5","6","7+"],"type":"string"},"default":["0","1","2","3","4","5","6","7+"]},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"price_m2_range":{"title":"Price M2 Range","type":"object"}},"example":{"aggregation":"postal_code","bedrooms":["0","1","2","3","4","5","6","7+"],"coordinates":[],"postal_code":["28001"],"price_m2_range":{"min_price_m2":0,"max_price_m2":70}}},"PbsaBedroomsMetricsOutput":{"title":"PbsaBedroomsMetricsOutput","required":["price","supply"],"type":"object","properties":{"price":{"title":"Price","type":"number"},"supply":{"title":"Supply","type":"integer"}},"example":{"price":689.2977,"supply":131}},"PbsaBedroomsTrendsInput":{"title":"PbsaBedroomsTrendsInput","required":["postal_code"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","municipality","polygon"],"type":"string","default":"postal_code"},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":["0","1","2","3","4","5","6","7+"],"type":"string"},"default":["0","1","2","3","4","5","6","7+"]},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"historical_aggregation":{"title":"Historical Aggregation","type":"string","default":"month"},"historical_range":{"title":"Historical Range","type":"string","default":"2020-04-01,2026-07-03"},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"price_m2_range":{"title":"Price M2 Range","type":"object"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["room"],"type":"string"},"default":["room"]},"type":{"title":"Type","enum":["comparison","aggregated"],"type":"string","default":"aggregated"}},"example":{"postal_code":["48010"],"coordinates":[],"bedrooms":["0","1","2","3"],"aggregation":"postal_code","price_m2_range":{"min_price_m2":0,"max_price_m2":70},"property_type":["room"],"type":"comparison","historical_aggregation":"month","historical_range":"2022-07-01,2025-02-28"}},"PbsaBedsSummaryOutput":{"title":"PbsaBedsSummaryOutput","required":["type","beds"],"type":"object","properties":{"type":{"title":"Type","type":"string"},"beds":{"title":"Beds","type":"integer"}},"example":{"type":"modern_standard price","beds":245}},"PbsaInput":{"title":"PbsaInput","required":["postal_code"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"pbsa_type":{"title":"Pbsa Type","type":"array","items":{"enum":["modern_standard","religious","public","others","student_residences","pipeline"],"type":"string"},"default":["modern_standard","religious","public","others","student_residences","pipeline"]}},"example":{"postal_code":["28001"],"pbsa_type":["modern_standard","religious","public","others","student_residences","pipeline"],"coordinates":[]}},"PbsaProvisionRateOutput":{"title":"PbsaProvisionRateOutput","required":["title","value","type"],"type":"object","properties":{"title":{"title":"Title","type":"string"},"value":{"title":"Value","type":"number"},"type":{"title":"Type","type":"string"}},"example":{"title":"current_pr","value":0.37,"type":"risky"}},"PbsaResidencesOutput":{"title":"PbsaResidencesOutput","required":["type","beds","id","residence_name","direction","individual_fare","catered","latitude","longitude"],"type":"object","properties":{"type":{"title":"Type","type":"string"},"beds":{"title":"Beds","type":"integer"},"id":{"title":"Id","type":"string"},"residence_name":{"title":"Residence Name","type":"string"},"direction":{"title":"Direction","type":"string"},"individual_fare":{"title":"Individual Fare","type":"number"},"catered":{"title":"Catered","type":"string"},"operator":{"title":"Operator","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"}},"example":{"id":"28001_Residencia Barrio Salamanca","type":"modern_standard","residence_name":"Residencia Barrio Salamanca","direction":"C/ Lagasca, 45 Madrid","individual_fare":1090.0,"beds":100,"catered":"Opt","operator":"Mi Casa Inn","latitude":40.4267533,"longitude":-3.6853473}},"Portfolio":{"title":"Portfolio","required":["area","bedrooms","bathrooms","garage","lift","storage","terrace","air_conditioned","pool","garden","sports","latitude","longitude"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"address":{"title":"Address","type":"string"},"property_type":{"title":"Represents the type of property","enum":["house","flat"],"type":"string","default":"flat"},"construction_type":{"title":"Value 0 represents second hand and 1 represents new construction","enum":[0,1],"type":"integer","default":0},"area":{"title":"Area","type":"integer"},"bedrooms":{"title":"Bedrooms","type":"integer"},"bathrooms":{"title":"Bathrooms","type":"integer"},"garage":{"title":"Garage","type":"boolean"},"lift":{"title":"Lift","type":"boolean"},"storage":{"title":"Storage","type":"boolean"},"terrace":{"title":"Terrace","type":"boolean"},"air_conditioned":{"title":"Air Conditioned","type":"boolean"},"pool":{"title":"Pool","type":"boolean"},"garden":{"title":"Garden","type":"boolean"},"sports":{"title":"Sports","type":"boolean"},"conservation":{"title":"Value 2 represents to reform, 3 represents regular, 4 represents good and 5 represents new construction / renovated","enum":[2,3,4,5],"type":"integer","default":3},"price_buy":{"title":"Price Buy","type":"number"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"postal_code":{"title":"Postal Code","type":"string"},"price_rent":{"title":"Price Rent","type":"number"},"valued":{"title":"Value True represents that the property has been valued","type":"boolean","default":false},"user":{"$ref":"#/components/schemas/User"},"valuation_date":{"title":"Valuation Date","type":"string","format":"date-time"}}},"PriceM2Range":{"title":"PriceM2Range","type":"object","properties":{"min_price_m2":{"title":"Min Price M2","type":"integer","default":0},"max_price_m2":{"title":"Max Price M2","type":"integer","default":2000}},"description":"Price m2 range for the API"},"PriceRange":{"title":"PriceRange","type":"object","properties":{"min_price":{"title":"Min Price","type":"integer","default":0},"max_price":{"title":"Max Price","type":"integer","default":6000000}},"description":"Price range for the API"},"PropertiesInput":{"title":"PropertiesInput","required":["refcat"],"type":"object","properties":{"refcat":{"title":"Refcat","type":"string"}},"example":{"refcat":"0334804VK4703C"}},"PropertyValuationInput":{"title":"PropertyValuationInput","type":"object","properties":{"size":{"title":"Size","type":"integer"},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"address":{"title":"Address","type":"string"},"cadastre_reference":{"title":"Cadastre Reference","type":"string"},"property_type":{"title":"Property Type","enum":["flat","house","premises","storage","garage","office","building","industrial"],"type":"string"},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"status":{"title":"Status","type":"array","items":{"enum":[2,4,5],"type":"integer"},"default":[2,4,5]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":[0,1,2,3,4,5,6,7,8,9,10],"type":"integer"},"default":[0,1,2,3,4,5,6,7,8,9,10]},"lift":{"title":"Lift","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"postal_code":{"title":"Postal Code","type":"string"}}},"ProvinceComparableInput":{"title":"ProvinceComparableInput","required":["province"],"type":"object","properties":{"province":{"title":"Province","type":"string"}}},"ProvinceListResponse":{"title":"ProvinceListResponse","required":["provinces"],"type":"object","properties":{"provinces":{"title":"Provinces","type":"array","items":{"type":"string"}}}},"ProvinceMetricsInput":{"title":"ProvinceMetricsInput","required":["province"],"type":"object","properties":{"province":{"title":"Province","type":"string"},"date_range":{"$ref":"#/components/schemas/app__schemas__market_place_schemas__DateRange"}}},"ProvinceOutput":{"title":"ProvinceOutput","required":["id","province"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"province":{"title":"Province","type":"string"}},"example":{"id":28,"province":"MADRID"}},"PublicApiAssetsComparableInput":{"title":"PublicApiAssetsComparableInput","required":["operation","price_range","size_range"],"type":"object","properties":{"limit":{"title":"Limit","type":"integer","default":20},"offset":{"title":"Offset","type":"integer","default":0},"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string"},"date_range":{"$ref":"#/components/schemas/DateRangeAssets"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"sort":{"$ref":"#/components/schemas/SortInput"}},"example":{"limit":20,"offset":0,"aggregation":"postal_code","input":["28012"],"operation":"buy","date_range":{"start_date":"2024-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"geo_point_radius":500,"new_construction":[0,1]}},"PublicApiAssetsComparableInputV2":{"title":"PublicApiAssetsComparableInputV2","required":["aggregation","input","operation","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string"},"date_range":{"$ref":"#/components/schemas/DateRangeAssets"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"property_type":{"title":"Property Type","enum":["flat","house","premises","industrial"],"type":"string"},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"}},"bedrooms":{"title":"Bedrooms","type":"array","items":{"type":"integer"}},"bathrooms":{"title":"Bathrooms","type":"array","items":{"type":"integer"}},"features":{"title":"Features","type":"array","items":{"enum":["attic","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","bare_ownership","not_bare_ownership"],"type":"string"},"default":[]},"illegally_occupied":{"title":"Illegally Occupied","type":"boolean"},"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"offset":{"title":"Offset","type":"integer","default":0},"list_ids":{"title":"List Ids","type":"array","items":{"type":"string"}},"asset_class":{"title":"Asset Class","enum":["garages","storages","buildings","offices","retail","industrial","landplots","residentials"],"type":"string","default":"residentials"}},"example":{"asset_class":"residentials","aggregation":"postal_code","input":["19001"],"operation":"buy","price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"property_type":"flat","new_construction":[0,1],"bedrooms":[0,1,2,3,4],"bathrooms":[0,1,2,3,4],"limit":10,"offset":0}},"PublicApiComparableInput":{"title":"PublicApiComparableInput","required":["aggregation","input","operation","date_range","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string"},"date_range":{"$ref":"#/components/schemas/app__schemas__comparable_schemas__DateRange"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"features":{"title":"Features","type":"array","items":{"enum":["attic","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","bare_ownership","not_bare_ownership"],"type":"string"},"default":[]},"illegally_occupied":{"title":"Illegally Occupied","type":"boolean"}},"example":{"aggregation":"postal_code","input":["19001"],"operation":"buy","date_range":{"start_date":"2024-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"property_type":["flat","house","premises"],"new_construction":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"illegally_occupied":false,"features":["lift"]}},"PublicApiComparableInputV2":{"title":"PublicApiComparableInputV2","required":["aggregation","input","operation","date_range","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string"},"date_range":{"$ref":"#/components/schemas/app__schemas__comparable_schemas__DateRange"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,"4+"]},"features":{"title":"Features","type":"array","items":{"enum":["attic","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","bare_ownership","not_bare_ownership"],"type":"string"},"default":[]},"illegally_occupied":{"title":"Illegally Occupied","type":"boolean"},"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"offset":{"title":"Offset","type":"integer","default":0},"list_ids":{"title":"List Ids","type":"array","items":{"type":"string"}}},"example":{"aggregation":"postal_code","input":["19001"],"operation":"buy","date_range":{"start_date":"2024-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"property_type":["flat","house"],"new_construction":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"limit":10,"offset":0}},"PublicApiComparableOutput":{"title":"PublicApiComparableOutput","type":"object","properties":{"address_location_id":{"title":"Address Location Id","type":"string"},"address_location_level":{"title":"Address Location Level","type":"string"},"address_location_short":{"title":"Address Location Short","type":"string"},"address_municipality_id":{"title":"Address Municipality Id","type":"string"},"address_province_id":{"title":"Address Province Id","type":"string"},"air_conditioning":{"title":"Air Conditioning","type":"string"},"attic":{"title":"Attic","type":"string"},"bare_ownership":{"title":"Bare Ownership","type":"string"},"bathrooms":{"title":"Bathrooms","type":"string"},"bedrooms":{"title":"Bedrooms","type":"string"},"build_year":{"title":"Build Year","type":"number"},"built_size":{"title":"Built Size","type":"number"},"built_type":{"title":"Built Type","type":"string"},"characteristics":{"title":"Characteristics","type":"string"},"commercial_complete_name":{"title":"Commercial Complete Name","type":"string"},"commercial_first_name":{"title":"Commercial First Name","type":"string"},"commercial_id":{"title":"Commercial Id","type":"string"},"commercial_image":{"title":"Commercial Image","type":"string"},"commercial_location":{"title":"Commercial Location","type":"string"},"commercial_name":{"title":"Commercial Name","type":"string"},"commercial_phone_number":{"title":"Commercial Phone Number","type":"string"},"commercial_url":{"title":"Commercial Url","type":"string"},"contact_preference":{"title":"Contact Preference","type":"string"},"datasource_name":{"title":"Datasource Name","type":"string"},"description":{"title":"Description","type":"string"},"didomi_vendors_consent":{"title":"Didomi Vendors Consent","type":"string"},"district":{"title":"District","type":"string"},"doorman":{"title":"Doorman","type":"string"},"duplex":{"title":"Duplex","type":"string"},"energy_certification_kwh":{"title":"Energy Certification Kwh","type":"number"},"energy_certification_suffix":{"title":"Energy Certification Suffix","type":"string"},"energy_certification_type":{"title":"Energy Certification Type","type":"string"},"equipped_kitchen":{"title":"Equipped Kitchen","type":"string"},"fitted_wardrobes":{"title":"Fitted Wardrobes","type":"string"},"floor":{"title":"Floor","type":"string"},"floor_plan":{"title":"Floor Plan","type":"string"},"furnished":{"title":"Furnished","type":"string"},"garage":{"title":"Garage","type":"string"},"garden":{"title":"Garden","type":"string"},"has_recommended":{"title":"Has Recommended","type":"string"},"heating_central":{"title":"Heating Central","type":"string"},"heating_individual":{"title":"Heating Individual","type":"string"},"heating_type":{"title":"Heating Type","type":"string"},"home_staging":{"title":"Home Staging","type":"string"},"ID":{"title":"Id","type":"number"},"image_names":{"title":"Image Names","type":"string"},"image_url":{"title":"Image Url","type":"string"},"is_active":{"title":"Is Active","type":"string"},"is_auction":{"title":"Is Auction","type":"string"},"is_east":{"title":"Is East","type":"string"},"is_exterior":{"title":"Is Exterior","type":"string"},"is_interior":{"title":"Is Interior","type":"string"},"is_north":{"title":"Is North","type":"string"},"is_recommended":{"title":"Is Recommended","type":"string"},"is_south":{"title":"Is South","type":"string"},"is_west":{"title":"Is West","type":"string"},"latitude":{"title":"Latitude","type":"number"},"lift":{"title":"Lift","type":"string"},"longitude":{"title":"Longitude","type":"number"},"luxury":{"title":"Luxury","type":"string"},"n_months_deposit":{"title":"N Months Deposit","type":"integer"},"new_construction":{"title":"New Construction","type":"string"},"number_recommended":{"title":"Number Recommended","type":"string"},"operation":{"title":"Operation","type":"string"},"origin":{"title":"Origin","type":"string"},"origin_type_recommended":{"title":"Origin Type Recommended","type":"string"},"other_characteristics":{"title":"Other Characteristics","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"past_price":{"title":"Past Price","type":"number"},"photo_number":{"title":"Photo Number","type":"number"},"plot_size":{"title":"Plot Size","type":"number"},"post_date":{"title":"Post Date","type":"string"},"postal_code":{"title":"Postal Code","type":"string"},"price":{"title":"Price","type":"number"},"price_m2":{"title":"Price M2","type":"number"},"property_type":{"title":"Property Type","type":"string"},"property_url":{"title":"Property Url","type":"string"},"recommendation_id":{"title":"Recommendation Id","type":"string"},"reduced_mobility_access":{"title":"Reduced Mobility Access","type":"string"},"registered":{"title":"Registered","type":"string"},"segregable":{"title":"Segregable","type":"string"},"size":{"title":"Size","type":"number"},"sports":{"title":"Sports","type":"string"},"status":{"title":"Status","type":"string"},"storage":{"title":"Storage","type":"string"},"students":{"title":"Students","type":"string"},"swimming_pool":{"title":"Swimming Pool","type":"string"},"terrace":{"title":"Terrace","type":"string"},"title":{"title":"Title","type":"string"},"tour3d":{"title":"Tour3D","type":"string"},"turistic_license":{"title":"Turistic License","type":"string"},"type_recommended":{"title":"Type Recommended","type":"string"},"typology":{"title":"Typology","type":"string"},"updated":{"title":"Updated","type":"string"},"useful_size":{"title":"Useful Size","type":"number"},"video_number":{"title":"Video Number","type":"string"},"id_pk":{"title":"Id Pk","type":"number"},"Unique_asset_id":{"title":"Unique Asset Id","type":"string"},"duplicate":{"title":"Duplicate","type":"number"},"parent":{"title":"Parent","type":"string"},"add_id":{"title":"Add Id","type":"string"},"image_galery":{"title":"Image Galery","type":"array","items":{"$ref":"#/components/schemas/Image"},"default":[]},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"inserted":{"title":"Inserted","type":"string"}},"example":{"address_location_id":"0-EU-ES-28-07-001-079-01-002","address_location_level":"8","address_location_short":"Lavapiés-Embajadores, Madrid","address_municipality_id":"0-EU-ES-28-07-001-079","address_province_id":"0-EU-ES-28","air_conditioning":"0","attic":"0","bare_ownership":"0","bathrooms":"1","bedrooms":"1","build_year":1890.0,"built_size":70.0,"built_type":"3","characteristics":"70 m² construidos,1 habitación,1 baño,balcón,segunda mano/buen estado,construido en 1890,calefacción individual: eléctrica,planta 2ª exterior,sin ascensor,\naire acondicionado\n,\nconsumo: \n321 kwh/m² año\n,\nemisiones: \n31 kg co2/m² año\n","commercial_complete_name":"\nMarcos Pastor\n\n","commercial_first_name":"Marcos","commercial_id":"","commercial_image":"https://img4.idealista.com/blur/WEB_DETAIL_TOP-L-L/0/id.pro.es.image.master/0f/2e/58/1246357293.jpg","commercial_location":"Madrid","commercial_name":"lacasahuertascortes","commercial_phone_number":"","commercial_url":"/pro/lacasahuertascortes/","contact_preference":"1","datasource_name":"Idealista","description":"\n¡oportunidad exterior en la zona de moda de madrid! ite favorableel inmueble está en perfecto estado. además, destacar la altura de los techos y que todo cuenta con ventanas para la entrada de luz natural al inmueble.la finca es representativa y data del año 1890, con un diseño típico de la época que combina a la perfección con este antiguo barrio madrileño. cuenta con corrala y la ite es favorable de 2020.la distribución actual es la siguiente: una gran zona social con cocina americana totalmente equipada y que cuenta con dos balcones que inundan la propiedad de luz natural; una habitación de buen tamaño con un vestidor muy generoso y un baño completo.situado en una ubicación idílica, que cuenta con numerosas galerías de arte, árboles y ningún local de restauración cercano. además, destacar su cercanía a cualquier medio de transporte (atocha, línea 1 de metro, etc) y el estar a menos de 10 minutos a pie de la emblemática puerta del sol, plaza mayor, retiro, etc. además, encontrarán una diversa oferta de ocio, supermercados y estaciones de autobús con líneas que acceden a casi todos los puntos de la ciudad.además, comentarte que contamos con un departamento financiero finanzate, intermediación financiera eurocredit mad s. l. en el cual puedes obtener un asesoramiento sin compromiso/sin coste para conocer tus posibilidades y tener mejores opciones y garantías a la hora de comprar.no pierdas la oportunidad de vivir en este maravilloso piso. ¡contáctanos hoy mismo para programar una visita!nota: este anuncio no es vinculante; puede contener errores y se muestra a título informativo, no contractual.\n","didomi_vendors_consent":"","district":"madrid_centro_lavapies-embajadores","doorman":"0","duplex":"0","energy_certification_kwh":0.0,"energy_certification_suffix":"","energy_certification_type":"e","equipped_kitchen":"0","fitted_wardrobes":"0","floor":"2","floor_plan":"0","furnished":"0","garage":"0","garden":"0","heating_central":"0","heating_individual":"1","heating_type":"eléctrica","home_staging":"0","ID":105245995.0,"image_names":":vestidor,ing: ,:terraza,:cocina,:vistas,:foto,:baño,:dormitorio,:estancia,:salón","image_url":"https://img4.idealista.com/blur/WEB_DETAIL_TOP-L-L/0/id.pro.es.image.master/0f/2e/58/1246357293.jpg","is_active":"1","is_auction":"0","is_east":"1","is_exterior":"1","is_interior":"0","is_north":"0","is_recommended":"0","is_south":"0","is_west":"0","latitude":40.4086,"lift":"0","longitude":-3.69828,"luxury":"0","new_construction":"0","number_recommended":"","operation":"buy","origin":"12","origin_type_recommended":"","other_characteristics":"","owner_type":"2","past_price":435000.0,"photo_number":27.0,"plot_size":0.0,"post_date":"2024-06-23T13:13:44.942000+02:00","postal_code":"28012","price":420000.0,"price_m2":6000.0,"property_type":"flat","property_url":"https://www.idealista.com/inmueble/105245995/","recommendation_id":"","reduced_mobility_access":"0","registered":"2024-06-23","segregable":"0","size":70.0,"sports":"0","status":"4","storage":"0","students":"0","swimming_pool":"0","terrace":"0","title":"piso en venta en calle del doctor fourquet","tour3d":"0","turistic_license":"0","type_recommended":"","typology":"1","updated":"2024-06-21","useful_size":0.0,"video_number":"0","id_pk":6579.0,"Unique_asset_id":"103987338104877334104880058105245995","duplicate":0.0,"parent":"105245995","image_galery":[{"image_number":1,"image_url":"https://img4.idealista.com/blur/WEB_DETAIL_TOP-L-L/0/id.pro.es.image.master/0f/2e/58/1246357293.jpg","image_detail":"Principal","height":960,"width":1280}],"coordinates":{"lat":40.4086,"lon":-3.69828},"inserted":"2024-06-24"}},"PublicApiComparableRegisterClosingsInput":{"title":"PublicApiComparableRegisterClosingsInput","required":["asset_class","aggregation","price_range","price_m2_range","size_range"],"type":"object","properties":{"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"offset":{"title":"Offset","type":"integer","default":0},"asset_class":{"title":"Asset Class","enum":["garages","storages","retail","residentials","industrial"],"type":"string"},"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"date_range":{"$ref":"#/components/schemas/DateRangeAssets"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"price_m2_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"sort":{"$ref":"#/components/schemas/RegisterClosingsSortInput"}},"example":{"asset_class":"residentials","aggregation":"postal_code","input":["19001"],"date_range":{"start_date":"2024-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"price_m2_range":{"min_price_m2":0,"max_price_m2":12000},"size_range":{"min_size":0,"max_size":500},"geo_point_radius":500,"sort":{"sort_by":"date","sort_order":"desc"},"limit":10,"offset":0}},"PublicApiHistoricalComparableInput":{"title":"PublicApiHistoricalComparableInput","required":["aggregation","input","operation","asset_class"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string"},"asset_class":{"title":"Asset Class","enum":["residential","retail","industrial"],"type":"string"},"date_range":{"$ref":"#/components/schemas/app__schemas__comparable_schemas__DateRange"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house","premises","industrial"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"bedrooms":{"title":"Bedrooms","type":"array","items":{"title":" Bedrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,4]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"title":" Bathrooms","anyOf":[{"enum":[0,1,2,3],"type":"integer"},{"enum":["4+"],"type":"string"}]},"default":[0,1,2,3,4]},"features":{"title":"Features","type":"array","items":{"enum":["attic","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","bare_ownership","not_bare_ownership"],"type":"string"},"default":[]},"illegally_occupied":{"title":"Illegally Occupied","type":"boolean"},"list_ids":{"title":"List Ids","type":"array","items":{"type":"string"}},"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":20},"offset":{"title":"Offset","type":"integer","default":0}},"example":{"aggregation":"postal_code","input":["28001"],"operation":"buy","asset_class":"residential","date_range":{"start_date":"2024-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"property_type":["flat","house"],"new_construction":[0,1],"bedrooms":[0,1,2,3,"4+"],"bathrooms":[0,1,2,3,"4+"],"limit":10,"offset":0}},"PublicApiRegisterClosingsInput":{"title":"PublicApiRegisterClosingsInput","required":["aggregation","input","date_range","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["postal_code","polygon","geo_point","municipality","province"],"type":"string"},"input":{"title":"Input","type":"array","items":{}},"date_range":{"$ref":"#/components/schemas/app__schemas__comparable_schemas__DateRange"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"type":{"title":"Type","enum":["residential","retail"],"type":"string","default":"residential"},"geo_point_radius":{"title":"Geo Point Radius","type":"integer","default":500},"sort":{"$ref":"#/components/schemas/RegisterClosingsSortInput"}},"example":{"aggregation":"postal_code","input":["28012"],"date_range":{"start_date":"2025-07-03T13:06:31","end_date":"2026-07-03T13:06:31"},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"type":"residential","sort":{"sort_by":"date","sort_order":"desc"}}},"PublicApiRegisterClosingsInputV2":{"title":"PublicApiRegisterClosingsInputV2","required":["aggregation","postal_code","price_m2_range","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["polygon","postal_code","municipality"],"type":"string"},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"price_m2_range":{"$ref":"#/components/schemas/PriceM2Range"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"limit":{"title":"Limit","type":"integer","default":10},"offset":{"title":"Offset","type":"integer","default":0},"sort":{"$ref":"#/components/schemas/RegisterClosingsSortInput"}},"example":{"aggregation":"postal_code","postal_code":["28012"],"coordinates":[],"price_m2_range":{"min_price_m2":0,"max_price_m2":2000},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"sort":{"sort_by":"date","sort_order":"desc"},"limit":10,"offset":0}},"PublicApiRegisterClosingsOutput":{"title":"PublicApiRegisterClosingsOutput","type":"object","properties":{"ID":{"title":"Id","type":"number"},"postal_code":{"title":"Postal Code","type":"string"},"short_writing_date":{"title":"Short Writing Date","type":"string"},"street":{"title":"Street","type":"string"},"build_year":{"title":"Build Year","type":"integer"},"size":{"title":"Size","type":"number"},"price":{"title":"Price","type":"number"},"price_m2":{"title":"Price M2","type":"number"},"type":{"title":"Type","type":"string"},"description":{"title":"Description","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"municipality":{"title":"Municipality","type":"string"},"province":{"title":"Province","type":"string"},"ccaa":{"title":"Ccaa","type":"string"},"municipality_id":{"title":"Municipality Id","type":"integer"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"date":{"title":"Date","type":"string"}},"example":{"ID":2876596,"postal_code":"28012","short_writing_date":"07/2023","street":"RELATORES, 12","build_year":1880,"size":128.08,"price":555880,"price_m2":4340.0999,"type":"Sin anejos","description":"Vivienda libre","latitude":40.4130962497,"longitude":-3.7032928805,"municipality":"Madrid","province":"Madrid","ccaa":"Comunidad de Madrid","municipality_id":1929,"coordinates":{"lat":40.4130962497,"lon":-3.7032928805},"date":"2023-07-01T00:00:00"}},"PublicEstimatedPriceInput":{"title":"PublicEstimatedPriceInput","required":["price_buy_range","size_range"],"type":"object","properties":{"zone_type":{"title":"Zone Type","enum":["neighbourhood","province","municipality","district"],"type":"string"},"neighbourhood":{"title":"Neighbourhood","type":"string"},"district":{"title":"District","type":"string"},"municipality":{"title":"Municipality","type":"string"},"province":{"title":"Province","type":"string"},"price_buy_range":{"$ref":"#/components/schemas/PriceRange"},"estimated_price_rent_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"limit":{"title":"Limit","maximum":100.0,"minimum":1.0,"type":"integer","default":10},"offset":{"title":"Offset","type":"integer","default":0},"bedrooms":{"title":"Bedrooms","type":"array","items":{"type":"integer"},"default":[1,2,3,4,5]},"bathrooms":{"title":"Bathrooms","type":"array","items":{"type":"integer"},"default":[1,2,3,4,5]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"property_type":{"title":"Property Type","enum":["flat","house"],"type":"string","default":"flat"},"sort":{"$ref":"#/components/schemas/SortInput"},"features":{"title":"Features","type":"array","items":{"enum":["attic","middle_floor","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","is_auction","not_is_auction","ground_floor","not_ground_floor","bare_ownership","not_bare_ownership"],"type":"string"},"default":[]},"list_ids":{"title":"List Ids","type":"array","items":{"type":"string"}},"illegally_occupied":{"title":"Illegally Occupied","type":"boolean"}},"example":{"zone_type":"neighbourhood","neighbourhood":"Lavapiés-Embajadores","price_buy_range":{"min_price":0,"max_price":6000000},"estimated_price_rent_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"limit":10,"offset":0,"bedrooms":[1,2,3,4,5],"bathrooms":[1,2,3,4,5],"new_construction":[0,1],"property_type":"flat","sort":{"sort_by":"price","sort_order":"asc"},"features":["attic","middle_floor","duplex","garage","swimming_pool","storage","terrace","garden","sports","air_conditioning","doorman","equipped_kitchen","furnished","lift","is_auction","not_is_auction","ground_floor","not_ground_floor","bare_ownership","not_bare_ownership"],"illegally_occupied":false}},"PublicFlexInput":{"title":"PublicFlexInput","required":["aggregation","postal_code","price_m2_range","price_range","size_range"],"type":"object","properties":{"aggregation":{"title":"Aggregation","enum":["polygon","postal_code","municipality"],"type":"string"},"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"coordinates":{"title":"Coordinates","type":"array","items":{},"default":[]},"price_m2_range":{"$ref":"#/components/schemas/PriceM2Range"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"size_range":{"$ref":"#/components/schemas/SizeRange"},"limit":{"title":"Limit","type":"integer","default":10},"offset":{"title":"Offset","type":"integer","default":0},"bedrooms":{"title":"Bedrooms","type":"array","items":{"enum":["0","1","2","3","4+"],"type":"string"},"default":["0","1","2","3","4+"]},"terrace":{"title":"Terrace","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"electricity":{"title":"Electricity","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"wifi":{"title":"Wifi","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"water":{"title":"Water","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"cleaning":{"title":"Cleaning","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"heating":{"title":"Heating","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"stay_duration":{"title":"Stay Duration","type":"array","items":{"enum":["shortTerm","midTerm"],"type":"string"},"default":["shortTerm","midTerm"]}},"example":{"aggregation":"postal_code","postal_code":["28012"],"operation":"buy","coordinates":[],"bedrooms":["0","1","2","3","4+"],"price_m2_range":{"min_price_m2":0,"max_price_m2":2000},"price_range":{"min_price":0,"max_price":6000000},"size_range":{"min_size":0,"max_size":500},"stay_duration":["shortTerm","midTerm"],"is_active":1,"limit":10,"offset":0,"terrace":[0,1],"electricity":[0,1],"wifi":[0,1],"water":[0,1],"cleaning":[0,1],"heating":[0,1]}},"RatingsOutput":{"title":"RatingsOutput","required":["plot_data","plot_design","plot_text","plot_reference_line","table_data"],"type":"object","properties":{"plot_data":{"title":"Plot Data","type":"array","items":{}},"plot_design":{"title":"Plot Design","type":"array","items":{}},"plot_text":{"title":"Plot Text","type":"array","items":{}},"plot_reference_line":{"title":"Plot Reference Line","type":"array","items":{}},"table_data":{"title":"Table Data","type":"array","items":{}}},"example":{"plot_data":[],"plot_design":[],"plot_text":[],"plot_reference_line":[],"table_data":[]}},"RefCatCoordinatesOutput":{"title":"RefCatCoordinatesOutput","required":["ref_cat","postal_code","latitude","longitude","fragua_district_name","fragua_district_id"],"type":"object","properties":{"ref_cat":{"title":"Ref Cat","type":"string"},"postal_code":{"title":"Postal Code","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"fragua_district_name":{"title":"Fragua District Name","type":"string"},"fragua_district_id":{"title":"Fragua District Id","type":"integer"}},"example":{"ref_cat":"0334804VK4703C0001OT","postal_code":"28005","latitude":40.40754489730971,"longitude":-3.7045648625266945,"fragua_district_name":"Madrid (SCD Embajadores-1)","fragua_district_id":1237}},"RefCatFromCoordinatesOutput":{"title":"RefCatFromCoordinatesOutput","required":["ref_cat"],"type":"object","properties":{"ref_cat":{"title":"Ref Cat","type":"string"},"coordinates":{"title":"Coordinates","type":"object"},"address":{"title":"Address","type":"string"},"error":{"title":"Error","type":"string"}},"example":{"ref_cat":"0334804VK4703C","coordinates":{"lat":"40.40754489730971","long":"-3.7045648625266945"},"address":"CL EMBAJADORES 58 MADRID (MADRID)","error":""}},"RegisterClosingsSortInput":{"title":"RegisterClosingsSortInput","required":["sort_by","sort_order"],"type":"object","properties":{"sort_by":{"title":"Sort By","enum":["date","price","price_m2","size","date_formatted"],"type":"string"},"sort_order":{"title":"Sort Order","enum":["asc","desc"],"type":"string"}}},"SeniorLivingAsset":{"title":"SeniorLivingAsset","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"},"beds":{"title":"Beds","type":"integer"},"postal_code":{"title":"Postal Code","type":"string"},"ownership":{"title":"Ownership","type":"string"},"operator_type":{"title":"Operator Type","type":"string"},"sub_asset_class":{"title":"Sub Asset Class","type":"string"},"status":{"title":"Status","type":"string"},"latitude":{"title":"Latitude","type":"number"},"longitude":{"title":"Longitude","type":"number"},"address":{"title":"Address","type":"string"},"operator":{"title":"Operator","type":"string"},"owner":{"title":"Owner","type":"string"}}},"SeniorLivingAssetsInput":{"title":"SeniorLivingAssetsInput","required":["postal_codes"],"type":"object","properties":{"postal_codes":{"title":"Postal Codes","type":"array","items":{"type":"string"}},"ownership":{"title":"Ownership","type":"array","items":{"type":"string"}},"operator":{"title":"Operator","type":"array","items":{"type":"string"}},"sub_asset_class":{"title":"Sub Asset Class","type":"array","items":{"type":"string"}},"status":{"title":"Status","type":"array","items":{"type":"string"}},"province":{"title":"Province","type":"string"}},"example":{"postal_codes":["28001","28002"],"ownership":["private"],"operator":["main_operator"],"sub_asset_class":["care_home"]}},"SeniorLivingAssetsOutput":{"title":"SeniorLivingAssetsOutput","required":["operating","pipeline"],"type":"object","properties":{"operating":{"title":"Operating","type":"array","items":{"$ref":"#/components/schemas/SeniorLivingAsset"}},"pipeline":{"title":"Pipeline","type":"array","items":{"$ref":"#/components/schemas/SeniorLivingAsset"}}}},"SizeRange":{"title":"SizeRange","type":"object","properties":{"min_size":{"title":"Min Size","type":"integer","default":0},"max_size":{"title":"Max Size","type":"integer","default":500}},"description":"Size range for the API"},"SortInput":{"title":"SortInput","required":["sort_by","sort_order"],"type":"object","properties":{"sort_by":{"title":"Sort By","enum":["price","price_m2","size","estimated_price_rent"],"type":"string"},"sort_order":{"title":"Sort Order","enum":["asc","desc"],"type":"string"}}},"StreetNameOutput":{"title":"StreetNameOutput","required":["id","municipality_id","postal_code_cadastre","province_id","ref_cat","street_type","street_name","street_number"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"municipality_id":{"title":"Municipality Id","type":"integer"},"postal_code_cadastre":{"title":"Postal Code Cadastre","type":"string"},"municipality_district":{"title":"Municipality District","type":"string"},"province_id":{"title":"Province Id","type":"integer"},"ref_cat":{"title":"Ref Cat","type":"string"},"street_type":{"title":"Street Type","type":"string"},"street_name":{"title":"Street Name","type":"string"},"street_number":{"title":"Street Number","type":"string"},"stair":{"title":"Stair","type":"string"},"door":{"title":"Door","type":"string"},"block":{"title":"Block","type":"string"},"floor":{"title":"Floor","type":"string"}},"example":{"id":21661767,"municipality_id":79,"postal_code_cadastre":"28012","municipality_district":"01","province_id":28,"ref_cat":"0334804VK4703C0001OT","street_type":"CL","street_name":"EMBAJADORES","street_number":"58","stair":"","door":"DR","block":"","floor":"00"}},"StreetOutput":{"title":"StreetOutput","required":["municipality_id","province_id","street_name","street_type"],"type":"object","properties":{"municipality_id":{"title":"Municipality Id","type":"integer"},"province_id":{"title":"Province Id","type":"integer"},"street_name":{"title":"Street Name","type":"string"},"street_type":{"title":"Street Type","type":"string"}},"example":{"municipality_id":79,"province_id":28,"street_name":"EMBAJADORES","street_type":"CL"}},"SummaryInput":{"title":"SummaryInput","required":["postal_code","period"],"type":"object","properties":{"postal_code":{"title":"Postal Code","type":"array","items":{"type":"string"}},"operation":{"title":"Operation","enum":["buy","rent"],"type":"string","default":"buy"},"property_type":{"title":"Property Type","type":"array","items":{"enum":["flat","house"],"type":"string"},"default":["flat","house"]},"new_construction":{"title":"New Construction","type":"array","items":{"enum":[0,1],"type":"integer"},"default":[0,1]},"period":{"title":"Period","enum":["1_month","3_months","6_months","12_months"],"type":"string"}},"example":{"postal_code":["28012"],"operation":"buy","property_type":["flat","house"],"new_construction":[0,1],"period":"1_month"}},"SummaryItem":{"title":"SummaryItem","required":["x","y"],"type":"object","properties":{"x":{"title":"X","type":"string"},"y":{"title":"Y","type":"number"}}},"SummaryOutput":{"title":"SummaryOutput","required":["price_relative","price_absolute","price_m2_relative","price_m2_absolute","area_relative","area_absolute","bedrooms_relative","bedrooms_absolute","conservation_relative","conservation_absolute"],"type":"object","properties":{"price_relative":{"$ref":"#/components/schemas/SummaryItem"},"price_absolute":{"$ref":"#/components/schemas/SummaryItem"},"price_m2_relative":{"$ref":"#/components/schemas/SummaryItem"},"price_m2_absolute":{"$ref":"#/components/schemas/SummaryItem"},"area_relative":{"$ref":"#/components/schemas/SummaryItem"},"area_absolute":{"$ref":"#/components/schemas/SummaryItem"},"bedrooms_relative":{"$ref":"#/components/schemas/SummaryItem"},"bedrooms_absolute":{"$ref":"#/components/schemas/SummaryItem"},"conservation_relative":{"$ref":"#/components/schemas/SummaryItem"},"conservation_absolute":{"$ref":"#/components/schemas/SummaryItem"}},"example":{"price_relative":{"x":"1102145.3784","y":0.5994},"price_absolute":{"x":"179454.0141","y":21.1293},"price_m2_relative":{"x":"1434.62","y":1},"price_m2_absolute":{"x":"4270.1942","y":40.0529},"area_relative":{"x":"208.8624","y":0.5585},"area_absolute":{"x":"59.8408","y":25.9184},"bedrooms_relative":{"x":"5","y":0.5556},"bedrooms_absolute":{"x":"1","y":24},"conservation_relative":{"x":"Obra nueva","y":0.4444},"conservation_absolute":{"x":"Bueno ","y":27}}},"Token":{"title":"Token","required":["access_token","token_type"],"type":"object","properties":{"access_token":{"title":"Access Token","type":"string"},"token_type":{"title":"Token Type","type":"string"}}},"TrendOutput":{"title":"TrendOutput","required":["date","value"],"type":"object","properties":{"date":{"title":"Date","type":"string"},"value":{"title":"Value","anyOf":[{"type":"number"},{"type":"string"}]}}},"TrendTextOutput":{"title":"TrendTextOutput","required":["data","text","text_en"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/TrendOutput"}},"text":{"title":"Text","type":"string"},"text_en":{"title":"Text En","type":"string"}}},"User":{"title":"User","required":["name","lastname","email"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"lastname":{"title":"Lastname","type":"string"},"email":{"title":"Email","type":"string"}}},"UserApiCallsResponse":{"title":"UserApiCallsResponse","type":"object","additionalProperties":{"type":"integer"}},"UserCreate":{"title":"UserCreate","required":["email","name","last_name","phone_number"],"type":"object","properties":{"email":{"title":"Email","type":"string"},"name":{"title":"Name","type":"string"},"last_name":{"title":"Last Name","type":"string"},"phone_number":{"title":"Phone Number","type":"string"}}},"UserCreateResponse":{"title":"UserCreateResponse","required":["user_id","email","created_at","is_admin","company_id","company","nombre","apellido","auth0_id","telefono","colores","idioma"],"type":"object","properties":{"user_id":{"title":"User Id","type":"integer"},"email":{"title":"Email","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"tier":{"title":"Tier","type":"string"},"is_admin":{"title":"Is Admin","type":"boolean"},"company_id":{"title":"Company Id","type":"integer"},"company":{"title":"Company","type":"string"},"nombre":{"title":"Nombre","type":"string"},"apellido":{"title":"Apellido","type":"string"},"auth0_id":{"title":"Auth0 Id","type":"string"},"telefono":{"title":"Telefono","type":"string"},"colores":{"title":"Colores","type":"string"},"idioma":{"title":"Idioma","type":"string"},"activo":{"title":"Activo","type":"string"}}},"UserProfile":{"title":"UserProfile","required":["id","name","is_active"],"type":"object","properties":{"id":{"title":"Id","type":"integer"},"name":{"title":"Name","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"stripe_id":{"title":"Stripe Id","type":"string"}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"ValuationData":{"title":"ValuationData","required":["prediction_formatted","prediction","prediction_m2","postal_code"],"type":"object","properties":{"prediction_formatted":{"title":"Prediction Formatted","type":"string"},"prediction":{"title":"Prediction","type":"number"},"prediction_m2":{"title":"Prediction M2","type":"number"},"postal_code":{"title":"Postal Code","type":"string"}},"example":{"prediction_formatted":"659,682€","prediction":659681.85,"prediction_m2":8795.758,"postal_code":"28010"}},"ValuationInput":{"title":"ValuationInput","required":["cadastre_reference"],"type":"object","properties":{"cadastre_reference":{"title":"Cadastre Reference","maxLength":20,"minLength":20,"type":"string"}},"example":{"cadastre_reference":"0863905VK4706D0010LW"}},"ValuationOutput":{"title":"ValuationOutput","required":["valuation_buy","valuation_rent"],"type":"object","properties":{"valuation_buy":{"$ref":"#/components/schemas/ValuationData"},"valuation_rent":{"$ref":"#/components/schemas/ValuationData"}}},"ValuationRequest":{"title":"ValuationRequest","required":["operation","asset_data"],"type":"object","properties":{"operation":{"title":"Operation","type":"string"},"address":{"title":"Address","type":"string"},"asset_data":{"$ref":"#/components/schemas/AssetData"}}},"app__schemas__comparable_schemas__DateRange":{"title":"DateRange","type":"object","properties":{"start_date":{"title":"Start Date","type":"string","format":"date-time","default":"2019-01-01T00:00:00"},"end_date":{"title":"End Date","type":"string","format":"date-time","default":"2026-07-03T00:00:00"}},"description":"Date range for the API"},"app__schemas__demographics_schemas__MetricsOutput":{"title":"MetricsOutput","required":["weighted_metrics","province_average","compared_province","compared_spain","valuation","valuation_aux"],"type":"object","properties":{"weighted_metrics":{"title":"Weighted Metrics","type":"string"},"kpis":{"title":"Kpis","type":"string","default":""},"values":{"title":"Values","type":"number","default":0},"province_average":{"title":"Province Average","type":"number"},"compared_province":{"title":"Compared Province","type":"string"},"compared_spain":{"title":"Compared Spain","type":"string"},"valuation":{"title":"Valuation","type":"string"},"valuation_aux":{"title":"Valuation Aux","type":"string"}},"example":{"weighted_metrics":"Renta por hogar","kpis":"34,156.00 €","values":34156,"province_average":40178.1661,"compared_province":"-14.99% ","compared_spain":"+15.24%","valuation":"Muy alto","valuation_aux":"very_high"}},"app__schemas__market_place_schemas__DateRange":{"title":"DateRange","type":"object","properties":{"start_date":{"title":"Start Date","type":"string","format":"date-time","default":"2020-03-01T00:00:00"},"end_date":{"title":"End Date","type":"string","format":"date-time","default":"2026-07-03T00:00:00"}},"description":"Date range for the API"},"app__schemas__market_schemas__MetricsOutput":{"title":"MetricsOutput","required":["title","value","variation","format"],"type":"object","properties":{"title":{"title":"Title","type":"string"},"variable":{"title":"Variable","type":"string"},"value":{"title":"Value","type":"number"},"variation":{"title":"Variation","type":"number"},"format":{"title":"Format","type":"string"}},"example":{"title":"Average price","variable":"price","value":100000,"variation":1.64,"format":"currency"}},"app__schemas__newsroom_schemas__DataOut":{"title":"DataOut","required":["data","total_news"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/News"}},"total_news":{"title":"Total News","type":"integer"}}},"app__schemas__newsroom_schemas__DateRange":{"title":"DateRange","type":"object","properties":{"from_date":{"title":"From Date","type":"string","format":"date"},"to_date":{"title":"To Date","type":"string","format":"date"}}},"app__schemas__user_schemas__DataOut":{"title":"DataOut","required":["data","total"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/Portfolio"}},"total":{"title":"Total","type":"integer"}}}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"login"}}}}},"tags":[{"name":"Valuation","description":"Operations related to property valuation. This includes endpoints for obtaining buy and rent valuations based on provided property details."},{"name":"Cadastre data","description":"Operations related to the cadastre. This includes endpoints for obtaining property details based on the provided cadastre reference."},{"name":"Demographics data","description":"Operations related to demographics. This includes endpoints for obtaining demographic data based on the provided location."},{"name":"Demand data","description":"Operations related to demand data. This includes endpoints for obtaining demand data based on the provided location and property details."},{"name":"Comparable data","description":"Operations related to comparable data. This includes endpoints for obtaining comparable data based on the provided property details."},{"name":"Comparable V2 data","description":"Operations related to comparable data. This includes endpoints for obtaining comparable data based on the provided property details."},{"name":"Market data","description":"Operations related to market data. This includes endpoints for obtaining general metrics, absorption metrics, asking closing trends, and charts."},{"name":"Fragua AI","description":"Operations related to Fragua AI. This includes endpoints to chat with Fragua AI."}]}