Spec

Code snippets

curl "https://api.oanor.com/realestate-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/realestate-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/realestate-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/realestate-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "notes": "Money in, ratios out — use one consistent currency. NOI is before debt; cash-on-cash and DSCR add financing. For pure loan amortization use a loan API; for DCF/NPV use an investment-appraisal API.",
        "service": "realestate-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/metrics": "Quick screening ratios — 1% rule, gross yield, GRM, price per sqft.",
            "GET /v1/cap-rate": "NOI, capitalization rate and GRM (unlevered).",
            "GET /v1/cash-flow": "Financed analysis: mortgage payment, cash-on-cash return, DSCR, LTV."
        },
        "description": "Real-estate investment maths: cap rate, NOI, cash-on-cash return, DSCR, GRM and screening ratios."
    },
    "meta": {
        "timestamp": "2026-06-05T19:50:10.316Z",
        "request_id": "ac415721-d5ba-48e3-978b-61c3fe191116"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}