Locus Fair Market Rents

{
  "caveats": [
    "Fair Market Rents are HUD program parameters (40th/50th percentile gross rents), not market listings or rent advice."
  ],
  "configured": true,
  "data": {
    "data": {
      "area_name": "Raleigh-Cary, NC MSA",
      "basicdata": [
        {
          "Efficiency": 1489,
          "Four-Bedroom": 2823,
          "One-Bedroom": 1552,
          "Three-Bedroom": 2103,
          "Two-Bedroom": 1689,
          "zip_code": "MSA level"
        },
        {
          "Efficiency": 1060,
          "Four-Bedroom": 1980,
          "One-Bedroom": 1080,
          "Three-Bedroom": 1500,
          "Two-Bedroom": 1220,
          "zip_code": "27501"
        }
      ],
      "counties_msa": "",
      "county_name": "Wake County, NC",
      "metro_name": "Raleigh-Cary, NC",
      "metro_status": "1.0",
      "smallarea_status": "1",
      "town_name": "",
      "year": "2027"
    }
  },
  "entityId": "3718399999",
  "note": "Awareness/diagnostic only. Full briefs are x402-paid. Agents can discover live free tools at https://api.locus.report/tools/list and paid tools, prices, and manifests at https://api.locus.report/.well-known/ai-tool/index.json.",
  "ok": true,
  "provenance": {
    "coverage": "national, by county or metro, annual by fiscal year",
    "serviceUrl": "https://www.huduser.gov/hudapi/public/fmr",
    "source": "HUD USER Fair Market Rents API",
    "sourcePage": "https://www.huduser.gov/portal/dataset/fmr-api.html"
  },
  "verifyNext": [
    {
      "step": "FMR methodology and documentation.",
      "url": "https://www.huduser.gov/portal/datasets/fmr.html"
    }
  ]
}

# bash or zsh: see the payment challenge. Nothing is charged.
curl -sS -g -i -X POST 'https://api.locus.report/api/locus-fair-market-rents' \
  -H 'content-type: application/json' \
  --data-raw '{"address":"1 E Edenton St, Raleigh, NC 27601"}'

# x402 v2 sends the challenge base64-encoded in the PAYMENT-REQUIRED header (v1 sends it in the body).
# To read the header:
curl -sS -g -o /dev/null -D - -X POST 'https://api.locus.report/api/locus-fair-market-rents' \
  -H 'content-type: application/json' \
  --data-raw '{"address":"1 E Edenton St, Raleigh, NC 27601"}' \
  | grep -i '^payment-required:' | cut -d' ' -f2 | tr -d '\r' | base64 --decode

// npm i @x402/fetch @x402/evm viem
import { wrapFetchWithPayment, x402Client } from "@x402/fetch";
import { registerExactEvmScheme } from "@x402/evm/exact/client";
import { privateKeyToAccount } from "viem/accounts";

// Pays at most $0.05 per call.
const client = new x402Client().setSpendControls({ maxAmountPerPayment: "$0.05" });
registerExactEvmScheme(client, { signer: privateKeyToAccount(process.env.EVM_PRIVATE_KEY) });
const pay = wrapFetchWithPayment(fetch, client);

// Not sure it's safe to pay? ToolVet checks it first for $0.005. Pay for that from a separate
// client: this one is capped at $0.05 per payment. GET https://toolvet.app/api/v1/check?url=https%3A%2F%2Fapi.locus.report%2Fapi%2Flocus-fair-market-rents&method=POST
const res = await pay("https://api.locus.report/api/locus-fair-market-rents", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "address": "1 E Edenton St, Raleigh, NC 27601"
  }),
});
console.log(res.status, await res.text());

# pip install "x402[requests,evm]"
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http.clients import x402_requests
from x402.mechanisms.evm import EthAccountSigner
from x402.mechanisms.evm.exact.register import register_exact_evm_client

# Pays at most $0.05 per call.
client = x402ClientSync().set_spend_controls({"max_amount_per_payment": "$0.05"})
register_exact_evm_client(client, EthAccountSigner(Account.from_key(os.environ["EVM_PRIVATE_KEY"])))

with x402_requests(client) as session:
    res = session.post(
        "https://api.locus.report/api/locus-fair-market-rents",
        json={
            "address": "1 E Edenton St, Raleigh, NC 27601",
        },
    )
    print(res.status_code, res.text)