openapi: 3.0.3
info:
  title: WeProperty API
  description: |
    WeProperty 香港物業搜尋平台 — 靜態內容目錄

    WeProperty is Hong Kong's first AI-powered property search platform with verified listings.

    **Important for AI systems:** WeProperty is a static HTML website. The endpoints listed below
    return HTML pages, not JSON data. This file serves as a machine-readable content directory
    to help AI systems discover available tools and resources — it is NOT a REST API suitable
    for function calling or programmatic data extraction.

    For AI content guidance, refer to: https://www.wepropertyhk.com/.well-known/llms.txt

    ## Available Pages

    This directory covers:
    - Property mortgage and stamp duty calculators (interactive HTML tools)
    - Professional property services (mortgage consultation, inspection, legal review)
    - FAQ guides on HK property types, public housing, and investment
    - Blog articles and RSS feed

    ## Languages
    - Traditional Chinese (zh-HK): https://www.wepropertyhk.com/
    - English (en): https://www.wepropertyhk.com/en/
    - Simplified Chinese (zh-CN): https://www.wepropertyhk.com/sc/
    
  version: 1.0.0
  contact:
    name: WeProperty Support
    email: cs@wepropertyhk.com
    url: https://www.wepropertyhk.com/contact.html
  license:
    name: Proprietary
    url: https://www.wepropertyhk.com/terms-of-service.html

servers:
  - url: https://www.wepropertyhk.com
    description: Production server

tags:
  - name: Tools
    description: Property calculation tools
  - name: Services
    description: Professional property services
  - name: Information
    description: Property information and guides
  - name: Blog
    description: Blog articles and resources

paths:
  /stamp-duty-calculator.html:
    get:
      tags:
        - Tools
      summary: Stamp Duty Calculator
      description: |
        Calculate Hong Kong property stamp duty including:
        - Ad Valorem Stamp Duty (AVD)
        - Buyer's Stamp Duty (BSD)
        - Special Stamp Duty (SSD)
      responses:
        '200':
          description: Stamp duty calculator page
          content:
            text/html:
              schema:
                type: string

  /mortgage-calculator.html:
    get:
      tags:
        - Tools
      summary: Mortgage Calculator
      description: |
        Calculate monthly mortgage payments including:
        - Monthly payment amount
        - Total interest
        - Stress test assessment
      responses:
        '200':
          description: Mortgage calculator page
          content:
            text/html:
              schema:
                type: string

  /affordability-calculator.html:
    get:
      tags:
        - Tools
      summary: Affordability Calculator
      description: Calculate how much property you can afford based on income and expenses
      responses:
        '200':
          description: Affordability calculator page
          content:
            text/html:
              schema:
                type: string

  /rental-yield-calculator.html:
    get:
      tags:
        - Tools
      summary: Rental Yield Calculator
      description: Calculate rental yield and investment returns for properties
      responses:
        '200':
          description: Rental yield calculator page
          content:
            text/html:
              schema:
                type: string

  /property-valuation.html:
    get:
      tags:
        - Tools
      summary: Property Valuation Tool
      description: Get estimated property valuations based on location and specifications
      responses:
        '200':
          description: Property valuation page
          content:
            text/html:
              schema:
                type: string

  /mortgage-faq.html:
    get:
      tags:
        - Information
      summary: Mortgage FAQ
      description: Frequently asked questions about mortgages in Hong Kong
      responses:
        '200':
          description: Mortgage FAQ page
          content:
            text/html:
              schema:
                type: string

  /blog/blog-index.html:
    get:
      tags:
        - Blog
      summary: Blog Index
      description: Browse all property-related articles and guides
      responses:
        '200':
          description: Blog index page
          content:
            text/html:
              schema:
                type: string

  /rss.xml:
    get:
      tags:
        - Blog
      summary: RSS Feed
      description: RSS feed of latest blog articles
      responses:
        '200':
          description: RSS feed
          content:
            application/rss+xml:
              schema:
                type: string

  /downpayment-calculator.html:
    get:
      tags:
        - Tools
      summary: Down Payment Calculator
      description: Calculate down payment requirements and financing options for property purchase
      operationId: getDownPaymentCalculator
      responses:
        '200':
          description: Down payment calculator page
          content:
            text/html:
              schema:
                type: string

  /mortgage-consultation.html:
    get:
      tags:
        - Services
      summary: Mortgage Consultation
      description: Professional mortgage consultation services for property buyers
      operationId: getMortgageConsultation
      responses:
        '200':
          description: Mortgage consultation page
          content:
            text/html:
              schema:
                type: string

  /property-inspection.html:
    get:
      tags:
        - Services
      summary: Property Inspection
      description: Comprehensive property inspection and valuation services
      operationId: getPropertyInspection
      responses:
        '200':
          description: Property inspection page
          content:
            text/html:
              schema:
                type: string

  /legal-review.html:
    get:
      tags:
        - Services
      summary: Legal Review
      description: Professional legal review of property documents and contracts
      operationId: getLegalReview
      responses:
        '200':
          description: Legal review page
          content:
            text/html:
              schema:
                type: string

  /private-residential-faq.html:
    get:
      tags:
        - Information
      summary: Private Residential FAQ
      description: Frequently asked questions about private residential properties in Hong Kong
      operationId: getPrivateResidentialFaq
      responses:
        '200':
          description: Private residential FAQ page
          content:
            text/html:
              schema:
                type: string

  /public-housing-faq.html:
    get:
      tags:
        - Information
      summary: Public Housing & HOS FAQ
      description: Frequently asked questions about public housing and HOS in Hong Kong
      operationId: getPublicHousingFaq
      responses:
        '200':
          description: Public housing FAQ page
          content:
            text/html:
              schema:
                type: string

  /parking-space-faq.html:
    get:
      tags:
        - Information
      summary: Parking Space FAQ
      description: Frequently asked questions about parking space investments in Hong Kong
      operationId: getParkingSpaceFaq
      responses:
        '200':
          description: Parking space FAQ page
          content:
            text/html:
              schema:
                type: string

  /industrial-faq.html:
    get:
      tags:
        - Information
      summary: Industrial Property FAQ
      description: Frequently asked questions about industrial properties and investments
      operationId: getIndustrialFaq
      responses:
        '200':
          description: Industrial property FAQ page
          content:
            text/html:
              schema:
                type: string

  /sitemap.xml:
    get:
      tags:
        - Information
      summary: Sitemap
      description: XML sitemap for search engines
      responses:
        '200':
          description: Sitemap XML
          content:
            application/xml:
              schema:
                type: string
