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

Yaencontre Filters

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

Returns the live facet groups and price bands available for an operation, family and location, including the total item count for the combination. The origin refuses this path without a geography, so location is required. Use it to discover which filter values are available before running a search.

Yaencontre Filters 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yaencontre/filters?operation=BUY&family=FLAT&location=madrid
Auth header
x-api-key
Cost
1 credit/request
location = madrid
Response preview
200 OK
{
    "success": true,
    "data": {
        "total_items": 17912,
        "options": {
            "priceRange": [
                {
                    "min": 0,
                    "max": 100000
                },
                {
                    "min": 100000,
                    "max": 200000
                },
...

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.

2 optional filters available.

location string Required

Location to scope the facet counts to, as a plain place name such as madrid. Required; the origin refuses this path without a geography.

Example value madrid
operation string Optional

BUY, RENT, or TRANSFER. Default BUY.

Example value BUY
family string Optional

Property type. Default FLAT.

Example value FLAT

Request Examples

PHP
<?php

$curl = curl_init();

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

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/filters?operation=BUY&family=FLAT&location=madrid', 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/filters?operation=BUY&family=FLAT&location=madrid',
    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/filters?operation=BUY&family=FLAT&location=madrid")
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/filters?operation=BUY&family=FLAT&location=madrid", 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/filters?operation=BUY&family=FLAT&location=madrid', 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/filters?operation=BUY&family=FLAT&location=madrid")
        .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/filters?operation=BUY&family=FLAT&location=madrid", 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/filters?operation=BUY&family=FLAT&location=madrid"
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/filters?operation=BUY&family=FLAT&location=madrid"));
            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/filters?operation=BUY&family=FLAT&location=madrid',
            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/filters?operation=BUY&family=FLAT&location=madrid")
        .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,
        "options": {
            "priceRange": [
                {
                    "min": 0,
                    "max": 100000
                },
                {
                    "min": 100000,
                    "max": 200000
                },
                {
                    "min": 200000,
                    "max": 400000
                }
            ],
            "rooms": [
                {
                    "value": 1,
                    "count": 3200
                },
                {
                    "value": 2,
                    "count": 5400
                },
                {
                    "value": 3,
                    "count": 4800
                }
            ],
            "family": [
                {
                    "value": "FLAT",
                    "count": 15000
                },
                {
                    "value": "HOUSE",
                    "count": 2912
                }
            ]
        }
    }
}

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.