Quick Start

Get started with our API in minutes. All you need is an API key.

  1. Obtain your API key from the provider
  2. Make requests to our endpoints with your API key
  3. Use filters to get the exact data you need
GET /v3/get_property
Example Request
GET /v3/get_property?state_code=PA&api_key=YOUR_API_KEY

GET /v3/get_property_details?property_id=3077408827&api_key=YOUR_API_KEY

Authentication

All API requests require an API key passed as a query parameter.

API Key

Include your API key in every request as a query parameter:

Query Parameter
?api_key=YOUR_API_KEY_HERE
Important: Never share your API key publicly or commit it to version control.

API Endpoints

Explore our available endpoints and their capabilities.

GET /v3/get_property

Get Property

Search and filter properties using various criteria. Returns full property details matching your filters. Note: The state_code parameter is required for this endpoint.

Parameters

Parameter Type Description Required
api_key string Your API key Required
state_code string Filter by state code (e.g., PA, CA, NY, TX). Must be exactly 2 uppercase letters. Required
property_id string Filter by property ID Optional
city string Filter by city (case-insensitive) Optional
postal_code string Filter by ZIP code Optional
status string Property status: for_sale, for_rent, sold, etc. Optional
property_type string Type: single_family, condos, townhomes, etc. Optional
price_min integer Minimum list price Optional
price_max integer Maximum list price Optional
sqft_min integer Minimum square feet Optional
sqft_max integer Maximum square feet Optional
beds string Number of bedrooms (comma-separated: 2,3,4) Optional
baths string Number of bathrooms (comma-separated decimals: 1.5,2.0,2.5) Optional
page integer Page number (default: 1) Optional
per_page integer Results per page (max: 200, default: 10) Optional
Note: The state_code parameter is required. Date columns are returned in YYYY-MM-DD format, while numeric columns (prices, square footage, etc.) are returned as integers or decimals for easier consumption.
State Code Validation: State code must be exactly 2 uppercase letters (e.g., CA, NY, TX, PA). Invalid formats will return a 400 error with a descriptive message.

Example Requests

Example 1: Get All Properties by State
GET /v3/get_property?state_code=PA&api_key=YOUR_API_KEY
Example 2: By City & State
GET /v3/get_property?city=Philadelphia&state_code=PA&api_key=YOUR_API_KEY
Example 3: With Price Range
GET /v3/get_property?city=Philadelphia&state_code=PA&price_min=250000&price_max=750000&api_key=YOUR_API_KEY
Example 4: With Beds & Baths
GET /v3/get_property?state_code=CA&beds=2,3&baths=2.0,2.5&api_key=YOUR_API_KEY

Example Response

JSON
{ "page": 1, "per_page": 10, "total": 125, "data": [ { "property_id": "3003585881", "status": "for_sale", "list_price": 350000, "city": "Philadelphia", "state_code": "PA", "postal_code": "19103", "p_type": "single_family", "beds": 3, "baths_consolidated": 2.0, "sqft": 1500, "price_per_sqft": 233.33 } ], "next_page": true, "execution_time": 0.0456 }
GET /v3/get_property_details

Get Property Details

Retrieve detailed property information. Returns comprehensive property data including mortgage information, schools, photos, history, and more.

Parameters

Parameter Type Description Required
api_key string Your API key Required
property_id string The property ID to get details for Required

Example Request

cURL
GET /v3/get_property_details?property_id=3077408827&api_key=YOUR_API_KEY

Example Response

JSON
{ "property_id": "3077408827", "data": { "property_id": "3077408827", "status": "for_sale", "list_price": 350000, "location": { "address": { "line": "123 Main St", "city": "Philadelphia", "state_code": "PA", "postal_code": "19103", "coordinate": { "lat": 39.9526, "lon": -75.1652 } } }, "description": { "beds": 3, "baths_consolidated": 2.0, "sqft": 1500, "year_built": 1990 }, "photos": [...], "mortgage": {...}, "schools": {...} }, "execution_time": 0.2345 }

Error Responses

Error Handling: The endpoint returns custom error messages for various scenarios:
  • 400 Bad Request: Missing property_id parameter
  • 404 Not Found: Property not found or missing required data
  • 502 Bad Gateway: External API returned an error
  • 503 Service Unavailable: Connection error to external API
  • 504 Gateway Timeout: Request timeout
  • 500 Internal Server Error: Unexpected server error
GET /v3/get_agent_details

Get Agent Details

Retrieve detailed information about a real estate agent including bio, contact details, ratings, and listings.

Parameters

Parameter Type Description Required
api_key string Your API key Required
profile_id string Agent profile ID (exactly one identifier required) One Required
fulfillment_id string Agent fulfillment ID (exactly one identifier required) One Required
nrds_id string Agent NRDS ID (exactly one identifier required) One Required
Important: You must provide exactly one of: profile_id, fulfillment_id, or nrds_id.

Example Requests

By Profile ID
GET /v3/get_agent_details?profile_id=56c9490589a68901006eb677&api_key=YOUR_API_KEY
By Fulfillment ID
GET /v3/get_agent_details?fulfillment_id=1265276&api_key=YOUR_API_KEY

Example Response

JSON
{ "fulfillment_id": "1265276", "id": "56c9490589a68901006eb677", "fullname": "John Doe", "email": "john.doe@example.com", "website": "https://johndoe.com", "bio": "Experienced real estate agent...", "is_realtor": true, "ratings_reviews": { "average_rating": 4.8, "reviews_count": 127 }, "phones": [ {"type": "mobile", "value": "215-555-0123"} ], "execution_time": 0.1234 }

Error Handling

Understanding API errors and status codes.

HTTP Status Codes

Status Code Description
200 Success - Request completed successfully
400 Bad Request - Invalid parameters or missing required filters
401 Unauthorized - Invalid or missing API key
500 Server Error - Internal server error

Error Response Format

JSON
{ "error": "Invalid or missing API key" }