API reference
HOAs
Endpoints for HOA entities and their restrictions.
Get HOA
GET /v1/hoas/{id}Returns details about a specific HOA entity.
Response
{
"data": {
"id": "hoa_abc123",
"name": "Desert Ridge Community Association",
"county": "Franklin",
"state": "AZ",
"document_count": 5,
"parcel_count": 342,
"created_at": "2024-01-10T08:00:00Z"
}
}Get HOA restrictions
GET /v1/hoas/{id}/restrictionsReturns all restriction facts across all documents associated with an HOA.
Query parameters
| Parameter | Type | Description |
|---|---|---|
fact_type | string | Filter by restriction type |
min_confidence | number | Minimum confidence score (0-1) |
page | integer | Page number |
per_page | integer | Items per page |
Response
{
"data": [
{
"id": "fact_abc123",
"fact_type": "pet_restriction",
"fact_value": {
"max_pets": 2,
"prohibited_animals": ["livestock", "poultry"],
"description": "No more than two (2) domestic pets per lot"
},
"confidence": 0.91,
"source_document_id": "doc_xyz789",
"citation": {
"page": 18,
"section": "Article IX, Section 2"
}
}
],
"meta": {
"total": 23,
"page": 1,
"per_page": 20
}
}