Realtor API Documentation

API Version: v2.7

Quick Start

  1. Obtain your API key from the provider.
  2. Make requests to https://api.mlsdataiq.com/v2/ endpoints with api_key as a query parameter.
  3. Use filters to get the data you need. See examples below.
Sample Request:
GET /v2/get_property_data?city=Philadelphia&state_code=PA&api_key=YOUR_API_KEY_HERE

Authentication

All endpoints require an API key as a query parameter. Example:

?api_key=YOUR_API_KEY_HERE
Tip: Never share your API key publicly.

📋 Detailed Endpoint Documentation

Click on any endpoint below to view comprehensive documentation:

1
GET /v2/get_all_data - Retrieve All Property Data
â–¼

Returns all property data from the database. This endpoint requires only an API key and supports pagination.

Required Parameters

NameTypeDescriptionRequired
api_keystringYour API keyYes

Optional Parameters

NameTypeDescriptionRequired
pageintegerPage number for pagination
page=2		No (default: 1)
per_pageintegerResults per page (max: 200)
per_page=20		No (default: 10)
Sample Request:
GET /v2/get_all_data?api_key=YOUR_API_KEY_HERE
Sample Request with Pagination:
GET /v2/get_all_data?api_key=YOUR_API_KEY_HERE&page=1&per_page=50

Sample Response

{
  "page": 1,
  "per_page": 10,
  "total": 1500000,
  "data": [
    {
      "property_id": 12345,
      "listing_id": 67890,
      "status": "for_sale",
      "list_price": 350000,
      "address": "123 Main St",
      "city": "Philadelphia",
      "state_code": "PA",
      "postal_code": "19103",
      "state": "Pennsylvania",
      "property_type": "single_family",
      "beds": 3,
      "baths": 2,
      "sqft": 1500
    }
  ],
  "next_page": true,
  "execution_time": 0.1234
}
Note: This endpoint returns all data from the database. Use pagination to manage large result sets efficiently. Maximum 200 results per page to ensure optimal performance.

Error Handling

This endpoint may return the following errors:

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

HTTP Status: 401 - Unauthorized

{
  "error": "per_page parameter cannot exceed 200",
  "max_per_page": 200,
  "provided_per_page": 500
}

HTTP Status: 400 - Bad Request

2
GET /v2/get_property_data - Search Properties with Filters
â–¼

Returns full property details. You can filter by any combination of the parameters above.

Parameters

NameTypeDescription & Example ValuesRequired
property_idstringFilter by property ID
property_id=3003585881		No
postal_codestringFilter by postal code
postal_code=16001		No
state_codestringFilter by state code (case-insensitive)
state_code=PA, state_code=CA		No
citystringFilter by city (case-insensitive)
city=Philadelphia, city=Los Angeles		No
statusstringProperty status:
for_sale, ready_to_build, for_rent, sold, off_market, other, new_community		No
property_typestringProperty type:
single_family, mobile, land, townhomes, condos, multi_family		No
price_minintegerMinimum list price (>=)
price_min=250000		No
price_maxintegerMaximum list price (<=)
price_max=750000		No
sqft_minintegerMinimum square feet (>=)
sqft_min=800		No
sqft_maxintegerMaximum square feet (<=)
sqft_max=2000		No
min_price_per_sqftintegerMinimum price per sqft (>=)
min_price_per_sqft=200		No
max_price_per_sqftintegerMaximum price per sqft (<=)
max_price_per_sqft=500		No
bedslist of integersExact match(s), comma-separated
beds=0,1,2		No
bathslist of integersExact match(s), comma-separated
baths=1,3		No
storieslist of integersExact match(s), comma-separated
stories=1,2		No
pageintegerPage number for pagination
page=2		No (default: 1)
per_pageintegerResults per page (max: 200)
per_page=20		No (default: 10)
api_keystringYour API key
api_key=YOUR_API_KEY_HERE		Yes

Sample Example Requests

  • /v2/get_property_data?property_id=3003585881&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?state_code=CA&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?city=Philadelphia&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?postal_code=16001&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?postal_code=19103&state_code=PA&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?city=Philadelphia&state_code=PA&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?city=Philadelphia&state_code=PA&status=for_sale&property_type=single_family&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?price_min=250000&price_max=750000&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?sqft_min=800&sqft_max=2000&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?min_price_per_sqft=200&max_price_per_sqft=500&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?beds=2,3&baths=2&api_key=YOUR_API_KEY_HERE
  • /v2/get_property_data?stories=1,2&api_key=YOUR_API_KEY_HERE
Sample Request:
GET /v2/get_property_data?city=Philadelphia&state_code=PA&status=for_sale&property_type=single_family&price_min=300000&price_max=600000&api_key=YOUR_API_KEY_HERE

