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

Fincaraiz Similar Properties API Documentation

GET https://scrappa.co/api/fincaraiz/similar-properties?id=191347339&rows=6

Scrappa's GET /api/fincaraiz/similar-properties returns comparable listings for a given property, as full listing objects with the same shape as search results.

This is the platform's own similarity engine. It returns whatever it considers comparable — which may include a different property type or price band than the original — so treat the result as a set of neighbours rather than an exact match on your own filters.

An empty list is a valid answer: some listings have no comparables, and that is not an error.

Fincaraiz Similar Properties API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/fincaraiz/similar-properties?id=191347339&rows=6
Auth header
x-api-key
Cost
1 credit/request
id = 191347339
Response preview
200 OK
{
    "success": true,
    "id": 191347339,
    "returned": 2,
    "listings": [
        {
            "id": 191347401,
            "title": "Apartamento en  Venta en Manga, Cartagena",
            "price": {
                "amount": 895000000,
                "currency": "COP"
            },
            "bedrooms": 3,
            "image_count": 9,
...

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.

3 optional filters available.

id string Required

Numeric listing id to find comparables for.

Example value 191347339
rows integer Optional

Maximum comparables to return, 1-50 (default 6).

Example value 6
page integer Optional

Result page, 1-based.

Example value 1
is_project boolean Optional

true to compare against projects rather than individual listings, false (default) for listings. This changes which records are compared, so it changes the result set.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/fincaraiz/similar-properties?id=191347339&rows=6",
    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/fincaraiz/similar-properties?id=191347339&rows=6');

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/fincaraiz/similar-properties?id=191347339&rows=6', 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/fincaraiz/similar-properties?id=191347339&rows=6',
    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/fincaraiz/similar-properties?id=191347339&rows=6")
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/fincaraiz/similar-properties?id=191347339&rows=6", 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/fincaraiz/similar-properties?id=191347339&rows=6', 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/fincaraiz/similar-properties?id=191347339&rows=6")
        .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/fincaraiz/similar-properties?id=191347339&rows=6", 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/fincaraiz/similar-properties?id=191347339&rows=6"
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/fincaraiz/similar-properties?id=191347339&rows=6"));
            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/fincaraiz/similar-properties?id=191347339&rows=6',
            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/fincaraiz/similar-properties?id=191347339&rows=6")
        .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 id returned listings meta

Common listings fields

id title price bedrooms
JSON Response
200 OK
{
    "success": true,
    "id": 191347339,
    "returned": 2,
    "listings": [
        {
            "id": 191347401,
            "title": "Apartamento en  Venta en Manga, Cartagena",
            "price": {
                "amount": 895000000,
                "currency": "COP"
            },
            "bedrooms": 3,
            "image_count": 9,
            "images": [
                "https://cdn4.fincaraiz.com.co/repo/img/example.jpg"
            ]
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "similar-properties",
        "attempts": 1
    }
}

Errors

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

503

Upstream Unavailable

The upstream request failed after retries, or returned a response this endpoint cannot read (`upstream_unavailable`, `parser_drift`). Retryable and never billed.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "similar-properties"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Fincaraiz is temporarily unavailable. Please retry."
    },
    "success": false
}
422

Validation Error

A query parameter failed validation. Non-billable.

{
    "errors": {
        "id": [
            "The id field is required."
        ]
    },
    "message": "The id field is required."
}
503

Unreadable Response

Fincaraiz answered 200 with a body this endpoint cannot read (`parser_drift`). Nothing is charged for it. Retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "similar-properties"
    },
    "error": {
        "code": "parser_drift",
        "message": "Fincaraiz returned an unreadable response. 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.

Related Endpoints

Fincaraiz API FAQ

Are similar listings guaranteed to match my filters?

No. These are the platform's own comparables and may differ in property type or price. Apply your own filters to the result if you need a narrower set.

Try It Live

Test this endpoint in our interactive playground with real data.