> ## 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.

# /28hse/properties/search

> Search Hong Kong property listings on 28Hse or Squarefoot across the whole filter surface the sites expose: for-sale or for-rent, free text, the three-level area tree (region, district group, district), primary and secondary school nets, nearby universities, specific estates, property category (private estate, subsidised housing with or without the premium paid, village house, detached house, public housing, tenement, stand-alone block, subdivided and shared units, short lets, carparks, industrial and office space, shops, land and overseas stock), price, saleable or gross area, bedroom count, outlook, decoration level, included appliances and furniture, pet policy, carpark, unit and office features, orientation, whether the advertiser is an owner or an agency, building age, floor band, kitchen layout, open-flame cooking, developer, virtual tours, auctions and prepaid-rent discounts, with twelve ordering modes. Returns listing cards with id, headline, price, saleable and gross areas with price per square foot, estate and district with their ids, floor band, block and unit designation, bedroom and bathroom counts, street address, orientation, the indicative monthly mortgage repayment, cover photo, photo count and the advertiser labels — the two portals print different subsets of these on their cards. The total number of matching listings is returned in the X-Total-Available-Results header.

**Price:** 1 credit



## OpenAPI

````yaml /openapi/real-estate.json post /api/28hse/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/28hse/properties/search:
    post:
      tags:
        - /28hse
      summary: /28hse/properties/search
      description: >-
        Search Hong Kong property listings on 28Hse or Squarefoot across the
        whole filter surface the sites expose: for-sale or for-rent, free text,
        the three-level area tree (region, district group, district), primary
        and secondary school nets, nearby universities, specific estates,
        property category (private estate, subsidised housing with or without
        the premium paid, village house, detached house, public housing,
        tenement, stand-alone block, subdivided and shared units, short lets,
        carparks, industrial and office space, shops, land and overseas stock),
        price, saleable or gross area, bedroom count, outlook, decoration level,
        included appliances and furniture, pet policy, carpark, unit and office
        features, orientation, whether the advertiser is an owner or an agency,
        building age, floor band, kitchen layout, open-flame cooking, developer,
        virtual tours, auctions and prepaid-rent discounts, with twelve ordering
        modes. Returns listing cards with id, headline, price, saleable and
        gross areas with price per square foot, estate and district with their
        ids, floor band, block and unit designation, bedroom and bathroom
        counts, street address, orientation, the indicative monthly mortgage
        repayment, cover photo, photo count and the advertiser labels — the two
        portals print different subsets of these on their cards. The total
        number of matching listings is returned in the X-Total-Available-Results
        header.


        **Price:** 1 credit
      operationId: __api_28hse_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/Hse28PropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Hse28Property'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Hse28PropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        site:
          $ref: '#/components/schemas/Hse28Site'
          default: 28hse
        lang:
          $ref: '#/components/schemas/Hse28Lang'
          default: tc
        listing_type:
          $ref: '#/components/schemas/Hse28BuyRent'
          default: buy
        count:
          type: integer
          minimum: 1
        keyword:
          anyOf:
            - type: string
            - type: 'null'
        sort:
          $ref: '#/components/schemas/Hse28PropertySort'
          default: relevance
        regions:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28Region'
              type: array
              uniqueItems: true
            - type: 'null'
        district_groups:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28DistrictGroup'
              type: array
              uniqueItems: true
            - type: 'null'
        districts:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28District'
              type: array
              uniqueItems: true
            - type: 'null'
        primary_school_nets:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28PrimarySchoolNet'
              type: array
              uniqueItems: true
            - type: 'null'
        secondary_school_nets:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28SecondarySchoolNet'
              type: array
              uniqueItems: true
            - type: 'null'
        universities:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28University'
              type: array
              uniqueItems: true
            - type: 'null'
        estate_cat_ids:
          anyOf:
            - items:
                type: string
              type: array
              uniqueItems: true
            - type: 'null'
        property_types:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28PropertyType'
              type: array
              uniqueItems: true
            - type: 'null'
        rental_shortcuts:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28RentalShortcut'
              type: array
              uniqueItems: true
            - type: 'null'
        min_price:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        max_price:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        area_basis:
          $ref: '#/components/schemas/Hse28AreaBasis'
          default: saleable
        min_area:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        max_area:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        room_counts:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28RoomRange'
              type: array
              uniqueItems: true
            - type: 'null'
        features:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28Feature'
              type: array
              uniqueItems: true
            - type: 'null'
        directions:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28Direction'
              type: array
              uniqueItems: true
            - type: 'null'
        listed_by:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28ListedBy'
              type: array
              uniqueItems: true
            - type: 'null'
        building_ages:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28BuildingAge'
              type: array
              uniqueItems: true
            - type: 'null'
        floor_zones:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28FloorZone'
              type: array
              uniqueItems: true
            - type: 'null'
        kitchen_types:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28KitchenType'
              type: array
              uniqueItems: true
            - type: 'null'
        open_flame_cooking:
          anyOf:
            - type: boolean
            - type: 'null'
        developers:
          anyOf:
            - items:
                $ref: '#/components/schemas/Hse28Developer'
              type: array
              uniqueItems: true
            - type: 'null'
        has_vr_or_video:
          anyOf:
            - type: boolean
            - type: 'null'
        auction_only:
          anyOf:
            - type: boolean
            - type: 'null'
        prepaid_rent_discount_only:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
      required:
        - count
    Hse28Property:
      properties:
        '@type':
          type: string
          default: Hse28Property
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        buy_rent:
          anyOf:
            - type: string
            - type: 'null'
        headline:
          anyOf:
            - type: string
            - type: 'null'
        reference:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: number
            - type: 'null'
        price_per_saleable_sqft:
          anyOf:
            - type: number
            - type: 'null'
        price_per_gross_sqft:
          anyOf:
            - type: number
            - type: 'null'
        saleable_area:
          anyOf:
            - type: number
            - type: 'null'
        gross_area:
          anyOf:
            - type: number
            - type: 'null'
        rent_includes:
          anyOf:
            - type: string
            - type: 'null'
        mortgage_monthly_payment:
          anyOf:
            - type: number
            - type: 'null'
        room_count:
          anyOf:
            - type: integer
            - type: 'null'
        bathroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        floor_zone:
          anyOf:
            - type: string
            - type: 'null'
        direction:
          anyOf:
            - type: string
            - type: 'null'
        kitchen_type:
          anyOf:
            - type: string
            - type: 'null'
        rental_start_at:
          anyOf:
            - type: integer
            - type: 'null'
        estate:
          anyOf:
            - type: string
            - type: 'null'
        estate_id:
          anyOf:
            - type: string
            - type: 'null'
        estate_cat_id:
          anyOf:
            - type: string
            - type: 'null'
        estate_url:
          anyOf:
            - type: string
            - type: 'null'
        estate_age:
          anyOf:
            - type: integer
            - type: 'null'
        block_and_unit:
          anyOf:
            - type: string
            - type: 'null'
        region:
          anyOf:
            - type: string
            - type: 'null'
        district_group:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        district_url:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        primary_school_net:
          anyOf:
            - type: string
            - type: 'null'
        primary_school_net_id:
          anyOf:
            - type: string
            - type: 'null'
        secondary_school_net:
          anyOf:
            - type: string
            - type: 'null'
        secondary_school_net_id:
          anyOf:
            - type: string
            - type: 'null'
        listed_by_landlord:
          anyOf:
            - type: boolean
            - type: 'null'
        view_count:
          anyOf:
            - type: integer
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        image_count:
          anyOf:
            - type: integer
            - type: 'null'
        videos:
          items:
            type: string
          type: array
          default: []
        labels:
          items:
            type: string
          type: array
          default: []
        categories:
          items:
            type: string
          type: array
          default: []
        agency:
          anyOf:
            - $ref: '#/components/schemas/Hse28Agency'
            - type: 'null'
        contacts:
          items:
            $ref: '#/components/schemas/Hse28Contact'
          type: array
          default: []
        nearby_places:
          items:
            $ref: '#/components/schemas/Hse28NearbyPlace'
          type: array
          default: []
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
        updated_at:
          anyOf:
            - type: integer
            - type: 'null'
        expires_at:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    Hse28Site:
      type: string
      enum:
        - 28hse
        - squarefoot
    Hse28Lang:
      type: string
      enum:
        - tc
        - cn
        - en
    Hse28BuyRent:
      type: string
      enum:
        - buy
        - rent
    Hse28PropertySort:
      type: string
      enum:
        - relevance
        - newest
        - price_low_to_high
        - price_high_to_low
        - gross_area_low_to_high
        - gross_area_high_to_low
        - saleable_area_low_to_high
        - saleable_area_high_to_low
        - gross_price_per_sqft_low_to_high
        - gross_price_per_sqft_high_to_low
        - saleable_price_per_sqft_low_to_high
        - saleable_price_per_sqft_high_to_low
    Hse28Region:
      type: string
      enum:
        - hong_kong_island
        - kowloon
        - new_territories
        - outlying_islands
        - oversea
    Hse28DistrictGroup:
      type: string
      enum:
        - island_south
        - aberdeen_ap_lei_chau_wong_chuk_hang
        - chai_wan_siu_sai_wan_shek_o
        - shau_kei_wan_heng_fa_chuen
        - sai_wan_ho
        - taikoo
        - quarry_bay
        - north_point_mid_levels
        - north_point_fortress_hill
        - tin_hau_tai_hang
        - causeway_bay_happy_valley
        - wan_chai_admiralty
        - mid_levels
        - central_sheung_wan
        - sai_ying_pun_shek_tong_tsui
        - kennedy_town
        - whampoa
        - hung_hom
        - tsim_sha_tsui
        - jordan
        - yau_ma_tei
        - mong_kok
        - prince_edward
        - tai_kok_tsui_olympic_kowloon_station
        - lai_king
        - mei_foo
        - cheung_sha_wan
        - lai_chi_kok
        - sham_shui_po_shek_kip_mei_nam_cheong
        - yau_yat_tsuen
        - ho_man_tin
        - kowloon_tong
        - san_po_kong_wong_tai_sin
        - kai_tak
        - kowloon_city
        - to_kwa_wan
        - diamond_hill_lok_fu
        - ngau_chi_wan
        - kowloon_bay
        - kwun_tong_ngau_tau_kok
        - yau_tong
        - lam_tin
        - sha_tau_kok
        - tsing_yi
        - kwai_chung_kwai_fong
        - tsuen_wan_tai_wo_hau
        - tsuen_wan_sham_tseng
        - tuen_mun_castle_peak_road
        - tuen_mun
        - tin_shui_wai
        - yuen_long_hung_shui_kiu
        - sheung_shui
        - fan_ling
        - tai_po_tai_wo_pak_shek_kok
        - sha_tin_tai_wai_fotan
        - ma_on_shan
        - tseung_kwan_o
        - sai_kung_clear_water_bay
        - cheung_chau_other_islands
        - lamma_island
        - peng_chau
        - south_lantau_island_tai_o
        - tung_chung
        - discovery_bay
        - ma_wan
        - greater_bay_area
    Hse28District:
      type: string
      enum:
        - pok_fu_lam
        - shouson_hill
        - baguio_villa
        - southern_district
        - repulse_bay
        - tai_tam
        - stanley
        - south_horizons
        - parkview
        - wong_chuk_hang
        - ap_lei_chau
        - aberdeen
        - chai_wan
        - shek_o
        - siu_sai_wan
        - shau_kei_wan
        - heng_fa_chuen
        - north_point
        - fortress_hill
        - tai_hang
        - tin_hau
        - jardines_lookout
        - happy_valley
        - happy_valley_mid_levels
        - causeway_bay
        - admiralty
        - wan_chai
        - shiu_fai_terrace
        - western_mid_levels
        - mid_levels_central
        - the_peak
        - sheung_wan
        - central
        - sai_ying_pun
        - shek_tong_tsui
        - tai_kok_tsui
        - olympic
        - kowloon_station
        - sham_shui_po
        - shek_kip_mei
        - nam_cheong
        - san_po_kong
        - wong_tai_sin
        - diamond_hill
        - lok_fu
        - ngau_tau_kok
        - kwun_tong
        - kwai_chung
        - kwai_fong
        - tsuen_wan
        - tai_wo_hau
        - yuen_long
        - hung_shui_kiu
        - tai_po
        - tai_wo
        - pak_shek_kok
        - sha_tin
        - tai_wai
        - fotan
        - tseung_kwan_o_town
        - lohas_park
        - hang_hau
        - po_lam
        - tiu_keng_leng
        - sai_kung
        - clear_water_bay
        - cheung_chau
        - other_islands
        - south_lantau_island
        - tai_o
        - zhongshan
        - zhuhai
        - guangdong
        - huizhou
        - shenzhen
        - jiangmen
    Hse28PrimarySchoolNet:
      type: string
      enum:
        - net_11_central_and_western
        - net_12_wan_chai
        - net_14_eastern
        - net_16_eastern
        - net_18_southern
        - net_31_yau_tsim_mong
        - net_32_yau_tsim_mong
        - net_34_kowloon_city
        - net_35_kowloon_city
        - net_38_sham_shui_po
        - net_40_sham_shui_po
        - net_41_kowloon_city
        - net_43_wong_tai_sin
        - net_45_wong_tai_sin
        - net_46_kwun_tong
        - net_48_kwun_tong
        - net_62_tsuen_wan
        - net_64_kwai_tsing
        - net_65_kwai_tsing
        - net_66_kwai_tsing
        - net_70_tuen_mun
        - net_71_tuen_mun
        - net_72_yuen_long
        - net_73_yuen_long
        - net_74_yuen_long
        - net_80_north
        - net_81_north
        - net_83_north
        - net_84_tai_po
        - net_88_sha_tin
        - net_89_sha_tin
        - net_91_sha_tin
        - net_95_sai_kung
        - net_96_islands
        - net_97_islands
        - net_98_islands
        - net_99_islands
    Hse28SecondarySchoolNet:
      type: string
      enum:
        - central_and_western_hk1
        - wan_chai_hk2
        - eastern_hk3
        - southern_hk4
        - yau_tsim_mong_kl1
        - sham_shui_po_kl2
        - kowloon_city_kl3
        - wong_tai_sin_kl4
        - kwun_tong_kl5
        - kwai_tsing_nt1
        - tsuen_wan_nt2
        - tuen_mun_nt3
        - yuen_long_nt4
        - north_nt5
        - tai_po_nt6
        - sha_tin_nt7
        - sai_kung_nt8
    Hse28University:
      type: string
      enum:
        - hku
        - cuhk
        - hkust
        - polyu
        - cityu
        - hkbu
        - lingnan
        - shue_yan
        - eduhk
        - hang_seng
        - metropolitan
        - chu_hai_college
        - saint_francis
    Hse28PropertyType:
      type: string
      enum:
        - any_residential
        - any_carpark
        - any_industrial_or_office
        - any_shop
        - any_land
        - any_oversea
        - apartment
        - home_ownership_scheme
        - home_ownership_scheme_premium_unpaid
        - home_ownership_scheme_free_market
        - village_house
        - house
        - public_housing
        - public_housing_premium_unpaid
        - public_housing_free_market
        - western_style_building
        - tong_lau
        - stand_alone_building
        - subdivided_flat
        - room_share
        - short_term_rental
        - residential_carpark
        - commercial_carpark
        - truck_carpark
        - motorbike_carpark
        - industrial_building
        - commercial_office
        - shopping_mall_shop
        - upstair_shop
        - street_shop
        - business_takeover
        - residential_land
        - village_house_land
        - agricultural_land
        - storage_land
        - warehouse
        - recreation_area
        - oversea_new_homes
        - oversea_property
    Hse28RentalShortcut:
      type: string
      enum:
        - subdivided_flat
        - room_share
        - short_term_rental
    Hse28AreaBasis:
      type: string
      enum:
        - saleable
        - gross
    Hse28RoomRange:
      type: string
      enum:
        - studio
        - one
        - two
        - three
        - four
        - five_or_more
    Hse28Feature:
      type: string
      enum:
        - any_view
        - mountain_view
        - garden_view
        - open_view
        - building_view
        - city_view
        - sea_view
        - river_view
        - swimming_pool_view
        - any_decoration
        - simple_decoration
        - elegant_decoration
        - luxury_decoration
        - any_appliance
        - all_appliances_included
        - tv
        - microwave
        - air_conditioner
        - washing_machine
        - water_heater
        - fridge
        - steam_oven
        - induction_cooker
        - cooker_hood
        - oven
        - dishwasher
        - dryer
        - wine_cellar
        - any_furniture
        - all_furniture_included
        - partly_furnished
        - tv_cabinet
        - wardrobe
        - table
        - sofa
        - bed
        - chair
        - coffee_table
        - cabinet
        - dressing_table
        - bookshelf
        - sole_agent
        - pet_friendly
        - any_carpark
        - indoor_carpark
        - outdoor_carpark
        - any_unit_feature
        - garden
        - welcomes_students
        - with_tenancy
        - balcony
        - roof_top
        - terrace
        - ensuite
        - maid_room
        - duplex
        - whole_floor
        - clubhouse
        - near_mtr
        - near_shopping_mall
        - good_school_net
        - powder_room
        - any_office_feature
        - cctv_24h
        - access_24h
        - dedicated_mailbox
        - private_toilet
        - private_air_conditioner
        - office_roof_top
        - office_terrace
        - office_whole_floor
    Hse28Direction:
      type: string
      enum:
        - east
        - south_east
        - south
        - south_west
        - west
        - north_west
        - north
        - north_east
    Hse28ListedBy:
      type: string
      enum:
        - landlord
        - big_landlord
        - agency
    Hse28BuildingAge:
      type: string
      enum:
        - brand_new
        - within_5_years
        - within_10_years
        - within_15_years
        - within_20_years
        - within_25_years
        - within_30_years
        - from_20_to_30_years
        - from_30_to_40_years
        - from_40_to_50_years
        - above_50_years
    Hse28FloorZone:
      type: string
      enum:
        - whole_block
        - high
        - middle
        - low
        - ground
        - underground
    Hse28KitchenType:
      type: string
      enum:
        - separate_kitchen
        - open_kitchen
        - no_kitchen
    Hse28Developer:
      type: string
      enum:
        - shkp
        - ck_asset
        - henderson
        - sino
        - new_world
        - wheelock
        - nan_fung
        - chinachem
        - swire
        - hang_lung
        - kerry
        - hutchison_whampoa
        - china_overseas
        - k_wah
        - hong_kong_housing_society
        - wing_tai
        - kowloon_development
        - wang_on
        - hkr
        - billion_development
        - vanke_hong_kong
        - road_king
        - poly
        - others
    Hse28Agency:
      properties:
        '@type':
          type: string
          default: Hse28Agency
        id:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        sale_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        rent_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
    Hse28Contact:
      properties:
        '@type':
          type: string
          default: Hse28Contact
        name:
          anyOf:
            - type: string
            - type: 'null'
        licence:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    Hse28NearbyPlace:
      properties:
        '@type':
          type: string
          default: Hse28NearbyPlace
        name:
          type: string
        kind:
          type: string
        walk_minutes:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - name
        - kind
    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

````