Skip to content
Scrappa Get API key
Kyero API 1 credit/request

Kyero Property Details API Documentation

GET https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella

Scrappa's GET /api/kyero/property returns the full record of one Kyero listing. Send the path of a search result, or the full kyero.com listing URL.

What you get

property has the price, reference_no, status, new_build, type, rooms, built_m2, plot_m2, the description as description (plain text) and description_html, all images, floorplans, video and virtual tour links, features grouped as Kyero shows them, the location with its parent places, the agent, the date the listing was added, links to the other language versions, and geo with nearby airports, schools, market figures, population and climate of the town.

Contact details

Phone numbers and e-mail addresses are removed, also from the description text. The agent block only has has_telephone and has_whatsapp flags.

Coordinates

Kyero does not publish exact positions. location.latitude and location.longitude are the town centre, and coordinates_precision is town_centroid.

Path format

Use the full path with id and slug, for example /en/property/21361013-apartment-for-sale-marbella. A bare id does not work on Kyero. A prime_boost_id query string is ignored.

Kyero Property Details API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella
Auth header
x-api-key
Cost
1 credit/request
path = /en/property/21361013-apartment-for-sale-marbella
Response preview
200 OK
{
    "success": true,
    "country": "es",
    "property": {
        "id": 21361013,
        "name": "New build apartment in Marbella, Malaga",
        "price": 350000,
        "price_formatted": "\u20ac 350,000",
        "payment_scheme": "for_sale",
        "reference_no": "EI-AC2137",
        "status": "live",
        "new_build": true,
        "property_type": {
            "id": 1,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

path string Required

Listing path from search (/en/property/-) or the full kyero.com URL.

Example value /en/property/21361013-apartment-for-sale-marbella

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/kyero/property?path=%2Fen%2Fproperty%2F21361013-apartment-for-sale-marbella")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success country property meta
JSON Response
200 OK
{
    "success": true,
    "country": "es",
    "property": {
        "id": 21361013,
        "name": "New build apartment in Marbella, Malaga",
        "price": 350000,
        "price_formatted": "\u20ac 350,000",
        "payment_scheme": "for_sale",
        "reference_no": "EI-AC2137",
        "status": "live",
        "new_build": true,
        "property_type": {
            "id": 1,
            "key": "apartment",
            "group_id": 1
        },
        "bedrooms": 3,
        "bathrooms": 2,
        "built_m2": 100,
        "plot_m2": 0,
        "description": "Discover a collection of 34 extraordinary apartments and penthouses...",
        "images": [
            "https://img.kyero.com/crop/480x320/properties/21361/21361013/428410368.jpg"
        ],
        "images_count": 31,
        "floorplans": [],
        "video_url": "https://player.vimeo.com/video/1025703918",
        "features": [
            {
                "key": "pool",
                "name": "Pool",
                "features": [
                    {
                        "key": "pool",
                        "name": "Pool"
                    },
                    {
                        "key": "communal_pool",
                        "name": "Communal pool"
                    }
                ]
            }
        ],
        "location": {
            "id": 31673,
            "name": "Marbella",
            "slug": "marbella",
            "type": "City",
            "province": "Malaga",
            "latitude": 36.50978,
            "longitude": -4.88525
        },
        "coordinates_precision": "town_centroid",
        "agent": {
            "id": 14222,
            "name": "Example Agency",
            "languages": [
                "en",
                "es"
            ],
            "member_since": 2020,
            "for_sale_count": 1461,
            "has_telephone": true,
            "has_whatsapp": true
        },
        "created_at": "2026-09-22T00:42:52Z",
        "alternate_links": [
            {
                "locale": "de",
                "path": "/de/property/21361013-wohnung-kaufen-marbella"
            }
        ],
        "geo": {
            "airports": [
                {
                    "name": "Malaga",
                    "distance_formatted": "39 km"
                }
            ],
            "schools": [],
            "market_info": null,
            "population": null,
            "climate": null
        },
        "path": "/en/property/21361013-apartment-for-sale-marbella",
        "url": "https://www.kyero.com/en/property/21361013-apartment-for-sale-marbella"
    },
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "property"
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

Kyero has no page for this request, for example a listing that is no longer online (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "property"
    },
    "error": {
        "code": "not_found",
        "message": "Kyero has no page for this request."
    },
    "success": false
}
422

Validation Error

A query parameter failed validation, or a path, id or slug is unusable (`invalid_parameter`). Non-billable.

{
    "errors": {
        "country": [
            "The selected country is invalid."
        ]
    },
    "message": "The selected country is invalid."
}
503

Upstream Unavailable

Kyero could not be reached after retries, answered a different page than requested, did not apply the filters, or answered with a body this API cannot read (`upstream_unavailable`, `upstream_blocked`, `pagination_mismatch`, `filter_not_honoured`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true,
        "last_status": 302,
        "endpoint_family": "property"
    },
    "error": {
        "code": "upstream_blocked",
        "message": "Kyero rejected the request from our egress pool. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.