メインコンテンツへスキップ

ドキュメント

組み込みに必要なすべて

ガイド、リファレンス、仕様はひとつの OpenAPI ファイルから生成されるため、常に一致しています。識別子はどの言語でも同じです。

  • 導入ガイド

    キーの取得、認証、フィルター、ページネーション、上限、エラーを、お使いの言語で解説します。

    ガイドを開く

  • OpenAPI 仕様

    リファレンスの生成元となる OpenAPI 3.1 ファイルです。コードジェネレーターや API ツールでご利用いただけます。

    仕様をダウンロード

  • PDF ガイド

    導入ガイドをひとつの文書にまとめたものです。オフラインで読んだり、チームと共有したりできます。

    PDF をダウンロード

ドキュメントは公開されています。キーが必要なのは API を呼び出すときだけです。

クイックスタート

キーと、当社側で見えているアドレスを確認する
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
ある国の物件情報の最初のページを読む
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

概要

ベース URL
https://api.housingmarketapi.com
認証
x-api-key ヘッダーでキーを送信します。送信元は、そのキーに登録されたサーバーアドレスである必要があります。

エンドポイント

エンドポイントティア説明
GET /v1/pingスタンダード登録されたアドレスからキーが機能することを確認し、そのアドレスを返します。
GET /v1/propertiesスタンダードキーの対象となっている国の公開中の物件情報を、一ページずつ返します。
GET /v1/insights/*アドバンスト場所と期間ごとに集計された市場データ。アドバンストのキーが対象です。近日対応：これらのエンドポイントはまだ提供されていません。

エラーコード

すべてのエラーには HTTP ステータスと、以下のいずれかのコードが含まれます。分岐はメッセージではなくコードで行ってください。

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
API キーを取得料金を見る