> ## 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/estates/search

> Search the Centaline directory of Hong Kong residential estates (屋苑). Filter by free-text keyword, Housing Market Area, estate type code, primary school net, ownership category, clubhouse facilities, developer, average price per saleable sq ft and building age, ordered by ranking, price per sq ft or building age. Each estate carries its type code, name, address, developer and management company, phase/building/unit counts, occupation date range, current sale and rent price levels with month-on-month trend and listing/transaction counts, school nets, district hierarchy and coordinates.

**Price:** 1 credit



## OpenAPI

````yaml /openapi/real-estate.json post /api/centaline/estates/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/estates/search:
    post:
      tags:
        - /centaline
      summary: /centaline/estates/search
      description: >-
        Search the Centaline directory of Hong Kong residential estates (屋苑).
        Filter by free-text keyword, Housing Market Area, estate type code,
        primary school net, ownership category, clubhouse facilities, developer,
        average price per saleable sq ft and building age, ordered by ranking,
        price per sq ft or building age. Each estate carries its type code,
        name, address, developer and management company, phase/building/unit
        counts, occupation date range, current sale and rent price levels with
        month-on-month trend and listing/transaction counts, school nets,
        district hierarchy and coordinates.


        **Price:** 1 credit
      operationId: __api_centaline_estates_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CentalineEstatesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CentalineEstateSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CentalineEstatesSearchPayload:
      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
        primary_school_nets:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
        estate_usages:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineEstateCategory'
              type: array
            - type: 'null'
        facilities:
          anyOf:
            - items:
                $ref: '#/components/schemas/CentalineFacility'
              type: array
            - type: 'null'
        developers:
          anyOf:
            - items:
                type: string
              type: array
            - 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'
        sort:
          $ref: '#/components/schemas/CentalineEstateSort'
          default: Ranking
      type: object
      required:
        - count
    CentalineEstateSummary:
      properties:
        '@type':
          type: string
          default: CentalineEstateSummary
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        phase_name:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        estate_structure:
          anyOf:
            - type: string
            - type: 'null'
        developer:
          anyOf:
            - type: string
            - type: 'null'
        management_company:
          anyOf:
            - type: string
            - type: 'null'
        phase_count:
          anyOf:
            - type: integer
            - type: 'null'
        building_count:
          anyOf:
            - type: integer
            - type: 'null'
        unit_count:
          anyOf:
            - type: integer
            - type: 'null'
        min_building_age:
          anyOf:
            - type: integer
            - type: 'null'
        max_building_age:
          anyOf:
            - type: integer
            - type: 'null'
        first_occupation_at:
          anyOf:
            - type: integer
            - type: 'null'
        last_occupation_at:
          anyOf:
            - type: integer
            - type: 'null'
        sale:
          anyOf:
            - $ref: '#/components/schemas/CentalinePriceTrend'
            - type: 'null'
        rent:
          anyOf:
            - $ref: '#/components/schemas/CentalinePriceTrend'
            - type: 'null'
        school_net:
          anyOf:
            - $ref: '#/components/schemas/CentalineSchoolNet'
            - type: 'null'
        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'
        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
    CentalineEstateCategory:
      type: string
      enum:
        - RE
        - HOS
        - PRH
        - Other
    CentalineFacility:
      type: string
      enum:
        - SwimmingPool
        - IndoorSwimmingPool
        - ChildrensPool
        - Gymnasium
        - ChildrenPlaygroundPlayRoom
        - PlaygroundPlayroom
        - SaunnaRoom
        - SteamBathRoom
        - Jacuzzi
        - TennisCourt
        - SquashCourt
        - BadmintonCourt
        - TableTennis
        - SnookerRoom
        - GolfDrivingRange
        - BallRoom
        - ReadingStudyRoom
    CentalineEstateSort:
      type: string
      enum:
        - Ranking
        - NUnitPrice
        - BuildingAge
    CentalinePriceTrend:
      properties:
        '@type':
          type: string
          default: CentalinePriceTrend
        saleable_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        saleable_price_per_sqft_change_percent:
          anyOf:
            - type: number
            - type: 'null'
        gross_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        gross_price_per_sqft_change_percent:
          anyOf:
            - type: number
            - type: 'null'
        min_price:
          anyOf:
            - type: number
            - type: 'null'
        max_price:
          anyOf:
            - type: number
            - type: 'null'
        min_saleable_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        max_saleable_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        transaction_count:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
    CentalineSchoolNet:
      properties:
        '@type':
          type: string
          default: CentalineSchoolNet
        primary_school_net:
          anyOf:
            - type: string
            - type: 'null'
        primary_school_url:
          anyOf:
            - type: string
            - type: 'null'
        secondary_school_district:
          anyOf:
            - type: string
            - type: 'null'
        secondary_school_url:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    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

````