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

Kyero Agency Profile API Documentation

GET https://scrappa.co/api/kyero/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222

Scrappa's GET /api/kyero/agent returns the public profile of one Kyero estate agency. Send the path from the agency directory, or id, slug and country.

What you get

agent has the name, logo, cover photo, about text, languages, address, town-level position, team members with job titles, services, member_since, listing counts and portfolios (price range, typical bedrooms and the places where the agency lists). properties_for_sale and properties_to_rent give a preview of the first listings with the real total in count.

Listing preview

Kyero shows only the first listings on the profile page. The preview cannot be paged. Use the search endpoint to browse inventory.

Contact details

Phone and WhatsApp numbers are hidden by Kyero and are not returned. has_telephone and has_whatsapp tell you whether the agency offers them.

Kyero Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/kyero/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "country": "es",
    "agent": {
        "id": 14222,
        "name": "Roccabox Property Group",
        "slug": "roccabox-property-group",
        "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/14/14222.jpg",
        "cover_photo_url": "https://img.kyero.com/crop/800x256/agents/cover-photos/14/14222.jpg",
        "about": "Award-winning luxury real estate agency on the Costa del Sol.",
        "languages": [
            "en",
            "da",
            "de",
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

4 optional filters available.

path string Optional

Profile path from the agency directory, for example /en/spain/estate-agents/profile/roccabox-property-group-a14222. Or send id, slug and country.

Example value /en/spain/estate-agents/profile/roccabox-property-group-a14222
id integer Optional

Agency id. Send with slug and country when no path is used.

Example value 1234567890
slug string Optional

Agency slug, for example roccabox-property-group.

Example value example
country string Optional

es, pt, it or fr.

Example value US

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/kyero/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222",
    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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222');

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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222', 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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222',
    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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222")
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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222", 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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222', 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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222")
        .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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222", 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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222"
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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222"));
            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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222',
            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/agent?path=%2Fen%2Fspain%2Festate-agents%2Fprofile%2Froccabox-property-group-a14222")
        .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 agent properties_for_sale properties_to_rent meta
JSON Response
200 OK
{
    "success": true,
    "country": "es",
    "agent": {
        "id": 14222,
        "name": "Roccabox Property Group",
        "slug": "roccabox-property-group",
        "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/14/14222.jpg",
        "cover_photo_url": "https://img.kyero.com/crop/800x256/agents/cover-photos/14/14222.jpg",
        "about": "Award-winning luxury real estate agency on the Costa del Sol.",
        "languages": [
            "en",
            "da",
            "de",
            "es"
        ],
        "has_telephone": true,
        "has_whatsapp": true,
        "address": {
            "street": "Calle Los Jazmines 468, Nueva Andaluc\u00eda",
            "town": "Marbella",
            "region": "M\u00e1laga",
            "postcode": "29660",
            "country": "Spain",
            "formatted": "Calle Los Jazmines 468, Nueva Andaluc\u00eda, Marbella, 29660, M\u00e1laga, Spain"
        },
        "team_members": [
            {
                "id": 4708,
                "name": "Paola Ruiz",
                "job_title": "Property Consultant",
                "languages": [
                    "en",
                    "es"
                ],
                "image_url": "https://img.kyero.com/fit/340x320/agents/team-member-photos/4/4708.jpg"
            }
        ],
        "member_since": 2020,
        "for_sale_count": 1461,
        "long_term_rent_count": 0,
        "path": "/en/spain/estate-agents/profile/roccabox-property-group-a14222"
    },
    "properties_for_sale": {
        "count": 1461,
        "returned": 8,
        "items": [
            {
                "id": 21361013,
                "name": "Apartment in Marbella, Malaga",
                "price": 350000,
                "price_formatted": "\u20ac 350,000",
                "payment_scheme": "for_sale",
                "reference_no": "EI-AC2137",
                "location_id": 31673,
                "property_type": {
                    "id": 1,
                    "key": "apartment",
                    "group_id": 1
                },
                "bedrooms": 3,
                "bathrooms": 2,
                "built_m2": 100,
                "plot_m2": 0,
                "short_description": "Discover a collection of 34 extraordinary apartments and penthouses...",
                "images": [
                    "https://img.kyero.com/crop/960x720/properties/21361/21361013/428410368.jpg"
                ],
                "images_count": 31,
                "feature_keys": [
                    "garage",
                    "lift",
                    "terrace",
                    "pool",
                    "new_build"
                ],
                "badges": [
                    "video_tour",
                    "remote_viewing"
                ],
                "primary_badge": "new_build",
                "featured": false,
                "virtual_tour_url": null,
                "video_url": "https://vimeo.com/1025703918",
                "remote_viewing_enabled": true,
                "agent": {
                    "id": 14222,
                    "name": "Example Agency",
                    "logo_url": "https://img.kyero.com/fit/125x125/agents/logos/14/14222.jpg",
                    "type": "2",
                    "prime": true,
                    "path": "/en/spain/estate-agents/profile/example-agency-a14222",
                    "url": "https://www.kyero.com/en/spain/estate-agents/profile/example-agency-a14222"
                },
                "path": "/en/property/21361013-apartment-for-sale-marbella",
                "url": "https://www.kyero.com/en/property/21361013-apartment-for-sale-marbella"
            }
        ]
    },
    "properties_to_rent": {
        "count": 0,
        "returned": 0,
        "items": []
    },
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "agent"
    }
}

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": "agent"
    },
    "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": "agent"
    },
    "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.