QuintoAndar home
One QuintoAndar home: type, status, rent and sale availability, rent, condo fee, IPTU, home insurance, service fee, total monthly cost, sale price, rental guarantee range, area, rooms, parking, floor range, construction year, pets, furnished, subway, availability, description, every amenity and building installation, nearby places, captioned photos, video, listing history (first and last publication per business) and visit status. Also cost_breakdown (rent, condo fee, IPTU, home insurance, service fee, total, and how condo fee and IPTU are charged), comfort_features and practical_features (the home's comfort and practicality items, such as air conditioning, bathtub, built-in wardrobes), macro_region, visits_available and direct_offer_allowed. Pass latest=true with search filters to open the newest matching listing.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
id | string | Home id (the number in quintoandar.com.br/imovel/<id>). Or give url. |
url | string | A quintoandar.com.br/imovel/... link. |
latest | boolean | true: open the first current result of a search made with the other filter params given here (the same as the search route's, e.g. location), instead of id/url. Example: true |
location | string | With latest: the search's location filter. Example: sao-paulo-sp-brasil |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/quintoandar/v1/listing" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/quintoandar/v1/listing",
params={},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/quintoandar/v1/listing");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).