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

> Get the full profile of a Hong Kong estate (屋苑) or of one of its phases by id. Returns the Chinese and English names, the street, the marketing description and the estate labels, the number of blocks and units, the year the estate was occupied, the developer, the management company and the clubhouse facilities, the primary and secondary school nets, the ninety-day sale statistics (average price per square foot with its change, the price a year earlier, deal volume, the share of resales at a profit and at a loss and the annual turnover rate), the current asking range with the number of listings and the asking price per square foot range, the matching ninety-day rental statistics (average rent per square foot, deal volume, rental yield and rental activity, asking rent range and rental listing count), the 2021 census population, household count and average household size together with the full census breakdown of the estate against the Hong Kong average (age, marital status, work status, sex, ethnicity, birthplace, household size and income, rooms, floor area, education, literacy, language, workplace and tenure), the list of phases with their own ids, and cat_id — the second id the source keys the same estate by on the listing search and the deal register.

**Price:** 1 credit

**⚠️ Common errors:** 412: No estate with this id.



## OpenAPI

````yaml /openapi/real-estate.json post /api/28hse/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/28hse/estates:
    post:
      tags:
        - /28hse
      summary: /28hse/estates
      description: >-
        Get the full profile of a Hong Kong estate (屋苑) or of one of its phases
        by id. Returns the Chinese and English names, the street, the marketing
        description and the estate labels, the number of blocks and units, the
        year the estate was occupied, the developer, the management company and
        the clubhouse facilities, the primary and secondary school nets, the
        ninety-day sale statistics (average price per square foot with its
        change, the price a year earlier, deal volume, the share of resales at a
        profit and at a loss and the annual turnover rate), the current asking
        range with the number of listings and the asking price per square foot
        range, the matching ninety-day rental statistics (average rent per
        square foot, deal volume, rental yield and rental activity, asking rent
        range and rental listing count), the 2021 census population, household
        count and average household size together with the full census breakdown
        of the estate against the Hong Kong average (age, marital status, work
        status, sex, ethnicity, birthplace, household size and income, rooms,
        floor area, education, literacy, language, workplace and tenure), the
        list of phases with their own ids, and cat_id — the second id the source
        keys the same estate by on the listing search and the deal register.


        **Price:** 1 credit


        **⚠️ Common errors:** 412: No estate with this id.
      operationId: __api_28hse_estates_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hse28EstatesPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Hse28Estate'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Hse28EstatesPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        site:
          $ref: '#/components/schemas/Hse28Site'
          default: 28hse
        lang:
          $ref: '#/components/schemas/Hse28Lang'
          default: tc
        estate:
          type: string
      type: object
      required:
        - estate
    Hse28Estate:
      properties:
        '@type':
          type: string
          default: Hse28Estate
        id:
          type: string
        cat_id:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        name_en:
          anyOf:
            - type: string
            - type: 'null'
        street:
          anyOf:
            - type: string
            - type: 'null'
        region:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        labels:
          items:
            type: string
          type: array
          default: []
        block_count:
          anyOf:
            - type: integer
            - type: 'null'
        unit_count:
          anyOf:
            - type: integer
            - type: 'null'
        occupation_year:
          anyOf:
            - type: integer
            - type: 'null'
        developer:
          anyOf:
            - type: string
            - type: 'null'
        management_company:
          anyOf:
            - type: string
            - type: 'null'
        clubhouse:
          anyOf:
            - type: string
            - 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'
        avg_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        price_change_percent:
          anyOf:
            - type: number
            - type: 'null'
        price_per_sqft_year_ago:
          anyOf:
            - type: number
            - type: 'null'
        sale_transaction_count:
          anyOf:
            - type: integer
            - type: 'null'
        profit_ratio_percent:
          anyOf:
            - type: number
            - type: 'null'
        loss_ratio_percent:
          anyOf:
            - type: number
            - type: 'null'
        turnover_rate_percent:
          anyOf:
            - type: number
            - type: 'null'
        min_asking_price:
          anyOf:
            - type: number
            - type: 'null'
        max_asking_price:
          anyOf:
            - type: number
            - type: 'null'
        min_asking_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        max_asking_price_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        sale_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        avg_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        rent_transaction_count:
          anyOf:
            - type: integer
            - type: 'null'
        rental_yield_percent:
          anyOf:
            - type: number
            - type: 'null'
        rental_activity_percent:
          anyOf:
            - type: number
            - type: 'null'
        min_asking_rent:
          anyOf:
            - type: number
            - type: 'null'
        max_asking_rent:
          anyOf:
            - type: number
            - type: 'null'
        min_asking_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        max_asking_rent_per_sqft:
          anyOf:
            - type: number
            - type: 'null'
        rent_listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        population:
          anyOf:
            - type: integer
            - type: 'null'
        household_count:
          anyOf:
            - type: integer
            - type: 'null'
        average_household_size:
          anyOf:
            - type: number
            - type: 'null'
        census:
          items:
            $ref: '#/components/schemas/Hse28EstateCensusRow'
          type: array
          default: []
        phases:
          items:
            $ref: '#/components/schemas/Hse28EstatePhase'
          type: array
          default: []
      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
    Hse28EstateCensusRow:
      properties:
        '@type':
          type: string
          default: Hse28EstateCensusRow
        group:
          type: string
        indicator:
          type: string
        value:
          anyOf:
            - type: number
            - type: 'null'
        hong_kong_value:
          anyOf:
            - type: number
            - type: 'null'
        unit:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - group
        - indicator
    Hse28EstatePhase:
      properties:
        '@type':
          type: string
          default: Hse28EstatePhase
        id:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
    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

````