> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anysite.io/llms.txt
> Use this file to discover all available pages before exploring further.

# /quintoandar/properties/search

> Search QuintoAndar real-estate listings in a Brazilian city by location slug with rent or sale context and a full set of filters (price range, property type, area range, bedrooms, bathrooms, parking, suites, furnished, pets, near subway, availability, amenities, building installations, accessibility, sort). Returns listings with address, neighbourhood and coordinates, rent and sale price, total cost, area, bedrooms, bathrooms, suites, parking, amenities, installations, accessibility features, listing tags, images and visit status.

**Price:** 1 credit per 24 results

**⚠️ Common errors:** 412: No matching city/location found for the given slug



## OpenAPI

````yaml /openapi/real-estate.json post /api/quintoandar/properties/search
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/quintoandar/properties/search:
    post:
      tags:
        - /quintoandar
      summary: /quintoandar/properties/search
      description: >-
        Search QuintoAndar real-estate listings in a Brazilian city by location
        slug with rent or sale context and a full set of filters (price range,
        property type, area range, bedrooms, bathrooms, parking, suites,
        furnished, pets, near subway, availability, amenities, building
        installations, accessibility, sort). Returns listings with address,
        neighbourhood and coordinates, rent and sale price, total cost, area,
        bedrooms, bathrooms, suites, parking, amenities, installations,
        accessibility features, listing tags, images and visit status.


        **Price:** 1 credit per 24 results


        **⚠️ Common errors:** 412: No matching city/location found for the given
        slug
      operationId: __api_quintoandar_properties_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuintoandarSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QuintoandarListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    QuintoandarSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location:
          type: string
          minLength: 1
        business_context:
          $ref: '#/components/schemas/QuintoandarBusinessContext'
          default: RENT
        price_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_type:
          anyOf:
            - $ref: '#/components/schemas/QuintoandarPriceType'
            - type: 'null'
        house_type:
          anyOf:
            - items:
                $ref: '#/components/schemas/QuintoandarHouseType'
              type: array
            - type: 'null'
        area_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        area_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        bedrooms_min:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        bathrooms_min:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        parking_min:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        suites_min:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        furnished:
          anyOf:
            - type: boolean
            - type: 'null'
        accepts_pets:
          anyOf:
            - type: boolean
            - type: 'null'
        near_subway:
          anyOf:
            - type: boolean
            - type: 'null'
        availability:
          $ref: '#/components/schemas/QuintoandarAvailability'
          default: ANY
        amenities:
          anyOf:
            - items:
                $ref: '#/components/schemas/QuintoandarAmenity'
              type: array
            - type: 'null'
        installations:
          anyOf:
            - items:
                $ref: '#/components/schemas/QuintoandarInstallation'
              type: array
            - type: 'null'
        accessibility:
          anyOf:
            - items:
                $ref: '#/components/schemas/QuintoandarAccessibility'
              type: array
            - type: 'null'
        sort_by:
          $ref: '#/components/schemas/QuintoandarSortCriteria'
          default: RELEVANCE
        sort_order:
          $ref: '#/components/schemas/QuintoandarSortOrder'
          default: DESC
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - location
        - count
    QuintoandarListing:
      properties:
        '@type':
          type: string
          default: QuintoandarListing
        id:
          type: string
        url:
          type: string
        house_type:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        neighbourhood:
          anyOf:
            - type: string
            - type: 'null'
        region_name:
          anyOf:
            - type: string
            - type: 'null'
        city:
          anyOf:
            - type: string
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        rent_value:
          anyOf:
            - type: number
            - type: 'null'
        sale_price:
          anyOf:
            - type: number
            - type: 'null'
        total_cost:
          anyOf:
            - type: number
            - type: 'null'
        condominium:
          anyOf:
            - type: number
            - type: 'null'
        iptu_plus_condominium:
          anyOf:
            - type: number
            - type: 'null'
        area:
          anyOf:
            - type: number
            - type: 'null'
        bedroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        bathroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        suite_count:
          anyOf:
            - type: integer
            - type: 'null'
        parking_count:
          anyOf:
            - type: integer
            - type: 'null'
        is_furnished:
          anyOf:
            - type: boolean
            - type: 'null'
        has_elevator:
          anyOf:
            - type: boolean
            - type: 'null'
        for_rent:
          anyOf:
            - type: boolean
            - type: 'null'
        for_sale:
          anyOf:
            - type: boolean
            - type: 'null'
        visit_status:
          anyOf:
            - type: string
            - type: 'null'
        yield_rate:
          anyOf:
            - type: number
            - type: 'null'
        listing_tags:
          items:
            type: string
          type: array
          default: []
        special_conditions:
          items:
            type: string
          type: array
          default: []
        amenities:
          items:
            type: string
          type: array
          default: []
        installations:
          items:
            type: string
          type: array
          default: []
        accessibility:
          items:
            type: string
          type: array
          default: []
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
      type: object
      required:
        - id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    QuintoandarBusinessContext:
      type: string
      enum:
        - RENT
        - SALE
    QuintoandarPriceType:
      type: string
      enum:
        - RENT_PRICE
        - TOTAL_COST
        - SALE_PRICE
    QuintoandarHouseType:
      type: string
      enum:
        - APARTMENT
        - HOUSE
        - HOUSE_CONDO
        - STUDIO
    QuintoandarAvailability:
      type: string
      enum:
        - ANY
        - immediate
        - soon
    QuintoandarAmenity:
      type: string
      enum:
        - APARTAMENTO_COBERTURA
        - AR_CONDICIONADO
        - BANHEIRA_DE_HIDROMASSAGEM
        - BOX
        - CHURRASQUEIRA
        - CHUVEIRO_A_GAS
        - CLOSET
        - NOVOS_OU_REFORMADOS
        - PISCINA_PRIVATIVA
        - SOMENTE_UMA_CASA_NO_TERRENO
        - TANQUE
        - TELEVISAO
        - UTENSILIOS_DE_COZINHA
        - VENTILADOR_DE_TETO
        - GARDEN
        - ARMARIOS_NA_COZINHA
        - ARMARIOS_EMBUTIDOS_NO_QUARTO
        - ARMARIOS_NOS_BANHEIROS
        - CAMA_DE_CASAL
        - CAMA_DE_SOLTEIRO
        - MESAS_E_CADEIRAS_DE_JANTAR
        - SOFA
        - LUMINOSIDADE_NATURAL
        - RUA_SILENCIOSA
        - SOL_DA_MANHA
        - SOL_DA_TARDE
        - VISTA_LIVRE
        - FOGAO_INCLUSO
        - COOKTOP
        - GELADEIRA_INCLUSO
        - MICROONDAS
        - MAQUINA_DE_LAVAR
        - AREA_DE_SERVICO
        - COZINHA_AMERICANA
        - MESAS_E_CADEIRAS_DE_ESCRITORIO
        - JARDIM
        - QUINTAL
        - VARANDA
    QuintoandarInstallation:
      type: string
      enum:
        - ACADEMIA
        - AREA_VERDE
        - BRINQUEDOTECA
        - CHURRASQUEIRA
        - Elevador
        - LAVANDERIA_NO_PREDIO
        - PISCINA
        - PLAYGROUND
        - Porteiro24H
        - QUADRA_ESPORTIVA
        - SALAO_DE_FESTAS
        - SALAO_DE_JOGOS
        - SAUNA
    QuintoandarAccessibility:
      type: string
      enum:
        - BANHEIRO_ADAPTADO
        - CORRIMAO
        - PISO_TATIL
        - QUARTOS_E_CORREDORES_COM_PORTAS_AMPLAS
        - RAMPAS_DE_ACESSO
        - VAGA_DE_GARAGEM_ACESSIVEL
    QuintoandarSortCriteria:
      type: string
      enum:
        - RELEVANCE
        - TOTAL_COST
        - SALE_PRICE
        - RENT_VALUE
    QuintoandarSortOrder:
      type: string
      enum:
        - ASC
        - DESC
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````