Web-page view of https://agent.index.cy/api/meta for tools that read pages and follow links. The text below is the complete answer; every address in it is a link you can open. Command-line tools get the raw form.
{
"search": "GET https://agent.index.cy/api/listings",
"parameters": {
"deal": {
"label": "Buy or rent",
"values": [
"sale",
"rent"
],
"default": "sale"
},
"district": {
"label": "District",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "famagusta",
"label": "Famagusta"
},
{
"value": "larnaca",
"label": "Larnaca"
},
{
"value": "limassol",
"label": "Limassol"
},
{
"value": "nicosia",
"label": "Nicosia"
},
{
"value": "paphos",
"label": "Paphos"
}
]
},
"location": {
"label": "Town, village or area",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values_from": "GET https://agent.index.cy/api/locations?q=<name> (several hundred places; use the `slug` it returns)"
},
"property_type": {
"label": "Property type",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "apartment",
"label": "Apartment"
},
{
"value": "building",
"label": "Building"
},
{
"value": "house",
"label": "House"
},
{
"value": "land-plots",
"label": "Land and Plots"
},
{
"value": "office",
"label": "Office"
},
{
"value": "commercial",
"label": "Other Commercial"
}
]
},
"bedrooms": {
"label": "Bedrooms",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "studio",
"label": "Studio"
},
{
"value": "1",
"label": "1"
},
{
"value": "2",
"label": "2"
},
{
"value": "3",
"label": "3"
},
{
"value": "4",
"label": "4"
},
{
"value": "5",
"label": "5"
},
{
"value": "6",
"label": "6+"
}
]
},
"bathrooms": {
"label": "Bathrooms",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "1",
"label": "1"
},
{
"value": "2",
"label": "2"
},
{
"value": "3",
"label": "3"
},
{
"value": "4",
"label": "4"
},
{
"value": "5",
"label": "5+"
}
]
},
"condition": {
"label": "Condition",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "brand-new",
"label": "Brand New"
},
{
"value": "pre-owned",
"label": "Pre-Owned"
},
{
"value": "under-construction",
"label": "Under Construction"
}
]
},
"year_built": {
"label": "Year built",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "1990-and-older",
"label": "1990 and older"
},
{
"value": "1991-2000",
"label": "1991-2000"
},
{
"value": "2001-2010",
"label": "2001-2010"
},
{
"value": "2009",
"label": "2009"
},
{
"value": "2011",
"label": "2011"
},
{
"value": "2012",
"label": "2012"
},
{
"value": "2013",
"label": "2013"
},
{
"value": "2014",
"label": "2014"
},
{
"value": "2015",
"label": "2015"
},
{
"value": "2016",
"label": "2016"
},
{
"value": "2017",
"label": "2017"
},
{
"value": "2018",
"label": "2018"
},
{
"value": "2019",
"label": "2019"
},
{
"value": "2020",
"label": "2020"
},
{
"value": "2021",
"label": "2021"
},
{
"value": "2022",
"label": "2022"
},
{
"value": "2023",
"label": "2023"
},
{
"value": "2024",
"label": "2024"
},
{
"value": "2025",
"label": "2025"
},
{
"value": "2026",
"label": "2026"
},
{
"value": "2027",
"label": "2027"
},
{
"value": "2028",
"label": "2028"
},
{
"value": "2029",
"label": "2029"
},
{
"value": "2030",
"label": "2030"
}
]
},
"energy_class": {
"label": "Energy class",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "a",
"label": "A"
},
{
"value": "a-plus",
"label": "A+"
},
{
"value": "b",
"label": "B"
},
{
"value": "b-plus",
"label": "B+"
},
{
"value": "c",
"label": "C"
},
{
"value": "d",
"label": "D"
},
{
"value": "e",
"label": "E"
}
]
},
"furnishing": {
"label": "Furnishing",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "furnished",
"label": "Furnished"
},
{
"value": "partially-furnished",
"label": "Partially furnished"
},
{
"value": "unfurnished",
"label": "Unfurnished"
}
]
},
"pool": {
"label": "Pool",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "common",
"label": "Common"
},
{
"value": "no",
"label": "No"
},
{
"value": "private",
"label": "Private"
},
{
"value": "yes",
"label": "Yes"
}
]
},
"parking": {
"label": "Parking",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "covered",
"label": "Covered"
},
{
"value": "no",
"label": "No"
},
{
"value": "uncovered",
"label": "Uncovered"
},
{
"value": "yes",
"label": "Yes"
}
]
},
"heating": {
"label": "Heating",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "autonomous-heating",
"label": "Autonomous Heating"
},
{
"value": "central-heating",
"label": "Central Heating"
},
{
"value": "no",
"label": "No"
},
{
"value": "radiators",
"label": "Radiators"
},
{
"value": "underfloor-heating",
"label": "Underfloor Heating"
},
{
"value": "yes",
"label": "Yes"
}
]
},
"air_conditioning": {
"label": "Air conditioning",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "all-rooms",
"label": "All rooms"
},
{
"value": "no",
"label": "No"
},
{
"value": "partial",
"label": "Partial"
},
{
"value": "yes",
"label": "Yes"
}
]
},
"amenities": {
"label": "Amenities",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "air-conditioning",
"label": "Air Conditioning"
},
{
"value": "alarm",
"label": "Alarm"
},
{
"value": "balcony",
"label": "Balcony"
},
{
"value": "bbq-zone",
"label": "BBQ zone"
},
{
"value": "bike-parking",
"label": "Bike Parking"
},
{
"value": "elevator",
"label": "Elevator"
},
{
"value": "fireplace",
"label": "Fireplace"
},
{
"value": "garden",
"label": "Garden"
},
{
"value": "guest-wc",
"label": "Guest WC"
},
{
"value": "gym",
"label": "Gym"
},
{
"value": "heating",
"label": "Heating"
},
{
"value": "parking",
"label": "Parking"
},
{
"value": "pool",
"label": "Pool"
},
{
"value": "roof-garden",
"label": "Roof Garden"
},
{
"value": "spasauna",
"label": "Spa/Sauna"
},
{
"value": "storage-room",
"label": "Storage room"
}
]
},
"view": {
"label": "View",
"applies_to": [
"sale"
],
"multiple": true,
"values": [
{
"value": "city-view",
"label": "City view"
},
{
"value": "mountains-view",
"label": "Mountains view"
},
{
"value": "sea-view",
"label": "Sea view"
}
]
},
"pets": {
"label": "Pets",
"applies_to": [
"rent"
],
"multiple": true,
"values": [
{
"value": "allowed",
"label": "Allowed"
},
{
"value": "not-allowed",
"label": "Not allowed"
}
]
},
"seller_type": {
"label": "Seller type",
"applies_to": [
"sale",
"rent"
],
"multiple": true,
"values": [
{
"value": "agency",
"label": "Agency"
},
{
"value": "developer",
"label": "Developer"
},
{
"value": "property-owner",
"label": "Property Owner"
}
]
},
"price_min": {
"label": "Lowest price, whole euros (per month for rent)",
"type": "integer"
},
"price_max": {
"label": "Highest price, whole euros (per month for rent)",
"type": "integer"
},
"area_min": {
"label": "Smallest covered area, m2",
"type": "integer"
},
"area_max": {
"label": "Largest covered area, m2",
"type": "integer"
},
"plot_min": {
"label": "Smallest plot, m2",
"type": "integer"
},
"plot_max": {
"label": "Largest plot, m2",
"type": "integer"
},
"near": {
"label": "Around a point: lat,lng. Only matches listings that have coordinates",
"example": "34.707,33.022"
},
"radius_km": {
"label": "Radius for `near`, default 2, at most 100",
"type": "number"
},
"bbox": {
"label": "Rectangle: sw_lat,sw_lng,ne_lat,ne_lng",
"example": "34.66,32.98,34.74,33.12"
},
"good_deal": {
"label": "Only homes priced clearly below comparable ones",
"applies_to": [
"sale"
],
"values": [
"1"
]
},
"listed_within_days": {
"label": "Only listings first published in the last N days",
"type": "integer"
},
"q": {
"label": "Free text in title and description, up to 100 characters. Use filters first",
"type": "string"
},
"project_id": {
"label": "Listings inside one new-build project",
"type": "integer"
},
"company_id": {
"label": "Listings of one agency or developer",
"type": "integer",
"applies_to": [
"sale"
]
},
"sort": {
"label": "Order of results",
"values": {
"sale": [
"recommended",
"newest",
"price_asc",
"price_desc",
"area_asc",
"area_desc",
"price_m2_asc",
"price_m2_desc"
],
"rent": [
"recommended",
"newest",
"price_asc",
"price_desc",
"area_asc",
"area_desc"
]
},
"default": {
"sale": "recommended",
"rent": "newest"
}
},
"limit": {
"label": "Results per page",
"type": "integer",
"default": 10,
"max": 25
},
"cursor": {
"label": "Value of next_cursor from the previous page, with the same filters"
},
"detail": {
"label": "summary (default), or full for everything about each result (at most 10 per page)",
"values": [
"summary",
"full"
]
}
},
"limits": {
"requests_per_hour": 30,
"requests_counted_per": "IP address (the instruction files are free)",
"results_per_page": 10,
"results_reachable_per_search": 500
},
"units": {
"price": "EUR, whole euros; per month for rent",
"area": "square metres"
},
"docs": "https://agent.index.cy/agent.md"
}