Skip to content
CribScore
Skip to content
CribScore Docs

API Reference

Facilities API

Five endpoints cover everything you need about a facility: search, canonical detail, side-by-side compare, predictive risk, and citable evidence.

Facility detail#

Read a canonical, source-linked record. Includes provider identity, license status, inspections, violations, evidence, score history, and the merge context CribScore used to assemble the record.

curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W" \
  -H "Authorization: Bearer YOUR_API_KEY"

Compare#

Score two or more facilities side-by-side across configurable dimensions. The response includes per-dimension deltas plus a structured recommendation suitable for embedding in a memo.

curl -X POST "https://api.cribscore.co/v1/facilities/compare" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "facility_ids": [
      "fac_01HZ8X9K2D7N3M5P0AYR4FTC2W",
      "fac_01HZ8X9P5T9Y8B3C5RW2GZK6Q"
    ],
    "dimensions": ["safety_score", "price_weekly", "license_status"]
  }'

Risk forecast#

Predictive risk surface — `horizon_days` between 7 and 90. Returns a calibrated probability plus the top contributing signals. Use this in monitoring jobs and underwriting reviews.

curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W/risk-forecast?horizon_days=30" \
  -H "Authorization: Bearer YOUR_API_KEY"

Evidence#

Citable evidence per facility — inspection PDFs, violation citations, public records — designed for agent grounding and memo generation.

curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W/evidence?limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"

Endpoint reference#

GET/v1/facilities

Search licensed facilities by geography and quality.

NameTypeRequiredDefaultDescription
zip_codestringoptional5-digit US ZIP.
state_codestringoptionalISO state code (CA, TX, NY...).
min_safety_scoreintegeroptional0-100 floor for `safety_score`.
facility_typestringoptional`center` | `home` | `school_age`.
license_statusstringoptional`active` | `expired` | `revoked`.
limitintegeroptional201-100.
offsetintegeroptional00+.
Requestbash
curl -sS "https://api.cribscore.co/v1/facilities?zip_code=90003&limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Responsejson
{
  "data": [
    {
      "id": "fac_01HZ8X9K2D7N3M5P0AYR4FTC2W",
      "name": "Sunrise Learning Center",
      "state_code": "CA",
      "facility_type": "center",
      "license_status": "active",
      "safety_score": 87,
      "source_url": "https://www.ccld.dss.ca.gov/carefacilitysearch/details/198000123"
    }
  ],
  "meta": { "limit": 5, "offset": 0, "total": 41 }
}
GET/v1/facilities/{facility_id}

Canonical, source-linked record for one facility.

NameTypeRequiredDescription
facility_idstringrequiredULID returned from search.
Requestbash
curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W" \
  -H "Authorization: Bearer YOUR_API_KEY"
Responsejson
{ "id": "...", "name": "...", "source_url": "...", "trust": { "tier": "launch_ready" } }
POST/v1/facilities/compare

Side-by-side compare across configurable dimensions.

NameTypeRequiredDescription
facility_idsstring[]required2-5 facility IDs.
dimensionsstring[]optionalDimensions to score; defaults to safety, price, license.
Requestbash
curl -X POST "https://api.cribscore.co/v1/facilities/compare" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "facility_ids": [
      "fac_01HZ8X9K2D7N3M5P0AYR4FTC2W",
      "fac_01HZ8X9P5T9Y8B3C5RW2GZK6Q"
    ],
    "dimensions": ["safety_score", "price_weekly", "license_status"]
  }'
Responsejson
{ "comparison_id": "...", "rows": [...], "summary": "..." }
GET/v1/facilities/{facility_id}/risk-forecast

Predictive risk probability with top signals.

NameTypeRequiredDefaultDescription
facility_idstringrequiredULID.
horizon_daysintegeroptional307-90 days.
Requestbash
curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W/risk-forecast?horizon_days=30" \
  -H "Authorization: Bearer YOUR_API_KEY"
Responsejson
{ "risk_probability": 0.12, "top_signals": [...] }
GET/v1/facilities/{facility_id}/evidence

Citable evidence items (inspection PDFs, violations, public records).

NameTypeRequiredDefaultDescription
facility_idstringrequiredULID.
limitintegeroptional101-50.
offsetintegeroptional00+.
Requestbash
curl -sS "https://api.cribscore.co/v1/facilities/fac_01HZ8X9K2D7N3M5P0AYR4FTC2W/evidence?limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"
Responsejson
{ "data": [...], "meta": { "limit": 5, "offset": 0, "total": 7 } }