API v1.0 — Public Beta

退去費用AI診断 API

退去時の原状回復費用を国交省ガイドラインに基づき適正診断するAPI。無料で利用可能。出典リンクの表記をお願いします。

# Quick Start

curl

curl "https://taikyo.xyz/api/v1/estimate?room_type=1LDK&tenancy_years=3&total_claimed=300000"

Response

{
  "status": "ok",
  "data": {
    "total_claimed": 300000,
    "estimated_fair_cost": 85000,
    "potential_reduction": 215000,
    "reduction_rate": 0.717,
    "breakdown": {
      "wall_repair": 30000,
      "floor_repair": 25000,
      "cleaning": 20000,
      "other": 10000
    },
    "guideline_reference": "国土交通省ガイドライン",
    "room_type": "1LDK",
    "tenancy_years": 3,
    "currency": "JPY"
  },
  "meta": {
    "api_version": "1.0",
    "source": "https://taikyo.xyz"
  }
}

# Authentication

認証不要。APIキーなしで利用できます。すべてのエンドポイントはパブリックアクセス可能です。

# Endpoints

GETPOST/api/v1/estimate

退去費用の適正額を診断します。GETはクエリパラメータ、POSTはJSONボディで送信。POSTでは請求項目の詳細（items）を送信可能。

GET/api/v1/categories

退去費用の請求項目カテゴリ一覧と、ガイドラインに基づく耐用年数データを取得します。

# Parameters

Name	Type	Required	Description	Example
`room_type`	string	required	間取り（1R / 1K / 1DK / 1LDK / 2K / 2DK / 2LDK / 3LDK+）	1LDK
`tenancy_years`	number	required	居住年数	3
`total_claimed`	number	required	請求された退去費用（円）	300000
`has_special_clause`	boolean	optional	特約条項の有無	false
`items`	array	optional	請求項目の詳細（POST only）— [{name, amount, category}]	[{"name":"壁紙張替","amount":80000...

# Response Format

200 OK — application/json

{
  "status": "ok",
  "data": {
    "total_claimed": 300000,
    "estimated_fair_cost": 85000,
    "potential_reduction": 215000,
    "reduction_rate": 0.717,
    "breakdown": {
      "wall_repair": 30000,
      "floor_repair": 25000,
      "cleaning": 20000,
      "other": 10000
    },
    "guideline_reference": "国土交通省ガイドライン",
    "room_type": "1LDK",
    "tenancy_years": 3,
    "currency": "JPY"
  },
  "meta": {
    "api_version": "1.0",
    "source": "https://taikyo.xyz"
  }
}

400 Bad Request

{
  "status": "error",
  "error": {
    "code": "INVALID_PARAMS",
    "message": "room_type is required. total_claimed must be a positive number"
  }
}

# Rate Limits

100

requests / minute

IPアドレスごとに1分間100リクエストまで。制限を超えた場合は429 Too Many Requestsが返されます。

# Attribution

APIを利用する際は、出典リンクの表記をお願いします。以下のHTMLスニペットをご利用ください。

HTML

<a href="https://taikyo.xyz" target="_blank" rel="noopener">
  退去費用データ提供: taikyo.xyz
</a>

# Code Examples

JavaScript (fetch)

const params = new URLSearchParams({
  room_type: '1LDK',
  tenancy_years: '3',
  total_claimed: '300000',
});

const res = await fetch(`https://taikyo.xyz/api/v1/estimate?${params}`);
const data = await res.json();

console.log(data.data.potential_reduction);
// => 215000

Python (requests)

import requests

resp = requests.get("https://taikyo.xyz/api/v1/estimate", params={
    "room_type": "1LDK",
    "tenancy_years": 3,
    "total_claimed": 300000,
})
data = resp.json()

print(data["data"]["potential_reduction"])
# => 215000

PHP

<?php
$query = http_build_query([
    'room_type'     => '1LDK',
    'tenancy_years' => 3,
    'total_claimed'  => 300000,
]);

$json = file_get_contents("https://taikyo.xyz/api/v1/estimate?{$query}");
$data = json_decode($json, true);

echo $data['data']['potential_reduction'];
// => 215000