Skip to main content
POST
/
api
/
quintoandar
/
properties
/
similar
/quintoandar/properties/similar
curl --request POST \
  --url https://api.anysite.io/api/quintoandar/properties/similar \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "property": "<string>",
  "count": 2,
  "timeout": 300,
  "scope": "nearby",
  "business_context": "RENT"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@quintoandar_listing",
    "house_type": "<string>",
    "address": "<string>",
    "neighbourhood": "<string>",
    "region_name": "<string>",
    "city": "<string>",
    "latitude": 123,
    "longitude": 123,
    "rent_value": 123,
    "sale_price": 123,
    "total_cost": 123,
    "condominium": 123,
    "iptu_plus_condominium": 123,
    "area": 123,
    "bedroom_count": 123,
    "bathroom_count": 123,
    "suite_count": 123,
    "parking_count": 123,
    "is_furnished": true,
    "has_elevator": true,
    "for_rent": true,
    "for_sale": true,
    "visit_status": "<string>",
    "yield_rate": 123,
    "listing_tags": [],
    "special_conditions": [],
    "amenities": [],
    "installations": [],
    "accessibility": [],
    "image": "<string>",
    "images": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required

QuintoAndar numeric property ID or a property URL containing it

Minimum string length: 1
Example:

"895519971"

count
integer
required

Max number of similar listings to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
scope
enum<string>
default:nearby

Recommendation scope

Available options:
nearby,
condominium,
neighbourhood
business_context
enum<string>
default:RENT

Rent or sale listings

Available options:
RENT,
SALE

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@quintoandar_listing
house_type
string | null
address
string | null
neighbourhood
string | null
region_name
string | null
city
string | null
latitude
number | null
longitude
number | null
rent_value
number | null
sale_price
number | null
total_cost
number | null
condominium
number | null
iptu_plus_condominium
number | null
area
number | null
bedroom_count
integer | null
bathroom_count
integer | null
suite_count
integer | null
parking_count
integer | null
is_furnished
boolean | null
has_elevator
boolean | null
for_rent
boolean | null
for_sale
boolean | null
visit_status
string | null
yield_rate
number | null
listing_tags
string[]
special_conditions
string[]
amenities
string[]
installations
string[]
accessibility
string[]
image
string | null
images
string[]