Housing Market API 連携ガイド

リファレンス表、エンドポイントの説明、エラーコード、サンプルは API 仕様から生成されるため、どの言語でも英語のまま掲載しています。名前、パラメーター、コードはすべての言語で共通です。

ページネーション

すべての一覧エンドポイントはカーソルを使用します。レスポンスには data、next_cursor、has_more が含まれます。

あるレスポンスの next_cursor を次のリクエストの cursor として渡し、has_more が false になったら終了してください。

総件数やページ番号はありません。これは意図的な設計です。この API は掲載情報を検索するためのものであり、データベースを複製するためのものではありません。

limit パラメーターでページサイズを設定します。デフォルトは 50 で、100 を超えることはできません。

カーソルは不透明な値です。解析したり、独自に組み立てたり、後で使うために保存したりしないでください。カーソルはお客様のキーと、それを生成したリクエストのフィルターに紐付いており、無効なカーソルは invalid_cursor で拒否されます。

一回の巡回の中では結果の順序は一定ですが、その順序に意味はありません。順序に依存しないでください。

Response shape

FieldTypeDescription
data requiredarrayThe items on this page.
next_cursor requiredstring | nullPass as cursor to get the next page. Null on the last page.
has_more requiredbooleanFalse when there is no further page.

Request parameters

ParameterTypeRequiredValuesDescription
limitintegernodefault 50
min 1
max 100
Page size. At most the maximum shown; larger values are refused with invalid_parameter.
cursorstringnoThe next_cursor of the previous page. Opaque: do not parse it, store it, or build one. It is bound to your key and to the filters of the request that produced it, and a cursor used with different filters is refused with invalid_cursor.