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

Yaencontre Search

GET https://scrappa.co/api/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2

Searches sale, rental, vacation rental, new construction and transfer stock. This is also the agency-pages surface: pass real_estate_agency_id and the response carries both the agency stock and the agency profile. Geography can be scoped with an autocomplete location token or with a lat_min/lat_max/lon_min/lon_max box.

Yaencontre Search 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "total_items": 17912,
        "num_pages": 896,
        "current_page": 1,
        "title": "17.912 Pisos y viviendas en venta en Madrid",
        "location": {
            "name": "Madrid",
            "value": "madrid"
        },
        "items": [
            {
                "reference": "66504-112724772",
...

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.

16 optional filters available.

operation string Optional

BUY, RENT, or TRANSFER. Default BUY.

Example value BUY
family string Optional

FLAT, HOUSE, GARAGE, LAND, NEW_CONSTRUCTION, OFFICE, HOME, BUILDING, or BUSINESS. Default FLAT. BUSINESS requires operation=TRANSFER. Under RENT, HOME returns both long-term and seasonal stock unless rental_type narrows it.

Example value FLAT
location string Optional

Location token from the autocomplete endpoint, for example madrid.

Example value madrid
real_estate_agency_id integer Optional

Agency identifier from the autocomplete agencies bucket, for example 40524.

Example value 1234567890
min_price integer Optional

Lower price bound in euros. Valid only with operation=BUY.

Example value 10
max_price integer Optional

Upper price bound in euros. Valid only with operation=BUY.

Example value 10
rooms integer Optional

Minimum number of rooms, from 1 to 4. Values outside that range return 422.

Example value 10
bathrooms integer Optional

Minimum number of bathrooms, from 1 to 4. Values outside that range return 422.

Example value 10
rental_type string Optional

LONG_TERM_RENT or SEASONAL_RENT. Valid only with operation=RENT.

Example value example
lat_min number Optional

South edge of the map box. Send with lat_max, lon_min and lon_max.

Example value 10
lat_max number Optional

North edge of the map box.

Example value 10
lon_min number Optional

West edge of the map box.

Example value 10
lon_max number Optional

East edge of the map box.

Example value 10
size integer Optional

Map size hint sent with a bounds box. Default 200.

Example value 10
page_number integer Optional

1-based page number.

Example value 10
page_size integer Optional

Results per page, 1 to 50. Default 50.

Example value 2

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2",
    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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2');

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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2', 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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2',
    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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2")
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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2", 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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2', 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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2")
        .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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2", 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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2"
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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2"));
            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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2',
            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/yaencontre/search?operation=BUY&family=FLAT&location=madrid&page_size=2")
        .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 data
JSON Response
200 OK
{
    "success": true,
    "data": {
        "total_items": 17912,
        "num_pages": 896,
        "current_page": 1,
        "title": "17.912 Pisos y viviendas en venta en Madrid",
        "location": {
            "name": "Madrid",
            "value": "madrid"
        },
        "items": [
            {
                "reference": "66504-112724772",
                "title": "Piso en venta, Palos de Moguer en Arganzuela en Madrid",
                "price": 549000,
                "area": 105,
                "rooms": 2,
                "bathrooms": 2,
                "available": true,
                "advertiser_type": "agency"
            }
        ]
    }
}

Errors

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

Not Found

The requested listing reference does not exist. This response is not billable.

Validation Error

A public parameter is invalid, including rejected property types and transfer-only family pairings. This response is not billable and never reaches the origin.

Service Unavailable

The origin could not serve the request, or no usable network egress was available. This response is not billable; retry shortly.

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.