client-library

不動産情報ライブラリAPIクライアント設計ガイド

APIキー管理パターン

1. 基本的なクライアント設計

import os
from typing import Optional, Dict, Any, Union
import httpx
from pydantic import BaseModel

class ReinfiolibClient:
    """不動産情報ライブラリAPIクライアント"""
    
    def __init__(
        self, 
        api_key: Optional[str] = None,
        base_url: str = "https://www.reinfolib.mlit.go.jp/ex-api/external",
        timeout: int = 30
    ):
        """
        クライアントを初期化します。
        
        Args:
            api_key: APIキー（Noneの場合は環境変数REINFOLIB_API_KEYを使用）
            base_url: APIベースURL
            timeout: リクエストタイムアウト（秒）
        """
        self.api_key = api_key or os.getenv("REINFOLIB_API_KEY")
        if not self.api_key:
            raise ValueError("APIキーが設定されていません。引数で指定するか、環境変数REINFOLIB_API_KEYを設定してください。")
        
        self.base_url = base_url
        self.timeout = timeout
        self._client = httpx.AsyncClient(
            headers={"Ocp-Apim-Subscription-Key": self.api_key},
            timeout=timeout
        )

2. 環境変数による設定

# .env ファイル例
REINFOLIB_API_KEY=your_api_key_here

# 使用例
from dotenv import load_dotenv
load_dotenv()

# 環境変数から自動取得
client = ReinfiolibClient()

# 直接指定
client = ReinfiolibClient(api_key="your_api_key")

レスポンスモデル定義

基本レスポンスモデル

from pydantic import BaseModel, Field
from typing import List, Optional, Any
from datetime import datetime

class RealEstateTransaction(BaseModel):
    """不動産取引情報モデル"""
    prefecture: str = Field(description="都道府県名")
    city: str = Field(description="市区町村名")
    district: Optional[str] = Field(None, description="地区名")
    price: Optional[int] = Field(None, description="取引価格（円）")
    area: Optional[float] = Field(None, description="面積（㎡）")
    unit_price: Optional[int] = Field(None, description="㎡単価（円）")
    transaction_period: Optional[str] = Field(None, description="取引時期")
    building_year: Optional[str] = Field(None, description="建築年")
    structure: Optional[str] = Field(None, description="構造")
    usage: Optional[str] = Field(None, description="用途")

class RealEstateSearchResult(BaseModel):
    """不動産検索結果モデル"""
    data: List[RealEstateTransaction]
    total_count: int
    page: int
    per_page: int

class LandPricePoint(BaseModel):
    """地価公示・調査ポイントモデル"""
    point_name: str = Field(description="地点名")
    address: str = Field(description="住所")
    price_per_sqm: int = Field(description="㎡単価（円）")
    year: int = Field(description="調査年")
    longitude: float = Field(description="経度")
    latitude: float = Field(description="緯度")