{ "openapi": "3.0.1", "info": { "title": "Brazil Rental & Sale Listings by City (QuintoAndar)", "description": "Search Brazilian rental and sale property listings by city and transaction type: price breakdown, bedrooms, bathrooms, area, furnishing, and address across 15 major cities.", "version": "1.0", "x-build-id": "zT1Qzg0VWyjBONG32" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~brazil-rental-and-sale-listings-by-city/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-brazil-rental-and-sale-listings-by-city", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/dataspryva~brazil-rental-and-sale-listings-by-city/runs": { "post": { "operationId": "runs-sync-dataspryva-brazil-rental-and-sale-listings-by-city", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/dataspryva~brazil-rental-and-sale-listings-by-city/run-sync": { "post": { "operationId": "run-sync-dataspryva-brazil-rental-and-sale-listings-by-city", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "rent", "buy", "byUrls" ], "type": "string", "description": "Search rentals, search properties for sale, or load specific listings by URL or ID.", "default": "rent" }, "city": { "title": "City or region", "enum": [ "sao-paulo-sp-brasil", "rio-de-janeiro-rj-brasil", "belo-horizonte-mg-brasil", "porto-alegre-rs-brasil", "brasilia-df-brasil", "curitiba-pr-brasil", "goiania-go-brasil", "campinas-sp-brasil", "canoas-rs-brasil", "guarulhos-sp-brasil", "jundiai-sp-brasil", "nova-lima-mg-brasil", "novo-hamburgo-rs-brasil", "niteroi-rj-brasil", "osasco-sp-brasil", "santo-andre-sp-brasil", "sao-bernardo-do-campo-sp-brasil", "sao-caetano-do-sul-sp-brasil", "barueri-sp-brasil", "sao-leopoldo-rs-brasil", "florianopolis-sc-brasil", "sao-jose-sc-brasil", "palhoca-sc-brasil", "contagem-mg-brasil", "taboao-da-serra-sp-brasil", "diadema-sp-brasil", "sao-jose-dos-pinhais-pr-brasil", "varzea-paulista-sp-brasil", "pinhais-pr-brasil", "santana-de-parnaiba-sp-brasil", "santos-sp-brasil", "salvador-ba-brasil", "mogi-das-cruzes-sp-brasil", "sao-jose-dos-campos-sp-brasil", "cotia-sp-brasil", "ribeirao-preto-sp-brasil", "sorocaba-sp-brasil", "uberlandia-mg-brasil", "maua-sp-brasil", "valinhos-sp-brasil", "vinhedo-sp-brasil", "indaiatuba-sp-brasil", "nova-iguacu-rj-brasil", "americana-sp-brasil", "hortolandia-sp-brasil", "paulinia-sp-brasil", "praia-grande-sp-brasil", "guaruja-sp-brasil", "carapicuiba-sp-brasil", "votorantim-sp-brasil", "sao-vicente-sp-brasil", "duque-de-caxias-rj-brasil", "sao-goncalo-rj-brasil", "betim-mg-brasil", "aparecida-de-goiania-go-brasil", "suzano-sp-brasil", "itaquaquecetuba-sp-brasil", "sumare-sp-brasil", "embu-das-artes-sp-brasil", "ferraz-de-vasconcelos-sp-brasil", "poa-sp-brasil", "gravatai-rs-brasil", "viamao-rs-brasil", "alvorada-rs-brasil", "belford-roxo-rj-brasil", "nilopolis-rj-brasil", "mesquita-rj-brasil", "taubate-sp-brasil", "jacarei-sp-brasil", "ribeirao-das-neves-mg-brasil", "ribeirao-pires-sp-brasil", "brumadinho-mg-brasil", "itabirito-mg-brasil", "lagoa-santa-mg-brasil", "sabara-mg-brasil", "vespasiano-mg-brasil", "rio-acima-mg-brasil", "santa-luzia-mg-brasil", "marica-rj-brasil", "cabo-frio-rj-brasil", "petropolis-rj-brasil", "sapucaia-do-sul-rs-brasil", "macae-rj-brasil", "cachoeirinha-rs-brasil", "juiz-de-fora-mg-brasil", "rio-das-ostras-rj-brasil", "sao-carlos-sp-brasil", "piracicaba-sp-brasil", "limeira-sp-brasil", "montes-claros-mg-brasil", "londrina-pr-brasil", "maringa-pr-brasil", "ponta-grossa-pr-brasil", "volta-redonda-rj-brasil", "santa-maria-rs-brasil", "caxias-do-sul-rs-brasil", "uberaba-mg-brasil", "campos-dos-goytacazes-rj-brasil", "anapolis-go-brasil" ], "type": "string", "description": "QuintoAndar location to search (mode=rent or buy).", "default": "sao-paulo-sp-brasil" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Optional neighborhood inside the selected city, e.g. Pinheiros or Copacabana (mode=rent or buy)." }, "propertyType": { "title": "Property type", "enum": [ "ANY", "APARTMENT", "HOUSE", "HOUSE_CONDO", "STUDIO" ], "type": "string", "description": "Restrict results to one property type (mode=rent or buy).", "default": "ANY" }, "priceBasis": { "title": "Price basis", "enum": [ "rent", "total" ], "type": "string", "description": "Whether price filters apply to the base rent or the total monthly cost (mode=rent). Buy mode always uses the sale price.", "default": "rent" }, "priceMin": { "title": "Minimum price (BRL)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Lowest price to include, in Brazilian reais." }, "priceMax": { "title": "Maximum price (BRL)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Highest price to include, in Brazilian reais." }, "areaMin": { "title": "Minimum area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Smallest usable area to include, in square metres." }, "areaMax": { "title": "Maximum area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Largest usable area to include, in square metres." }, "bedroomsMin": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest bedrooms a listing may have." }, "bedroomsMax": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most bedrooms a listing may have." }, "bathroomsMin": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest bathrooms a listing may have." }, "bathroomsMax": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most bathrooms a listing may have." }, "parkingMin": { "title": "Minimum parking spaces", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest parking spaces a listing may have." }, "parkingMax": { "title": "Maximum parking spaces", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most parking spaces a listing may have." }, "suitesMin": { "title": "Minimum suites", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest suites a listing may have." }, "suitesMax": { "title": "Maximum suites", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most suites a listing may have." }, "furnished": { "title": "Furnished", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Include only furnished listings, only unfurnished listings, or both.", "default": "any" }, "acceptsPets": { "title": "Accepts pets", "enum": [ "any", "yes" ], "type": "string", "description": "Include only listings that accept pets, or all listings.", "default": "any" }, "nearSubway": { "title": "Near subway", "enum": [ "any", "yes" ], "type": "string", "description": "Include only listings marked close to a metro or train station, or all listings.", "default": "any" }, "amenities": { "title": "Unit amenities", "type": "array", "description": "Property feature codes that must all be present, e.g. VARANDA, AR_CONDICIONADO (mode=rent or buy).", "items": { "type": "string" } }, "installations": { "title": "Building facilities", "type": "array", "description": "Building facility codes that must all be present, e.g. PISCINA, ACADEMIA (mode=rent or buy).", "items": { "type": "string" } }, "availability": { "title": "Availability", "enum": [ "any", "immediate", "soon" ], "type": "string", "description": "When the property can be occupied (mode=rent).", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "cheapest", "expensive", "highestRent" ], "type": "string", "description": "Order of the returned listings. Cheapest and most expensive use total monthly cost; highest rental return is the investor yield order.", "default": "relevance" }, "developmentsOnly": { "title": "New developments only", "type": "boolean", "description": "Show only new-development listings (mode=buy).", "default": false }, "exactCityOnly": { "title": "Exact city only", "type": "boolean", "description": "Drop listings from neighbouring municipalities that QuintoAndar includes in a city search.", "default": false }, "includeDetails": { "title": "Include detail fields", "type": "boolean", "description": "Load each listing's detail page for description, separate condo fee and IPTU, ZIP code, coordinates and full photo captions.", "default": true }, "listingUrls": { "title": "Listing URLs or IDs", "type": "array", "description": "QuintoAndar listing links or numeric property IDs (mode=byUrls). Duplicates are ignored.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on the number of listings returned (1-5000). Values above 1000 use price-slice partitioning.", "default": 500 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }