Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"sort": {
"enum": [
"newest",
"price-low",
"price-high",
"size"
],
"type": "string",
"description": "Result order; default newest on the market first"
},
"text": {
"type": "string",
"maxLength": 100,
"description": "Free text matched against street address, town and region, or a 3-digit postcode"
},
"types": {
"type": "array",
"items": {
"enum": [
"APARTMENT",
"FLOOR",
"SEMI_DETACHED",
"TOWNHOUSE",
"DETACHED",
"SUMMER_HOUSE",
"COMMERCIAL",
"LAND"
],
"type": "string"
},
"maxItems": 8,
"description": "Property types; any of them matches"
},
"cursor": {
"type": "string",
"maxLength": 200,
"description": "nextCursor from the previous page, for the next one"
},
"nearby": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"withinMeters"
],
"properties": {
"kind": {
"enum": [
"school",
"kindergarten",
"grocery",
"bus_stop"
],
"type": "string"
},
"withinMeters": {
"anyOf": [
{
"type": "number",
"const": 300
},
{
"type": "number",
"const": 500
},
{
"type": "number",
"const": 1000
},
{
"type": "number",
"const": 2000
}
]
}
}
},
"maxItems": 4,
"description": "Each result must have a place of this kind within this straight-line distance"
},
"areaIds": {
"type": "array",
"items": {
"type": "string",
"maxLength": 150
},
"maxItems": 250,
"description": "Area IDs from find_areas; matches listings inside any of them"
},
"maxSize": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Maximum size in m²"
},
"maxYear": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Built in this year or earlier"
},
"minSize": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Minimum size in m²"
},
"minYear": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Built in this year or later"
},
"maxPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Maximum asking price in ISK"
},
"minPrice": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Minimum asking price in ISK"
},
"minRooms": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Minimum number of rooms"
},
"amenities": {
"type": "array",
"items": {
"enum": [
"has_parking",
"has_garage",
"has_balcony",
"has_garden",
"has_elevator",
"has_laundry_room",
"has_view",
"has_wheelchair_access",
"available_right_away",
"has_extra_apartment",
"is_for_older_people"
],
"type": "string"
},
"maxItems": 11,
"description": "Features every result must have"
},
"minBedrooms": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Minimum number of bedrooms"
},
"minBathrooms": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Minimum number of bathrooms"
},
"maxPricePerM2": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Maximum asking price per m² in ISK"
},
"listedWithinDays": {
"type": "integer",
"maximum": 36500,
"minimum": 0,
"description": "Only properties on the market for at most this many days"
},
"includePriceOnRequest": {
"type": "boolean",
"description": "Include listings without an asking price (offers invited); default true"
}
}
}