elefymove
ドキュメント

開発者ドキュメント

ElefyMove Open APIのガイドとリファレンス。

これらのガイドは現在英語のみで提供されています。

Endpoints

メソッドエンドポイントスコープ内容
POST/api/public/v1/listingslistings:write新しいリスティングを審査に提出します。対応する 9 言語のうち任意の言語で内容を登録できます。
GET/api/public/v1/listingslistings:readこのキーが保有するリスティングと、その審査ステータスを一覧します。
GET/api/public/v1/listings/{externalId}listings:read指定した外部 ID で自社のリスティングを 1 件取得します。
PATCH/api/public/v1/listings/{externalId}listings:write自社のリスティングを更新します。送信しなかった項目は変更されません。
DELETE/api/public/v1/listings/{externalId}listings:write自社のリスティングを掲載停止にします。
POST/api/public/v1/listings/{externalId}/photoslistings:writeリスティングに写真を1枚追加します。完全な更新は不要です。画像はElefyMoveが取得して再ホスティングし、送信したURLがそのまま保存されることはありません。
DELETE/api/public/v1/listings/{externalId}/photos/{photoId}listings:writeリスティングから写真を1枚削除します。公開中のリスティングの写真枚数が最低枚数を下回る場合は400で拒否されます。

How listings work

  • You identify each listing by your own externalId — ElefyMove never asks you to store its internal ids.
  • Content is multilingual: submit any subset of the 9 supported locales, and ElefyMove serves the right language to each visitor.
  • New and updated listings pass moderation before going live. Subscribe to listing.approved / listing.rejected webhooks instead of polling for status.
  • PATCH is a partial update — any field you omit is left unchanged. DELETE unlists (it does not erase history).
  • Add or remove a single photo without a full PATCH round-trip. A photo you submit as a URL is fetched and re-hosted by ElefyMove — your URL is never stored or linked directly.
  • Removing a photo is refused with a MIN_PHOTOS_REQUIRED 400 if it would drop a currently-published listing below the minimum photo count.
  • Listings sourced through the API link back to their canonical page on elefymove.com.

Reference data

These routes need no scope — any valid key can read them. They expose the exact enum, locale, and currency values POST /listings validates against, and the canonical location hierarchy, so you never have to hard-code or guess them:

メソッドエンドポイントスコープ内容
GET/api/public/v1/locations有効なキーであれば可県 → 郡・区 → エリアの正規の地域階層ツリーを取得します。
GET/api/public/v1/locations/search有効なキーであれば可正規の地域階層に対するインクリメンタル検索を行います。
GET/api/public/v1/reference/property-types有効なキーであれば可リスティングが受け付ける物件タイプの値を一覧します。
GET/api/public/v1/reference/amenities有効なキーであれば可アメニティが満たすべき文字数・件数の上限を返します。アメニティは固定リストではなく自由記述です。
GET/api/public/v1/reference/locales有効なキーであれば可リスティングの翻訳が受け付けるロケールコードを一覧します。
GET/api/public/v1/reference/currencies有効なキーであれば可リスティングの価格に使われる通貨。ElefyMoveはタイのみで展開しているため、常にTHB（タイバーツ）です。

amenities has no fixed catalog — it is free text validated only by a count and a per-item length limit. GET /reference/amenities returns those limits with an empty values array and freeText: true; do not treat the empty array as "no amenities allowed".