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

> Get the full profile of a Hong Kong residential estate (屋苑) by its Centaline type code. Returns the estate name in Chinese and English, address and prose description, ownership category, developer and management company, phase/building/unit counts, first and last occupation dates, walking time to the MTR, clubhouse facilities and category labels, current sale and rent price levels with month-on-month trend and listing and transaction counts, the Centaline adjusted price and rent per sq ft with the rental yield, the phase list with per-phase listing counts, 2021 census figures for the surrounding area (population, households, median age, income, rent, mortgage, spoken language, education and tenure), the school nets, the district hierarchy, the agents and branches that cover the estate, photos, site floor plans and coordinates.

**Price:** 1 credit

**⚠️ Common errors:** 412: No Centaline estate with this type code.



## OpenAPI

````yaml /openapi/real-estate.json post /api/centaline/estates
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:
    post:
      tags:
        - /centaline
      summary: /centaline/estates
      description: >-
        Get the full profile of a Hong Kong residential estate (屋苑) by its
        Centaline type code. Returns the estate name in Chinese and English,
        address and prose description, ownership category, developer and
        management company, phase/building/unit counts, first and last
        occupation dates, walking time to the MTR, clubhouse facilities and
        category labels, current sale and rent price levels with month-on-month
        trend and listing and transaction counts, the Centaline adjusted price
        and rent per sq ft with the rental yield, the phase list with per-phase
        listing counts, 2021 census figures for the surrounding area
        (population, households, median age, income, rent, mortgage, spoken
        language, education and tenure), the school nets, the district
        hierarchy, the agents and branches that cover the estate, photos, site
        floor plans and coordinates.


        **Price:** 1 credit


        **⚠️ Common errors:** 412: No Centaline estate with this type code.
      operationId: __api_centaline_estates_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CentalineEstatesPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CentalineEstate'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CentalineEstatesPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        lang:
          $ref: '#/components/schemas/CentalineLang'
          default: hk
        estate:
          type: string
      type: object
      required:
        - estate
    CentalineEstate:
      properties:
        '@type':
          type: string
          default: CentalineEstate
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        name_en:
          anyOf:
            - type: string
            - type: 'null'
        phase_name:
          anyOf:
            - type: string
            - type: 'null'
        phase_name_en:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        estate_usage:
          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'
        first_occupation_at:
          anyOf:
            - type: integer
            - type: 'null'
        last_occupation_at:
          anyOf:
            - type: integer
            - type: 'null'
        mtr_station:
          anyOf:
            - type: string
            - type: 'null'
        mtr_walk_minutes:
          anyOf:
            - type: integer
            - type: 'null'
        facilities:
          items:
            type: string
          type: array
          default: []
        category_labels:
          items:
            type: string
          type: array
          default: []
        sale:
          anyOf:
            - $ref: '#/components/schemas/CentalinePriceTrend'
            - type: 'null'
        rent:
          anyOf:
            - $ref: '#/components/schemas/CentalinePriceTrend'
            - type: 'null'
        adjusted_sale_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        adjusted_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        rental_yield:
          anyOf:
            - type: number
            - type: 'null'
        phases:
          items:
            $ref: '#/components/schemas/CentalineEstatePhase'
          type: array
          default: []
        agents:
          items:
            $ref: '#/components/schemas/CentalineAgent'
          type: array
          default: []
        branches:
          items:
            $ref: '#/components/schemas/CentalineBranch'
          type: array
          default: []
        census:
          anyOf:
            - $ref: '#/components/schemas/CentalineEstateCensus'
            - type: 'null'
        school_net:
          anyOf:
            - $ref: '#/components/schemas/CentalineSchoolNet'
            - type: 'null'
        scope:
          anyOf:
            - $ref: '#/components/schemas/CentalineScope'
            - type: 'null'
        bookmark_count:
          anyOf:
            - type: integer
            - type: 'null'
        floor_plan_count:
          anyOf:
            - type: integer
            - type: 'null'
        floor_plans:
          items:
            type: string
          type: array
          default: []
        images:
          items:
            type: string
          type: array
          default: []
        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
    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
    CentalineEstatePhase:
      properties:
        '@type':
          type: string
          default: CentalineEstatePhase
        id:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        sale_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        rent_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
      type: object
      required:
        - id
    CentalineAgent:
      properties:
        '@type':
          type: string
          default: CentalineAgent
        id:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        name_en:
          anyOf:
            - type: string
            - type: 'null'
        license:
          anyOf:
            - type: string
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        email:
          anyOf:
            - type: string
            - type: 'null'
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
        branch_name:
          anyOf:
            - type: string
            - type: 'null'
        listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        rating:
          anyOf:
            - type: number
            - type: 'null'
        experience:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    CentalineBranch:
      properties:
        '@type':
          type: string
          default: CentalineBranch
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        branch_code:
          anyOf:
            - type: string
            - type: 'null'
        branch_name:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        fax:
          anyOf:
            - type: string
            - type: 'null'
        manager_name:
          anyOf:
            - type: string
            - type: 'null'
        manager_name_en:
          anyOf:
            - type: string
            - type: 'null'
        manager_id:
          anyOf:
            - type: string
            - type: 'null'
        agent_count:
          anyOf:
            - type: integer
            - type: 'null'
        listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        sale_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        rent_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        scope:
          anyOf:
            - $ref: '#/components/schemas/CentalineScope'
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
    CentalineEstateCensus:
      properties:
        '@type':
          type: string
          default: CentalineEstateCensus
        statistical_year:
          anyOf:
            - type: integer
            - type: 'null'
        population:
          anyOf:
            - type: number
            - type: 'null'
        household_count:
          anyOf:
            - type: number
            - type: 'null'
        median_age:
          anyOf:
            - type: number
            - type: 'null'
        average_household_size:
          anyOf:
            - type: number
            - type: 'null'
        median_household_income:
          anyOf:
            - type: number
            - type: 'null'
        median_monthly_rent:
          anyOf:
            - type: number
            - type: 'null'
        median_rent_to_income_ratio:
          anyOf:
            - type: number
            - type: 'null'
        median_mortgage_payment:
          anyOf:
            - type: number
            - type: 'null'
        median_mortgage_to_income_ratio:
          anyOf:
            - type: number
            - type: 'null'
        cantonese_speaking_percent:
          anyOf:
            - type: number
            - type: 'null'
        putonghua_speaking_percent:
          anyOf:
            - type: number
            - type: 'null'
        english_speaking_percent:
          anyOf:
            - type: number
            - type: 'null'
        tertiary_education_percent:
          anyOf:
            - type: number
            - type: 'null'
        secondary_education_percent:
          anyOf:
            - type: number
            - type: 'null'
        primary_education_percent:
          anyOf:
            - type: number
            - type: 'null'
        owner_occupied_percent:
          anyOf:
            - type: number
            - type: 'null'
        owner_occupied_with_mortgage_percent:
          anyOf:
            - type: number
            - type: 'null'
        rented_percent:
          anyOf:
            - type: number
            - 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
    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

````