← Documentation
Real Estate API
Endpoint Reference
Six endpoints for property search, detail, enrichment, full-text search, and account management.
Base URL: https://api.vitkidata.com/api/v1
GET
/v1/properties Auth required Search Properties
Search for properties by location, price, size, and more. Returns paginated results with tier-gated fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
state | string | No | 2-letter state code (e.g. TX, CA) |
city | string | No | City name |
zip | string | No | ZIP code |
property_type | string | No | Property type filter |
listing_status | string | No | Listing status filter |
min_price | number | No | Minimum price |
max_price | number | No | Maximum price |
min_beds | number | No | Minimum bedrooms |
max_beds | number | No | Maximum bedrooms |
min_sqft | number | No | Minimum square footage |
max_sqft | number | No | Maximum square footage |
min_year_built | number | No | Minimum year built (>= 1600) |
confidence | string | No | Filter by confidence: high, medium, low, single_source |
limit | number | No | Results per page (1-100, default 25) |
offset | number | No | Skip N results (default 0) |
GET
/v1/properties/:id Auth required Get Property Detail
Retrieve a single property by its unique ID. Returns all available fields for your tier.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Property UUID |
GET
/v1/search Auth required Full-Text Search
Search properties by address or description text. Supports all the same filters as the properties endpoint.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Search query (min 1 character) |
... | No | All parameters from /v1/properties also apply |
GET
/v1/properties/:id/enrichment Pro+ Auth required Get Enrichment Data
Government enrichment data for a specific property. Requires Pro or Enterprise tier.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Property UUID |
GET
/v1/account Auth required Get Account Info
Returns your account details: email, tier, subscription status, rate limits.
GET
/v1/account/usage Auth required Get Usage Stats
Returns your current month API usage, remaining quota, and billing period.
Example: Search Properties
Request
curl "https://api.vitkidata.com/api/v1/properties?state=TX&city=Austin&min_price=200000&max_price=500000&limit=2" \
-H "X-Api-Key: vtk_live_your_key_here"
Response
{
"data": {
"properties": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"address": {
"street": "1234 Oak Hill Dr",
"city": "Austin",
"state": "TX",
"zip": "78745",
"formatted": "1234 Oak Hill Dr, Austin, TX 78745"
},
"price": 425000,
"beds": 3,
"baths": 2,
"sqft": 1850,
"property_type": "Single Family",
"listing_status": "Active",
"latitude": 30.2156,
"longitude": -97.7943,
"census_tract": "48453001802",
"fips_code": "48453",
"cbsa_code": "12420",
"placekey": "zzw-222@5vg-7gv-d9q"
}
],
"total": 847,
"limit": 2,
"offset": 0
},
"meta": {
"timestamp": "2026-04-21T15:30:00.000Z"
}
}
Example: Get Enrichment (Pro+)
Request
curl "https://api.vitkidata.com/api/v1/properties/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enrichment" \
-H "X-Api-Key: vtk_live_your_key_here"
Response
{
"data": {
"government_data": {
"census_median_income": 78250,
"census_median_home_value": 385000,
"census_vacancy_rate": 0.067,
"census_population": 4523,
"crime_rate_per_1000": 24.3,
"flood_zone": "X",
"walk_score": 62,
"transit_score": 38,
"bike_score": 45,
"hpi_annual_change": 0.084,
"median_rent": 1650,
"unemployment_rate": 0.034
},
"census_tract": "48453001802",
"fips_code": "48453",
"cbsa_code": "12420",
"placekey": "zzw-222@5vg-7gv-d9q"
},
"meta": {
"timestamp": "2026-04-21T15:30:00.000Z"
}
}
Example: Account Usage
curl "https://api.vitkidata.com/api/v1/account/usage" \
-H "X-Api-Key: vtk_live_your_key_here"
{
"data": {
"tier": "pro",
"rateLimitPerMinute": 60,
"rateLimitPerMonth": 10000,
"currentMonthUsage": 2340,
"currentMonthRemaining": 7660,
"billingPeriod": {
"start": "2026-04-01T00:00:00.000Z",
"end": "2026-05-01T00:00:00.000Z"
}
},
"meta": { "timestamp": "2026-04-21T15:30:00.000Z" }
}