@propertyriskscoring/sdk — TypeScript SDK

Zero-dependency TypeScript SDK for the Property Risk Scoring API (PRS) — 30 hazard / building / climate risk types for Japanese real estate.

• 🌐 Production endpoint: https://api.propriskapi.com
• 📖 OpenAPI spec: https://propriskapi.com/openapi.json
• 📨 Postman collection: https://propriskapi.com/postman_collection.json
• 💸 Free tier: 100 calls/month, no credit card

Installation

npm install @propertyriskscoring/sdk
# or
pnpm add @propertyriskscoring/sdk
yarn add @propertyriskscoring/sdk

Requires Node.js >= 18 (uses native fetch).

Quick Start

import { RiskClient } from '@propertyriskscoring/sdk';

const client = new RiskClient({ apiKey: process.env.PRS_API_KEY! });

// 1. Score by coordinates (lat/lon)
const result = await client.score({
  lat: 35.6895,
  lon: 139.6917,
  property: { purchase_price: 50_000_000 },
});

console.log(result.composite.central);          // 0-100 composite score
console.log(result.composite.grade);            // "A"-"E"
console.log(result.composite.total_eal_pct);    // expected annual loss %
console.log(result.composite.total_eal_yen);    // expected annual loss in JPY
console.log(result.risks.earthquake.score?.central);
console.log(result.risks.flood_external.score?.central);

// 2. Score by address (uses GSI geocoding internally)
const byAddress = await client.scoreByAddress('東京都新宿区西新宿2-8-1');

// 3. Batch (Pro / Enterprise — Idempotency-Key supported)
const batch = await client.scoreBatch(
  {
    properties: [
      { lat: 35.6895, lon: 139.6917 },
      { lat: 34.6937, lon: 135.5023 },
    ],
  },
  { idempotencyKey: crypto.randomUUID() },
);

Plans

| Plan | Includes | Price | |---|---|---| | Free | facts + metrics + score (5 core hazards) | 0円/月 (100 calls) | | Starter | + 30 categories | 9,800円/月 (500 calls) | | Pro | + composite + EAL 円建て + batch 20 | 29,800円/月 (2,000 calls) | | Enterprise | + supplementary + DWH share + SLA | 198,000円/月〜 |

See https://propriskapi.com/pricing for details.

Response Transparency Fields (L0)

Every risk entry includes:

• data_status: available / partial / api_unavailable / db_unavailable / no_source
• source_type: primary_data / partial_data / proxy / qualitative
• confidence: HIGH / MEDIUM / LOW
• proxy_notice: human-readable explanation when data is degraded

const earthquake = result.risks.earthquake;
if (earthquake.data_status !== 'available') {
  console.warn(`Earthquake risk degraded: ${earthquake.proxy_notice}`);
}

License

MIT — see LICENSE.

Support

• Issues: https://github.com/shoeiiwaya/Real-estate-risk-assessment/issues
• Email: [email protected]