ARED-MBR-001 · Phase 16 · Gateway v1.1

API reference

A metered market-baseline gateway for approved data partners. Every call authenticates with an issued key and counts against that key's daily cap.

Endpoint

POST /functions/apiGateway

Single resource endpoint

Auth

Bearer key

Header or payload field

Metering

Daily cap per key

Reset at midnight UTC

Model

$0 commission

Direct transactions only

Calling the gateway

All requests are POST with a JSON body. The base URL is:

https://careful-direct-estate-flow.base44.app/functions/apiGateway

Authentication uses the issued bearer token. Clients that cannot set headers may pass the same token as a key field in the body.

# Bearer header (preferred)
curl -X POST https://careful-direct-estate-flow.base44.app/functions/apiGateway \
  -H "Authorization: Bearer ared_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "resource": "meta" }'

Keys are issued directly by the platform — there is no self-serve signup. Access is free during validation; approved partners receive an ared_live_… key with a daily cap.

Errors & limits

401Missing or invalid API key — send 'Authorization: Bearer <ared_live_…>' or a 'key' field.

403The key has been revoked.

400Unknown resource, or a bulk request beyond the 100-id bound — available resources are meta, markets, market, bulk.

404Unknown market id — the response lists all known ids.

429Daily call cap reached — the counter resets on the first call of the next calendar day.

Metering is enforced per key, per calendar day (UTC). The meta resource reports your remaining allowance on every call, and the bulk resource meters one call per requested id.

Treat issued keys as bearer credentials — store them server-side, and request rotation from the platform if a key may have been exposed.

Resources

meta

Platform identity, model, coverage statement, and this key's remaining daily allowance.

Request

{ "resource": "meta", "key": "<ared_live_…>" }

Response (excerpt)

{
  "platform": "AllRealEstateDirect",
  "api_version": "1.1",
  "model": "$0 commission, direct transactions only",
  "resources": ["meta", "markets", "market", "bulk"],
  "coverage": "Statewide Texas ingest is live for all 254 counties; …",
  "rate_limit": { "daily_cap": 500, "calls_remaining_today": 499 },
  "disclaimer": "…"
}

markets

All deep-tier market baselines — median list, price per square foot, days on market, MoM trend, and distress signal, as county-level records.

Request

{ "resource": "markets", "key": "<ared_live_…>" }

Response (excerpt)

{
  "count": 50,
  "markets": [
    {
      "id": "travis",
      "name": "Travis County, TX",
      "median_list": "$545K",
      "price_per_sqft": "$312",
      "days_on_market": "47",
      "trend_mom": "+2.4%",
      "distress": "176 active distress signals",
      "tier": "deep"
    }
  ],
  "disclaimer": "…"
}

market

A single deep-tier market baseline by county id. Unknown ids return 404 with the list of known ids.

Request

{ "resource": "market", "id": "travis", "key": "<ared_live_…>" }

Response (excerpt)

{
  "id": "travis",
  "name": "Travis County, TX",
  "median_list": "$545K",
  "price_per_sqft": "$312",
  "days_on_market": "47",
  "trend_mom": "+2.4%",
  "distress": "176 active distress signals",
  "tier": "deep",
  "disclaimer": "…"
}

bulk

Batch up to 100 county ids in one call — duplicates are collapsed and unknown ids are returned in an unknown list. The request meters one call per requested id against the key's daily cap.

Request

{ "resource": "bulk", "ids": ["travis", "collin", "harris", "atlantis"], "key": "<ared_live_…>" }

Response (excerpt)

{
  "count": 3,
  "unknown": ["atlantis"],
  "markets": [
    { "id": "travis", "…": "market baseline record" }
  ],
  "metered_calls": 4,
  "rate_limit": { "daily_cap": 500, "calls_remaining_today": 495 },
  "disclaimer": "…"
}

Webhooks

Registered endpoints receive the researched county intel baseline snapshot once per night after the research pass, as a signed POST — only counties with a completed intel report are included, never synthetic figures. Registration and per-endpoint signing secrets are issued by the platform — there is no self-serve signup.

Delivery headers

Content-Type: application/json
User-Agent: ARED-Gateway-Webhook/1.0
X-ARED-Event: market_baseline.updated
X-ARED-Generated-At: 2026-09-08T19:05:00.000Z
X-ARED-Signature: sha256=<hex>

Verifying the signature

// Node example — rawBody is the
// unparsed request body as a string
const expected = crypto
  .createHmac('sha256', SECRET)
  .update(`${generatedAt}.${rawBody}`)
  .digest('hex');

const ok = `sha256=${expected}` ===
  req.headers['x-ared-signature'];

Signature input is the X-ARED-Generated-At header, a literal period, and the raw request body. Always verify before trusting the payload, and reject generated-at timestamps older than your tolerance window.

Event payload (excerpt)

{
  "event": "market_baseline.updated",
  "api_version": "1.0",
  "generated_at": "2026-09-08T19:05:00.000Z",
  "markets": [
    {
      "id": "travis",
      "name": "Travis County, TX",
      "median_list": "$545K",
      "price_per_sqft": "$312",
      "days_on_market": "47",
      "trend_yoy": "+2.4% YoY",
      "distress": "41 verified distress filing(s) on the county ledger",
      "as_of": "2026-09-08T19:05:00.000Z",
      "tier": "researched"
    }
  ],
  "…": "every county with a researched intel report"
}

OpenAPI specification

The gateway contract in machine-readable OpenAPI 3.1 — request and response schemas, error codes, market id enum, and metering semantics. Download it for code generation, client SDKs, and API tooling.

Data disclosure

ARED market figures are synthetic validation data for the approved-baseline draft — informational use only, not brokerage, appraisal, lending, legal or investment advice. Deep-tier coverage currently spans the 50 markets listed under the markets resource; the statewide Texas county roster covers all 254 counties. Exact recipe formulas, thresholds and source weights remain protected as trade secrets.