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

QuintoAndar Condominium API Documentation

GET https://scrappa.co/api/quintoandar/condominium?hash_id=pm8sqex37k

Scrappa's GET /api/quintoandar/condominium returns the public record of one building.

What you get

Name, address, region and city (with slugs for search), doorman type, installations, images and the ids of similar condominiums. Take hash_id from condominium.hash_id in the property endpoint.

QuintoAndar Condominium API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/quintoandar/condominium?hash_id=pm8sqex37k
Auth header
x-api-key
Cost
1 credit/request
hash_id = pm8sqex37k
Response preview
200 OK
{
    "success": true,
    "condominium": {
        "hash_id": "1d47s7e58d",
        "name": "Conjunto Resid\u00eancial Cotolengo",
        "slug": "conjunto-residencial-cotolengo-campo-comprido-curitiba",
        "address": "Rua Rosam\u00e9lia de Oliveira",
        "number": "780",
        "neighborhood": "Campo Comprido",
        "region": {
            "id": 1937,
            "hash_id": "vk8qtmvrkq",
            "name": "Campo Comprido",
            "slug": "campo-comprido-curitiba-pr-brasil",
...

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.

hash_id string Required

Condominium hash id from the listing detail.

Example value pm8sqex37k

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/quintoandar/condominium?hash_id=pm8sqex37k",
    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/condominium?hash_id=pm8sqex37k');

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/condominium?hash_id=pm8sqex37k', 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/condominium?hash_id=pm8sqex37k',
    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/condominium?hash_id=pm8sqex37k")
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/condominium?hash_id=pm8sqex37k", 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/condominium?hash_id=pm8sqex37k', 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/condominium?hash_id=pm8sqex37k")
        .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/condominium?hash_id=pm8sqex37k", 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/condominium?hash_id=pm8sqex37k"
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/condominium?hash_id=pm8sqex37k"));
            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/condominium?hash_id=pm8sqex37k',
            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/condominium?hash_id=pm8sqex37k")
        .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 condominium meta
JSON Response
200 OK
{
    "success": true,
    "condominium": {
        "hash_id": "1d47s7e58d",
        "name": "Conjunto Resid\u00eancial Cotolengo",
        "slug": "conjunto-residencial-cotolengo-campo-comprido-curitiba",
        "address": "Rua Rosam\u00e9lia de Oliveira",
        "number": "780",
        "neighborhood": "Campo Comprido",
        "region": {
            "id": 1937,
            "hash_id": "vk8qtmvrkq",
            "name": "Campo Comprido",
            "slug": "campo-comprido-curitiba-pr-brasil",
            "latitude": -25.466876,
            "longitude": -49.327463
        },
        "city": {
            "id": 1918,
            "hash_id": "6knguqmzp2",
            "name": "Curitiba",
            "slug": "curitiba-pr-brasil",
            "latitude": -25.480876,
            "longitude": -49.304425
        },
        "doorman_type": "DayShiftOnly",
        "installations": [
            {
                "key": "PLAYGROUND",
                "label": "Playground"
            }
        ],
        "images": [
            {
                "url": "https://www.quintoandar.com.br/img/892892581-420.8976082927696IMG5499.jpg",
                "caption": "Quadra"
            }
        ],
        "featured_image": {
            "url": "https://www.quintoandar.com.br/img/892892581-381.99702460009775IMG5506.jpg",
            "caption": "Fachada"
        },
        "similar_condominium_ids": [
            344059,
            78158
        ]
    },
    "meta": {
        "billable": true,
        "attempts": 1,
        "last_status": 200,
        "endpoint_family": "condominium"
    }
}

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": "condominium"
    },
    "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": "condominium"
    },
    "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.