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

QuintoAndar Similar Listings API Documentation

GET https://scrappa.co/api/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood

Scrappa's GET /api/quintoandar/similar returns listings similar to one listing.

What you get

type picks the pool: neighbourhood (default), nearby or condominium. Listings have the same shape as search results. condominium is empty for listings that are not in a condominium. business must match the listing, RENT or SALE. An unknown id returns a non-billable 404.

QuintoAndar Similar Listings API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood
Auth header
x-api-key
Cost
1 credit/request
id = 893892728 business = RENT
Response preview
200 OK
{
    "success": true,
    "id": 893892728,
    "type": "neighbourhood",
    "business": "RENT",
    "returned": 1,
    "listings": [
        {
            "id": 893892728,
            "origin": "TRANSACTIONAL",
            "url": "https://www.quintoandar.com.br/imovel/893892728/alugar",
            "for_rent": true,
            "for_sale": false,
            "type": "Apartamento",
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

1 optional filter available.

id string Required

Numeric listing id from search.

Example value 893892728
business string Required

RENT or SALE.

Example value RENT
type string Optional

neighbourhood (default), nearby or condominium.

Example value neighbourhood

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood",
    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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood');

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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood', 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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood',
    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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood")
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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood", 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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood', 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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood")
        .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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood", 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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood"
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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood"));
            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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood',
            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/quintoandar/similar?id=893892728&business=RENT&type=neighbourhood")
        .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 type business returned listings meta

Common listings fields

id origin url for_rent
JSON Response
200 OK
{
    "success": true,
    "id": 893892728,
    "type": "neighbourhood",
    "business": "RENT",
    "returned": 1,
    "listings": [
        {
            "id": 893892728,
            "origin": "TRANSACTIONAL",
            "url": "https://www.quintoandar.com.br/imovel/893892728/alugar",
            "for_rent": true,
            "for_sale": false,
            "type": "Apartamento",
            "price": 1318,
            "rent_price": 1318,
            "sale_price": null,
            "total_cost": 1913,
            "condominium_fee": 500,
            "iptu": 42,
            "iptu_plus_condominium": 542,
            "area": 53,
            "bedrooms": 2,
            "bathrooms": 1,
            "suites": 0,
            "parking_spaces": 1,
            "is_furnished": false,
            "has_elevator": false,
            "address": "Rua Rosam\u00e9lia de Oliveira",
            "neighbourhood": "Campo Comprido",
            "region": "Campo Comprido",
            "city": "Curitiba",
            "latitude": -25.4582091,
            "longitude": -49.3285549,
            "cover_image": "https://www.quintoandar.com.br/img/893892728-393.9820271578673IMG9002.jpg",
            "images": [
                "https://www.quintoandar.com.br/img/893892728-44.647550986580576IMG1315.jpg"
            ],
            "image_captions": [
                "Quarto 2"
            ],
            "amenities": [
                "CHURRASQUEIRA",
                "AREA_DE_SERVICO"
            ],
            "installations": [
                "PLAYGROUND",
                "SALAO_DE_FESTAS"
            ],
            "condominium": {
                "id": 344059,
                "name": null
            },
            "visit_status": "ACCEPT_NEW",
            "special_conditions": [
                "Exclusivity"
            ],
            "tags": [
                "RENT_ON_TERMINATION"
            ]
        }
    ],
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "similar"
    }
}

Errors

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

404

Not Found

Nothing exists with that id or hash (`not_found`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "similar"
    },
    "error": {
        "code": "not_found",
        "message": "No listing exists with that id."
    },
    "success": false
}
422

Validation Error

A query parameter failed validation or is not supported. Unsupported parameters are rejected instead of ignored. Non-billable.

{
    "errors": {
        "business": [
            "The selected business is invalid."
        ]
    },
    "message": "The selected business is invalid."
}
503

Upstream Unavailable

QuintoAndar could not be reached after a retry, or answered with a body this API cannot read (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": true,
        "last_status": 503,
        "endpoint_family": "similar"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "QuintoAndar is temporarily unavailable. 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.