APIs / Kyero / Search

Kyero: Search

Search from Kyero as JSON. 1 credit per successful call.

GET /v1/kyero/search

Parameters

Send parameters in the query string.

ParameterTypeRequiredAllowed values
location_idintegerRequiredAny
location_slugstringRequiredUp to 120 characters
operationstringOptionalsale, rent
property_typestringOptionalany, apartments, villas
min_priceintegerOptionalAny
max_priceintegerOptionalAny
min_bedsintegerOptionalAny
max_bedsintegerOptionalAny
min_bathsintegerOptionalAny
max_bathsintegerOptionalAny
min_build_sizeintegerOptionalAny
max_build_sizeintegerOptionalAny
featuresstringOptionalAny
new_buildstringOptionaltrue, false, 1, 0
resale_onlystringOptionaltrue, false, 1, 0
sortstringOptionalprice_asc, price_desc, newest
pageintegerOptionalAny

Example request

Kyero
GET/v1/kyero/search?location_id=31673&location_slug=marbella&operation=sale&max_price=500000&min_beds=3&sort=price_asc
{
  "success": true,
  "location": {
    "id": 31673,
    "name": "Marbella",
    "slug": "marbella",
    "type": "City",
    "name_with_country": "Marbella, Spain",
    "nation_id": 55529,
    "country": "es",
    "latitude": 36.50978,
    "longitude": -4.88525,
    "cover_image_url": "https://img.kyero.com/crop/480x320/locations/cover_images/31673_shutterstock_153173057.jpg",
    "guide_url": "https://www.kyero.com/en/advice/spain/places-to-live/marbella-0l31673",
    "hierarchy": [
      {
        "id": 55625,
        "name": "Costa Del Sol",
        "slug": "costa-del-sol",
        "type": "Costa"
      },
      {
        "id": 29,
        "name": "Malaga",
        "slug": "malaga",
        "type": "Province"
      },
      {
        "id": 55531,
        "name": "Andalucia",
        "slug": "andalucia",
        "type": "Region"
      }
    ]
  },
  "operation": "sale",
  "applied_filters": {
    "operation": "sale",
    "property_type": "any",
    "sort": "price_asc",
    "max_price": 500000,
    "min_beds": 3
  },
  "listings": [
    {
      "id": 21159255,
      "name": "Mobile home in Marbella, Malaga",
      "price": 90342,
      "price_formatted": "€ 90,342",
      "payment_scheme": "for_sale",
      "reference_no": "CITS_114877-Trigano Authentique, Plot 31",
      "location_id": 31673,
      "property_type": {
        "id": 33,
        "key": "mobile home",
        "group_id": 9
      },
      "bedrooms": 3,
      "bathrooms": 2,
      "built_m2": 0,
      "plot_m2": 0,
      "short_description": ".",
      "images": [
        "https://img.kyero.com/crop/960x720/properties/21159/21159255/426489970.jpg",
        "https://img.kyero.com/crop/960x720/properties/21159/21159255/426489971.jpg",
        "https://img.kyero.com/crop/960x720/properties/21159/21159255/426489972.jpg"
      ],
      "images_count": 39,
      "feature_keys": [
        "resale_only"
      ],
      "featured": false,
      "remote_viewing_enabled": false,
      "agent": {
        "id": 11295,
        "name": "Caravans in the Sun",
        "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/11/11295.jpg?checksum=bca97fce7bbe394517220b7837047805",
        "type": "2",
        "prime": true,
        "path": "/en/spain/estate-agents/profile/caravans-in-the-sun-a11295",
        "url": "https://www.kyero.com/en/spain/estate-agents/profile/caravans-in-the-sun-a11295"
      },
      "path": "/en/property/21159255-wooden-home-for-sale-marbella",
      "url": "https://www.kyero.com/en/property/21159255-wooden-home-for-sale-marbella"
    },
    {
      "id": 16939965,
      "name": "Apartment in Marbella, Malaga",
      "price": 233000,
      "price_formatted": "€ 233,000",
      "payment_scheme": "for_sale",
      "reference_no": "DPIe3446",
      "location_id": 31673,
      "property_type": {
        "id": 1,
        "key": "apartment",
        "group_id": 1
      },
      "bedrooms": 3,
      "bathrooms": 2,
      "built_m2": 110,
      "plot_m2": 0,
      "short_description": "Exclusive property Three bedroom apartment located on the first floor in a beautiful urbanization in Parque Elviria with community pool and garden...",
      "images": [
        "https://img.kyero.com/crop/960x720/properties/16939/16939965/309779479.jpg",
        "https://img.kyero.com/crop/960x720/properties/16939/16939965/309779480.jpg",
        "https://img.kyero.com/crop/960x720/properties/16939/16939965/309779483.jpg"
      ],
      "images_count": 16,
      "feature_keys": [
        "parking",
        "terrace",
        "garden"
      ],
      "primary_badge": "near_shops",
      "featured": false,
      "remote_viewing_enabled": false,
      "agent": {
        "id": 4533,
        "name": "dpi direct property investments",
        "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/4/4533.jpg?checksum=de1d097ef4b5f731498ea4d60d180243",
        "type": "2",
        "prime": true,
        "path": "/en/spain/estate-agents/profile/dpi-direct-property-investments-a4533",
        "url": "https://www.kyero.com/en/spain/estate-agents/profile/dpi-direct-property-investments-a4533"
      },
      "path": "/en/property/16939965-apartment-for-sale-marbella",
      "url": "https://www.kyero.com/en/property/16939965-apartment-for-sale-marbella"
    },
    {
      "id": 12104443,
      "name": "Apartment in Marbella, Malaga",
      "price": 269000,
      "price_formatted": "€ 269,000",
      "payment_scheme": "for_sale",
      "reference_no": "DPIe1797",
      "location_id": 31673,
      "property_type": {
        "id": 1,
        "key": "apartment",
        "group_id": 1
      },
      "bedrooms": 3,
      "bathrooms": 2,
      "built_m2": 148,
      "plot_m2": 0,
      "short_description": "Luxury complex of 46 contemporary apartments with breathtaking sea views. Located in Manilva, only 15 minutes from Marbella and Puerto Banus and o...",
      "images": [
        "https://img.kyero.com/crop/960x720/properties/12104/12104443/218276062.jpg",
        "https://img.kyero.com/crop/960x720/properties/12104/12104443/218276063.jpg",
        "https://img.kyero.com/crop/960x720/properties/12104/12104443/218276064.jpg"
      ],
      "images_count": 10,
      "feature_keys": [
        "pool",
        "resale_only"
      ],
      "featured": false,
      "remote_viewing_enabled": false,
      "agent": {
        "id": 4533,
        "name": "dpi direct property investments",
        "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/4/4533.jpg?checksum=de1d097ef4b5f731498ea4d60d180243",
        "type": "2",
        "prime": true,
        "path": "/en/spain/estate-agents/profile/dpi-direct-property-investments-a4533",
        "url": "https://www.kyero.com/en/spain/estate-agents/profile/dpi-direct-property-investments-a4533"
      },
      "path": "/en/property/12104443-apartment-for-sale-marbella",
      "url": "https://www.kyero.com/en/property/12104443-apartment-for-sale-marbella"
    }
  ],
  "pagination": {
    "page": 1,
    "pages": 8,
    "per_page": 20,
    "count": 156,
    "reachable": 156,
    "max_pages": 50,
    "has_next": true
  },
  "available_filters": {
    "price": [
      50000,
      75000,
      100000
    ],
    "beds": [
      1,
      2,
      3
    ],
    "baths": [
      1,
      2,
      3
    ],
    "build_size": [
      50,
      100,
      150
    ],
    "features": [
      "pool",
      "garage",
      "terrace"
    ],
    "location_features": [
      "near_beach",
      "near_shops",
      "near_golf"
    ],
    "multimedia": [
      "remote_viewing",
      "video",
      "virtual_tour"
    ]
  },
  "alternate_searches": {
    "locations_nearby": [
      {
        "label": "Estepona",
        "location_id": 31466,
        "location_slug": "estepona",
        "path": "/en/estepona-property-for-sale-0l31466"
      },
      {
        "label": "Mijas",
        "location_id": 31695,
        "location_slug": "mijas",
        "path": "/en/mijas-property-for-sale-0l31695"
      },
      {
        "label": "Fuengirola",
        "location_id": 31480,
        "location_slug": "fuengirola",
        "path": "/en/fuengirola-property-for-sale-0l31480"
      }
    ],
    "top_property_types": [
      {
        "label": "Properties for sale in Marbella",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      },
      {
        "label": "Apartments for sale in Marbella",
        "path": "/en/marbella-apartments-for-sale-0l31673g1"
      },
      {
        "label": "Villas for sale in Marbella",
        "path": "/en/marbella-villas-for-sale-0l31673g2"
      }
    ],
    "explore": [
      {
        "label": "Cheap properties",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      },
      {
        "label": "Luxury properties",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      },
      {
        "label": "New build properties",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      }
    ],
    "beds": [
      {
        "label": "1 bedroom",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      },
      {
        "label": "2 bedroom",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      },
      {
        "label": "3 bedroom",
        "location_id": 31673,
        "location_slug": "marbella",
        "path": "/en/marbella-property-for-sale-0l31673"
      }
    ]
  },
  "title": "Properties for sale in Marbella",
  "meta": {
    "attempts": 1,
    "last_status": 200,
    "endpoint_family": "search",
    "dropped_by_guard": 0,
    "request_id": "req_b259b0d89b424178ae58eb869b16bf9d",
    "credits_charged": 1,
    "credits_remaining": 1853
  }
}
200 OKJSONX-Credits-Used: 1
Recorded from our API and shortened.

Run this endpoint in the playground with your own parameters. 1 credit per successful call; failed calls are free.