Documentation
Everything you need to integrate Vitki Data's real estate API into your application.
Real Estate API Live
Property search, detail, enrichment, full-text search, account & usage endpoints.
Jobs API Live
Job postings, salary data, and employer signals via REST API.
API Reference Try It
Interactive OpenAPI reference. Browse endpoints, view schemas, and test requests live.
Postman Collection
Download the pre-configured Postman collection. Import and start testing immediately.
Changelog
Release history, new endpoints, schema changes, and deprecation notices.
Base URL
All API requests use the following base URL:
All endpoints require HTTPS. HTTP requests are rejected.
Authentication
Authenticate every request by including your API key in the X-Api-Key header.
API keys use the vtk_live_ prefix.
You receive your API key on the checkout success page immediately after purchase. Store it securely — it is shown only once.
Rate Limits
Rate limits depend on your subscription tier:
| Tier | Requests | Monthly Quota | Notes |
|---|---|---|---|
| Starter (no card) | 5 req/min | 50 / mo | Permanent |
| Starter | 15 req/min | 2,500 / mo | |
| Pro | 60 req/min | 10,000 / mo | |
| Enterprise | 200 req/min | 50,000 / mo |
When you exceed the rate limit, the API returns 429 Too Many Requests with a
Retry-After header indicating how many seconds to wait.
Error Format
All errors return a consistent JSON structure:
| Status | Code | Meaning |
|---|---|---|
400 | VALIDATION_ERROR | Invalid request parameters |
401 | UNAUTHORIZED | Missing or invalid API key |
403 | FORBIDDEN | Tier doesn't have access to this resource |
404 | NOT_FOUND | Resource not found |
429 | RATE_LIMIT_EXCEEDED | Too many requests |
500 | INTERNAL_ERROR | Server error — contact support |
Pagination
List endpoints support limit and offset query parameters for pagination.
| Parameter | Type | Default | Range |
|---|---|---|---|
limit | integer | 25 | 1–100 |
offset | integer | 0 | 0+ |
Responses include total, limit, and offset fields so you can calculate the number of pages.
Tier-Gated Fields
Some response fields are only available on higher tiers:
| Field Group | Starter | Pro | Enterprise |
|---|---|---|---|
| Address, price, beds, baths, sqft | Yes | Yes | Yes |
| Listing status & property type | Yes | Yes | Yes |
| Price history & tax history | — | Yes | Yes |
| Government enrichment (48 fields) | — | Yes | Yes |
| Data quality & confidence scores | — | Yes | Yes |
| Raw record | — | — | Yes |