Sample Response

{
  "page": 1,
  "per_page": 10,
  "total": 1,
  "data": [
    {
      "property_id": 12345,
      "listing_id": 67890,
      "status": "for_sale",
      "list_price": 350000,
      "address": "123 Main St",
      "city": "Philadelphia",
      "state_code": "PA",
      "postal_code": "19103",
      "state": "Pennsylvania",
      "property_type": "single_family",
      "beds": 3,
      "baths": 2,
      "sqft": 1500,
      "price_per_sqft": 233
    }
  ],
  "next_page": false,
  "execution_time": 0.0123
}
Note: Use multiple filters for best results. Using only status or property_type may return a large dataset. Maximum 200 results per page to ensure optimal performance.

Error Handling

This endpoint may return the following errors:

{
  "error": "Invalid parameter(s)",
  "invalid_params": ["badparam"],
  "valid_params": ["property_id", "postal_code", "state_code", "city", "status", "property_type", "price_min", "price_max", "sqft_min", "sqft_max", "min_price_per_sqft", "max_price_per_sqft", "beds", "baths", "stories", "page", "per_page", "api_key"]
}

HTTP Status: 400 - Bad Request

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

HTTP Status: 401 - Unauthorized

{
  "error": "At least one filter parameter (property_id, postal_code, state_code, city, status, property_type, price_min, price_max, sqft_min, sqft_max, min_price_per_sqft, max_price_per_sqft, beds, baths, stories) is required.",
  "valid_params": ["property_id", "postal_code", "state_code", "city", "status", "property_type", "price_min", "price_max", "sqft_min", "sqft_max", "min_price_per_sqft", "max_price_per_sqft", "beds", "baths", "stories", "page", "per_page", "api_key"]
}

HTTP Status: 400 - Bad Request

3
GET /v2/get_agent_data - Get Agent Information
â–¼

Returns key agent fields.

Parameters

NameTypeDescription & Example ValuesRequired
property_idstringFilter by property ID
property_id=3003585881		No
postal_codestringFilter by postal code
postal_code=16001		No
state_codestringFilter by state code (case-insensitive)
state_code=PA, state_code=CA		No
citystringFilter by city (case-insensitive)
city=Philadelphia, city=Los Angeles		No
statusstringProperty status:
for_sale, ready_to_build, for_rent, sold, off_market, other, new_community		No
property_typestringProperty type:
single_family, mobile, land, townhomes, condos, multi_family		No
price_minintegerMinimum list price (>=)
price_min=250000		No
price_maxintegerMaximum list price (<=)
price_max=750000		No
sqft_minintegerMinimum square feet (>=)
sqft_min=800		No
sqft_maxintegerMaximum square feet (<=)
sqft_max=2000		No
min_price_per_sqftintegerMinimum price per sqft (>=)
min_price_per_sqft=200		No
max_price_per_sqftintegerMaximum price per sqft (<=)
max_price_per_sqft=500		No
bedslist of integersExact match(s), comma-separated
beds=0,1,2		No
bathslist of integersExact match(s), comma-separated
baths=1,3		No
storieslist of integersExact match(s), comma-separated
stories=1,2		No
pageintegerPage number for pagination
page=2		No (default: 1)
per_pageintegerResults per page (max: 200)
per_page=20		No (default: 10)
api_keystringYour API key
api_key=YOUR_API_KEY_HERE		Yes

Sample Example Requests

  • /v2/get_agent_data?city=Philadelphia&state_code=PA&status=for_sale&property_type=single_family&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?property_id=3003585881&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?state_code=CA&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?city=Philadelphia&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?postal_code=16001&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?postal_code=19103&state_code=PA&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?city=Philadelphia&state_code=PA&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?price_min=300000&price_max=600000&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?sqft_min=800&sqft_max=2000&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?min_price_per_sqft=200&max_price_per_sqft=500&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?beds=2,3&baths=2&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_data?stories=1,2&api_key=YOUR_API_KEY_HERE
Sample Request:
GET /v2/get_agent_data?city=Philadelphia&state_code=PA&status=for_sale&property_type=single_family&price_min=300000&price_max=600000&api_key=YOUR_API_KEY_HERE

Sample Response

{
  "page": 1,
  "per_page": 10,
  "total": 1,
  "data": [
    {
      "fulfillment_id": "1265276",
      "nrds_id": "721511511",
      "name": "Matin Haghkar",
      "type": "seller",
      "email": "matin.haghkar@remax.net",
      "href": "http://www.zillow.com/m/profile/matin-haghkar/",
      "state_license": "RS123456",
      "number": "2154223711",
      "realtor_agent_url": "https://realtor.com/realestateagents/Matin-Haghkar_Philadelphia_PA_1265276_884884872"
    }
  ],
  "next_page": false,
  "execution_time": 0.0123
}

