Scrappa's GET /api/kyero/agents lists the estate agencies of one Kyero location, 20 per page.
What you get
Each agency has id, name, slug, logo_url, a short about text, languages, for_sale_count, long_term_rent_count, prime and the path that the agent endpoint takes. pagination has page, pages and count.
Country
Send country together with the location. It must be the country of the location. Take it from agents_country in the autocomplete response. A mismatch fails without a charge.
Contact details
Agency phone numbers and WhatsApp numbers are hidden on Kyero and are not returned.
Pagination
page runs from 1 to 50. The response never returns one page's data under another page number.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
3 required parameters needed before sending a request.
1 optional filter available.
string
Required
es, pt, it or fr. Must match the location.
es
integer
Required
Location id from the autocomplete endpoint.
31673
string
Required
Location slug from the autocomplete endpoint.
marbella
integer
Optional
Result page, 1 to 50.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=marbella');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=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
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/agents?country=es&location_id=31673&location_slug=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()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=marbella', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/agents?country=es&location_id=31673&location_slug=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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=marbella"
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/agents?country=es&location_id=31673&location_slug=marbella"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/kyero/agents?country=es&location_id=31673&location_slug=marbella',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/agents?country=es&location_id=31673&location_slug=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
location
agents
pagination
title
meta
Common agents fields
id
name
logo_url
type
{
"success": true,
"country": "es",
"location": {
"id": 31673,
"slug": "marbella",
"name": "Marbella"
},
"agents": [
{
"id": 24939,
"name": "Holdsworth Estates",
"logo_url": "https://img.kyero.com/fit/125x125/agents/logos/24/24939.jpg",
"type": null,
"prime": true,
"path": "/en/spain/estate-agents/profile/holdsworth-estates-a24939",
"url": "https://www.kyero.com/en/spain/estate-agents/profile/holdsworth-estates-a24939",
"slug": "holdsworth-estates",
"status": "live",
"about": "We are partners on the journey to the perfect property on the Costa del Sol.",
"languages": [
"en",
"es"
],
"for_sale_count": 28,
"long_term_rent_count": null
}
],
"pagination": {
"page": 1,
"pages": 5,
"count": 97,
"max_pages": 50,
"has_next": true
},
"title": "Estate agents in Marbella",
"meta": {
"billable": true,
"attempts": 1,
"last_status": 200,
"endpoint_family": "agents"
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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."
}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": "agents"
},
"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.