API ドキュメント

カタログの助手は POST を一つだけ受けます。物件の質問はこのサイトの売却カタログだけを根拠にします。指数の動きと参考の印紙税は、公開済みの市況スナップショットと同じ税率だけを使います。価格は予測せず、投資助言ではありません。

POST /api/chat

POST /api/chat。Content-Type は application/json。本文は 8000 文字以内。プログラムは message、locale、propertyId、state を読みます。locale は zh-Hant、zh-Hans、en、ja、ko。省略すると zh-Hant。

成功時の JSON は reply、listings、suggestions、state、whatsapp_url。本文が大きすぎると 413、JSON が不正だと 400。応答は cache-control: no-store。

提携先

提携 API の説明

この API は、発行済みの API キーに対し、サイト上ですでに公開している物件欄だけを返します。

2026-10-13 · OpenAPI 2026-10-13

OpenAPI

機械可読の仕様は /api/v1/openapi にあります。以下はその同じ仕様の説明です。

/api/v1/openapi

キーと上限

Authorization ヘッダーに Bearer キーを付けます。キーは作成時に一度だけ表示されます。データベースにはハッシュだけを保存します。キーごとに1時間の上限があり、超えると 429 です。キーは取り消せます。

公開欄

物件番号、物件名、地域、地区、香港ドル参考価格、専有面積あたりの価格、住戸の説明、専有面積、間取り、階、ポイント、周辺、写真 URL、売却区分、更新日時。所有者の氏名、電話、メール、登録記録は含みません。

propertyId
estate
sectionId
districtZh
districtEn
priceHkd
pricePerSqftHkd
unitZh
saleableSqft
layoutZh
layoutEn
floorZh
floorEn
highlightsZh
nearbyZh
photos
listingType
updatedAt

公的データの更新

Rating and Valuation Department、Land Registry、Education Bureau、data.gov.hk の公開ファイルを定期的に取得し、既存の Neon データベースに出典 URL と日付とともに保存します。市況データセンターは引き続きその出典を示します。この API は原ファイルをまとめて再配布しません。

個人情報

この API は所有者や関心登録者の個人情報を提供しません。アクセス記録には発信元アドレスのハッシュ、キーの接頭辞、経路、状態コードだけを保存し、生のネットワークアドレスは保存しません。API キーは提携先の資格情報であり、所有者の記録ではありません。個人情報の取扱いは Personal Data (Privacy) Ordinance に従います。正式な条文は Privacy Commissioner のサイトにあります。

pcpd.org.hk

利用条件

価格はカタログの参考価格であり、記録は変わります。応答は評価ではなく、投資助言でも、申込みでも、契約でもありません。利用するときは commercialisation.ai を出典として示してください。キーは発行先だけが使います。このサイトはキーの取消や上限の変更ができます。応答を証券やトークンの販売として示さないでください。

OpenAPI

{
  "openapi": "3.0.3",
  "info": {
    "title": "commercialisation.ai partner listings",
    "version": "2026-10-13",
    "description": "Sale catalog reference prices in HKD for browsing. Records can change. This response is not a valuation, not investment advice, and not an offer or a contract."
  },
  "servers": [
    {
      "url": "https://commercialisation.ai"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/api/v1/listings": {
      "get": {
        "operationId": "listListings",
        "summary": "List public sale listings",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 50
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of public listing fields"
          },
          "401": {
            "description": "Missing or unknown API key"
          },
          "429": {
            "description": "Rate limit"
          }
        }
      }
    },
    "/api/v1/listings/{id}": {
      "get": {
        "operationId": "getListing",
        "summary": "Read one public sale listing",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "^M\\d+$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One public listing"
          },
          "404": {
            "description": "Unknown id"
          }
        }
      }
    }
  },
  "x-public-fields": [
    "propertyId",
    "estate",
    "sectionId",
    "districtZh",
    "districtEn",
    "priceHkd",
    "pricePerSqftHkd",
    "unitZh",
    "saleableSqft",
    "layoutZh",
    "layoutEn",
    "floorZh",
    "floorEn",
    "highlightsZh",
    "nearbyZh",
    "photos",
    "listingType",
    "updatedAt"
  ],
  "x-listing-property-types": {
    "propertyId": {
      "type": "string"
    },
    "estate": {
      "type": "string"
    },
    "sectionId": {
      "type": "string"
    },
    "districtZh": {
      "type": "string"
    },
    "districtEn": {
      "type": "string"
    },
    "priceHkd": {
      "type": "string"
    },
    "pricePerSqftHkd": {
      "type": "string"
    },
    "unitZh": {
      "type": "string"
    },
    "saleableSqft": {
      "type": "string"
    },
    "layoutZh": {
      "type": "string"
    },
    "layoutEn": {
      "type": "string"
    },
    "floorZh": {
      "type": "string"
    },
    "floorEn": {
      "type": "string"
    },
    "highlightsZh": {
      "type": "string"
    },
    "nearbyZh": {
      "type": "string"
    },
    "photos": {
      "type": "string"
    },
    "listingType": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  }
}