Error Handling

This endpoint may return the following errors:

{
  "error": "Invalid parameter(s)",
  "invalid_params": ["badparam"],
  "valid_params": ["property_id", "postal_code", "state_code", "city", "status", "property_type", "price_min", "price_max", "sqft_min", "sqft_max", "min_price_per_sqft", "max_price_per_sqft", "beds", "baths", "stories", "page", "per_page", "api_key"]
}

HTTP Status: 400 - Bad Request

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

HTTP Status: 401 - Unauthorized

{
  "error": "At least one filter parameter (property_id, postal_code, state_code, city, status, property_type, price_min, price_max, sqft_min, sqft_max, min_price_per_sqft, max_price_per_sqft, beds, baths, stories) is required.",
  "valid_params": ["property_id", "postal_code", "state_code", "city", "status", "property_type", "price_min", "price_max", "sqft_min", "sqft_max", "min_price_per_sqft", "max_price_per_sqft", "beds", "baths", "stories", "page", "per_page", "api_key"]
}

HTTP Status: 400 - Bad Request

{
  "error": "per_page parameter cannot exceed 200",
  "max_per_page": 200,
  "provided_per_page": 500
}

HTTP Status: 400 - Bad Request

4
GET /v2/get_agent_details - Detailed Agent Information
â–¼

Returns detailed agent information including bio, contact details, ratings, listings, and more. Requires exactly one of the three identifier parameters.

Required Parameters (exactly one)

NameTypeDescriptionRequired
profile_idstringAgent profile ID
profile_id=56c9490589a68901006eb677		One of three required
fulfillment_idstringAgent fulfillment ID
fulfillment_id=1265276		One of three required
nrds_idstringAgent NRDS ID
nrds_id=721511511		One of three required
api_keystringYour API key
api_key=YOUR_API_KEY_HERE		Yes

Sample Example Requests

  • /v2/get_agent_details?profile_id=56c9490589a68901006eb677&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_details?fulfillment_id=1265276&api_key=YOUR_API_KEY_HERE
  • /v2/get_agent_details?nrds_id=721511511&api_key=YOUR_API_KEY_HERE
Sample Request:
GET /v2/get_agent_details?profile_id=56c9490589a68901006eb677&api_key=YOUR_API_KEY_HERE

Sample Response

{
  "fulfillment_id": "1265276",
  "id": "56c9490589a68901006eb677",
  "fullname": "Matin Haghkar",
  "email": "agent@example.com",
  "website": "https://matinhaghkar.com",
  "bio": "Experienced real estate agent with 10+ years in the Philadelphia market...",
  "is_paid": true,
  "is_realtor": true,
  "designations": ["GRI", "CRS"],
  "avatar": {
    "initials": "MH",
    "url": "https://example.com/avatar.jpg"
  },
  "broker": {
    "name": "RE/MAX Elite",
    "website": "https://remaxelite.com"
  },
  "ratings_reviews": {
    "average_rating": 4.8,
    "reviews_count": 127
  },
  "experience": {
    "first_year": 2010,
    "label": "14+ years"
  },
  "phones": [
    {"type": "mobile", "value": "215-555-0123"}
  ],
  "license_number": "RS123456",
  "license_state": "PA",
  "social_media": {
    "facebook": {"href": "https://facebook.com/matinhaghkar"},
    "linkedin": {"href": "https://linkedin.com/in/matinhaghkar"}
  },
  "execution_time": 0.1234
}
Note: This endpoint returns detailed agent information including bio, contact details, ratings, recent listings, and social media profiles. If an error occurs, the response will include an 'error' key with the error message.

Error Handling

This endpoint may return the following errors:

{
  "error": "Invalid parameter(s)",
  "invalid_params": ["badparam"],
  "valid_params": ["profile_id", "fulfillment_id", "nrds_id", "api_key"]
}

HTTP Status: 400 - Bad Request

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

HTTP Status: 401 - Unauthorized

{
  "error": "Exactly one parameter (profile_id, fulfillment_id, or nrds_id) is required.",
  "valid_params": ["profile_id", "fulfillment_id", "nrds_id", "api_key"]
}

HTTP Status: 400 - Bad Request

{
  "error": "Result did not found."
}

HTTP Status: 200 - Success (but with error in response)

FAQ & Tips

Experience the MLS DataIQ difference

We'd love to show you how you can get more property data and leads for your real estate business. Get started with our comprehensive API today.

Get Started