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

# /centaline/properties/search

> Search Centaline Hong Kong residential listings for sale or rent across the full filter surface: free-text keyword, Housing Market Area, estate and phase type codes, MTR station, primary school net, nearby university, price, saleable area, price per saleable sq ft, building age, bedroom count, ownership category (private / HOS / public housing), floor band, outlook, unit characteristics, clubhouse facilities, curated categories, required nearby amenities, walking time to the MTR, developer and Centaline branch, with ordering by ranking, price, publish date, saleable or gross area, saleable or gross price per sq ft, or building age. Returns listing cards with prices and rents, the land-premium-paid and premium-unpaid asking prices on subsidised housing, the previous asking price or rent and the percentage cut where the asking has been reduced, gross and saleable areas and per-sq-ft rates, bedroom and ensuite counts, building age, orientation, labels, nearby places, district hierarchy, media availability, coordinates and timestamps.

**Price:** 1 credit



## OpenAPI

````yaml /openapi/real-estate.json post /api/centaline/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/centaline/properties/search:
    post:
      tags:
        - /centaline
      summary: /centaline/properties/search
      description: >-
        Search Centaline Hong Kong residential listings for sale or rent across
        the full filter surface: free-text keyword, Housing Market Area, estate
        and phase type codes, MTR station, primary school net, nearby
        university, price, saleable area, price per saleable sq ft, building
        age, bedroom count, ownership category (private / HOS / public housing),
        floor band, outlook, unit characteristics, clubhouse facilities, curated
        categories, required nearby amenities, walking time to the MTR,
        developer and Centaline branch, with ordering by ranking, price, publish
        date, saleable or gross area, saleable or gross price per sq ft, or
        building age. Returns listing cards with prices and rents, the
        land-premium-paid and premium-unpaid asking prices on subsidised
        housing, the previous asking price or rent and the percentage cut where
        the asking has been reduced, gross and saleable areas and per-sq-ft
        rates, bedroom and ensuite counts, building age, orientation, labels,
        nearby places, district hierarchy, media availability, coordinates and
        timestamps.


        **Price:** 1 credit
      operationId: __api_centaline_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/CentalinePropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CentalineProperty'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CentalinePropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        lang:
          $ref: '#/components/schemas/CentalineLang'
          default: hk
        count:
          type: integer
          minimum: 1
        keyword:
          anyOf:
            - type: string
            - type: 'null'
        hma_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        estates:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        order:
          $ref: '#/components/schemas/CentalineSortOrder'
          default: Ascending
        listing_type:
          $ref: '#/components/schemas/CentalinePostType'
          default: Sale
        phases:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        mtr_stations:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
        primary_school_nets:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        universities:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineUniversity'
              type: array
            - type: 'null'
        min_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        min_saleable_area:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_saleable_area:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        min_price_per_sqft:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_price_per_sqft:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        min_building_age:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_building_age:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        bedroom_counts:
          anyOf:
            - items:
                type: integer
                maximum: 4
                minimum: 0
              type: array
            - type: 'null'
        estate_usages:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineEstateUsage'
              type: array
            - type: 'null'
        floor_levels:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineFloorLevel'
              type: array
            - type: 'null'
        views:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineView'
              type: array
            - type: 'null'
        characteristics:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineCharacteristic'
              type: array
            - type: 'null'
        facilities:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineFacility'
              type: array
            - type: 'null'
        topics:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineTopic'
              type: array
            - type: 'null'
        nearby_facilities:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineNearbyFacility'
              type: array
            - type: 'null'
        max_mtr_walk_time:
          anyOf:
            - $ref: '#/components/schemas/CentalineMtrDuration'
            - type: 'null'
        developers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        branches:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        hos_only:
          anyOf:
            - type: boolean
            - type: 'null'
        sort:
          $ref: '#/components/schemas/CentalinePostSort'
          default: Ranking
      type: object
      required:
        - count
    CentalineProperty:
      properties:
        '@type':
          type: string
          default: CentalineProperty
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        listing_type:
          anyOf:
            - type: string
            - type: 'null'
        estate_group_name:
          anyOf:
            - type: string
            - type: 'null'
        estate_name:
          anyOf:
            - type: string
            - type: 'null'
        building_name:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        floor_level:
          anyOf:
            - type: string
            - type: 'null'
        unit:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: number
            - type: 'null'
        premium_paid_price:
          anyOf:
            - type: number
            - type: 'null'
        premium_unpaid_price:
          anyOf:
            - type: number
            - type: 'null'
        original_price:
          anyOf:
            - type: number
            - type: 'null'
        price_change_percent:
          anyOf:
            - type: number
            - type: 'null'
        rent:
          anyOf:
            - type: number
            - type: 'null'
        original_rent:
          anyOf:
            - type: number
            - type: 'null'
        rent_change_percent:
          anyOf:
            - type: number
            - type: 'null'
        price_text:
          anyOf:
            - type: string
            - type: 'null'
        rent_text:
          anyOf:
            - type: string
            - type: 'null'
        gross_area:
          anyOf:
            - type: number
            - type: 'null'
        saleable_area:
          anyOf:
            - type: number
            - type: 'null'
        efficiency_ratio:
          anyOf:
            - type: number
            - type: 'null'
        gross_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        saleable_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        gross_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        saleable_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        rental_yield:
          anyOf:
            - type: number
            - type: 'null'
        monthly_mortgage_payment:
          anyOf:
            - type: number
            - type: 'null'
        bedroom_count:
          anyOf:
            - type: integer
            - type: 'null'
        ensuite_count:
          anyOf:
            - type: integer
            - type: 'null'
        building_age:
          anyOf:
            - type: integer
            - type: 'null'
        direction:
          anyOf:
            - type: string
            - type: 'null'
        building_type:
          anyOf:
            - type: string
            - type: 'null'
        unit_type:
          anyOf:
            - type: string
            - type: 'null'
        estate_structure:
          anyOf:
            - type: string
            - type: 'null'
        is_hos:
          anyOf:
            - type: boolean
            - type: 'null'
        is_public_housing:
          anyOf:
            - type: boolean
            - type: 'null'
        is_house:
          anyOf:
            - type: boolean
            - type: 'null'
        is_sole_agent:
          anyOf:
            - type: boolean
            - type: 'null'
        has_key:
          anyOf:
            - type: boolean
            - type: 'null'
        is_foreclosure:
          anyOf:
            - type: boolean
            - type: 'null'
        is_pet_friendly:
          anyOf:
            - type: boolean
            - type: 'null'
        is_hot_listing:
          anyOf:
            - type: boolean
            - type: 'null'
        is_director_pick:
          anyOf:
            - type: boolean
            - type: 'null'
        with_lease:
          anyOf:
            - type: boolean
            - type: 'null'
        is_management_fee_included:
          anyOf:
            - type: boolean
            - type: 'null'
        is_government_rates_included:
          anyOf:
            - type: boolean
            - type: 'null'
        is_government_rent_included:
          anyOf:
            - type: boolean
            - type: 'null'
        estate_group_code:
          anyOf:
            - type: string
            - type: 'null'
        estate_code:
          anyOf:
            - type: string
            - type: 'null'
        building_code:
          anyOf:
            - type: string
            - type: 'null'
        type_code:
          anyOf:
            - type: string
            - type: 'null'
        labels:
          items:
            type: string
          type: array
          default: []
        nearby_places:
          items:
            $ref: '#/components/schemas/CentalineNearbyPlace'
          type: array
          default: []
        scope:
          anyOf:
            - $ref: '#/components/schemas/CentalineScope'
            - type: 'null'
        media:
          anyOf:
            - $ref: '#/components/schemas/CentalineMediaFlags'
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        aerial_view_url:
          anyOf:
            - type: string
            - type: 'null'
        published_at:
          anyOf:
            - type: integer
            - type: 'null'
        updated_at:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    CentalineLang:
      type: string
      enum:
        - hk
        - sc
        - en
    CentalineSortOrder:
      type: string
      enum:
        - Ascending
        - Descending
    CentalinePostType:
      type: string
      enum:
        - Sale
        - Rent
    CentalineUniversity:
      type: string
      enum:
        - 香港大學
        - 香港中文大學
        - 香港科技大學
        - 香港理工大學
        - 香港城市大學
        - 香港浸會大學
        - 嶺南大學
        - 香港樹仁大學
    CentalineEstateUsage:
      type: string
      enum:
        - RE
        - HosPaid
        - HosUnpaid
        - PrhPaid
        - PrhUnpaid
        - Other
    CentalineFloorLevel:
      type: string
      enum:
        - HighFloor
        - MiddleFloor
        - LowFloor
    CentalineView:
      type: string
      enum:
        - Green
        - Sea
        - Mountain
        - Building
        - Street
        - Pond
        - Pool
        - River
        - Stadium
        - Racecourse
        - Bridge
    CentalineCharacteristic:
      type: string
      enum:
        - Balcony
        - Carpark
        - Roof
        - Terrace
        - Garden
        - Carport1
        - SwimmingPool
        - AdjacentUnit
        - DuplexUnit
    CentalineFacility:
      type: string
      enum:
        - SwimmingPool
        - IndoorSwimmingPool
        - ChildrensPool
        - Gymnasium
        - ChildrenPlaygroundPlayRoom
        - PlaygroundPlayroom
        - SaunnaRoom
        - SteamBathRoom
        - Jacuzzi
        - TennisCourt
        - SquashCourt
        - BadmintonCourt
        - TableTennis
        - SnookerRoom
        - GolfDrivingRange
        - BallRoom
        - ReadingStudyRoom
    CentalineTopic:
      type: string
      enum:
        - mortgage90
        - mortgage1125to1500
        - hasmatterport
        - vrguide
        - aivr
        - aitalk
        - hasvideo
        - interior
        - keeppet
        - midprice
        - kol
        - haskey
        - ssd100
        - entry
        - mansion
        - highrentalreturnestate
        - carpark
        - soleagent
        - above30m
        - salemarkdown
        - rentmarkdown
        - house
        - highrent
        - latest
        - todayspecial
        - selection
        - discountpost
        - mortgagee
    CentalineNearbyFacility:
      type: string
      enum:
        - NearMtr
        - NearArcade
        - NearCarpark
        - NearEVCharge
        - NearLargePark
        - NearUniversity
    CentalineMtrDuration:
      type: string
      enum:
        - '120'
        - '300'
        - '600'
    CentalinePostSort:
      type: string
      enum:
        - Ranking
        - PublishDate
        - Price
        - NSize
        - Size
        - NUnitPrice
        - UnitPrice
        - BuildingAge
    CentalineNearbyPlace:
      properties:
        '@type':
          type: string
          default: CentalineNearbyPlace
        name:
          type: string
        kind:
          type: string
        walk_minutes:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - name
        - kind
    CentalineScope:
      properties:
        '@type':
          type: string
          default: CentalineScope
        region:
          anyOf:
            - type: string
            - type: 'null'
        region_code:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        district_code:
          anyOf:
            - type: string
            - type: 'null'
        area:
          anyOf:
            - type: string
            - type: 'null'
        area_code:
          anyOf:
            - type: string
            - type: 'null'
        hma:
          anyOf:
            - type: string
            - type: 'null'
        hma_id:
          anyOf:
            - type: string
            - type: 'null'
        hma_description:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    CentalineMediaFlags:
      properties:
        '@type':
          type: string
          default: CentalineMediaFlags
        has_media:
          anyOf:
            - type: boolean
            - type: 'null'
        has_photos:
          anyOf:
            - type: boolean
            - type: 'null'
        has_street_view:
          anyOf:
            - type: boolean
            - type: 'null'
        has_sphere:
          anyOf:
            - type: boolean
            - type: 'null'
        has_video:
          anyOf:
            - type: boolean
            - type: 'null'
        has_virtual_tour:
          anyOf:
            - type: boolean
            - type: 'null'
        has_floor_plan:
          anyOf:
            - type: boolean
            - type: 'null'
        has_planning_diagram:
          anyOf:
            - type: boolean
            - type: 'null'
        has_unit_plan:
          anyOf:
            - type: boolean
            - type: 'null'
        has_aerial_view:
          anyOf:
            - type: boolean
            - type: 'null'
        has_building_3d_model:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
    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

````