Scrappa's GET /api/quintoandar/property returns the full public record of one QuintoAndar listing.
What you get
prices holds rent, sale price, condominium fee, property tax (iptu), insurance, service fee and total_cost where QuintoAndar publishes them. Amounts it does not publish are null, never 0. You also get area, rooms, address and coordinates, amenities, installations, nearby places, photos, the description, the condominium reference (use its hash_id with the condominium endpoint) and availability.
Two kinds of listing
QuintoAndar-managed listings (origin TRANSACTIONAL) carry the richest data and name the rental administrator. Partner listings (CLASSIFIED) carry publisher with the agency id, name and logo. For managed listings publisher is null. When origin is omitted the API tries the managed route first and falls back to the partner route. You pay for one result either way.
Hidden data
When a partner hides the exact address or position, address.street and the coordinates are null. Phone numbers and e-mail addresses are removed from descriptions.
Run this endpoint
Endpoint
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.
1 optional filter available.
string
Required
Numeric listing id from search.
893892728
string
Optional
TRANSACTIONAL or CLASSIFIED, as search returned it. Optional.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/quintoandar/property?id=893892728",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/quintoandar/property?id=893892728');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/quintoandar/property?id=893892728', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/quintoandar/property?id=893892728',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/quintoandar/property?id=893892728")
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
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/property?id=893892728", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/quintoandar/property?id=893892728', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/property?id=893892728")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/quintoandar/property?id=893892728", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/quintoandar/property?id=893892728"
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/property?id=893892728"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/quintoandar/property?id=893892728',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/property?id=893892728")
.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
listing
meta
{
"success": true,
"listing": {
"id": 893892728,
"origin": "TRANSACTIONAL",
"url": "https://www.quintoandar.com.br/imovel/893892728/alugar",
"status": "alugado",
"for_rent": true,
"for_sale": false,
"type": "Apartamento",
"area": 53,
"bedrooms": 2,
"bathrooms": 1,
"suites": null,
"parking_spaces": 1,
"prices": {
"rent": 1318,
"sale": null,
"condominium_fee": 500,
"iptu": 42,
"homeowners_insurance": 19,
"tenant_service_fee": 34,
"total_cost": 1913
},
"address": {
"street": "Rua Rosam\u00e9lia de Oliveira",
"neighborhood": "Campo Comprido",
"city": "Curitiba",
"state": "Paran\u00e1",
"state_code": "PR",
"postal_code": "81230-230"
},
"latitude": -25.4582091,
"longitude": -49.3285549,
"condominium": {
"hash_id": "pm8sqex37k",
"name": null,
"slug": "rua-rosamelia-de-oliveira-780-campo-comprido-curitiba",
"address": "Rua Rosam\u00e9lia de Oliveira",
"number": "780"
},
"amenities": [
{
"key": "BOX",
"label": "Box"
}
],
"installations": [
{
"key": "PLAYGROUND",
"label": "Playground"
}
],
"places_nearby": [
{
"name": "Escola Paula Amaral",
"type": "SCHOOL",
"slug": "escola-paula-amaral-campo-comprido-curitiba"
}
],
"images": [
{
"url": "https://www.quintoandar.com.br/img/893892728-393.9820271578673IMG9002.jpg",
"caption": "Sala"
}
],
"description": "Espa\u00e7o de lazer completo.",
"rental_administrator": "QUINTOANDAR",
"publisher": null
},
"meta": {
"billable": true,
"attempts": 1,
"last_status": 200,
"endpoint_family": "property"
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
Nothing exists with that id or hash (`not_found`). Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "property"
},
"error": {
"code": "not_found",
"message": "No listing exists with that id."
},
"success": false
}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."
}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": "property"
},
"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.