A guided live test. Prefer the raw endpoints? See the API reference & playground →
Enter an API key from your Dashboard to enable the examples below. Requests send it to this platform for authentication.
Log in / Sign up · Dashboard →
Please paste your API key first.
Your API key is attached automatically to each call.
/api/project/realtor/property-search-buy Search Homes for Sale
Find U.S. for-sale listings using a city, ZIP code, address or location ID from property-auto-complete. New York, NY with sort=newest was live-tested. Successful responses contain status=true, message, a flat data array, resultsPerPage, totalResultCount, totalPages and currentPage. Observed listing fields include property_id, listing_id, status=for_sale, list_price, list_date, location.address, description.beds/baths/sqft, primary_photo.href and photos[].href; some attributes are null. Optional price, room, home-size, property-type and amenity inputs are documented but were not individually validated. pageSize=8 returned 30 rows, so use the actual array length and verify page transitions rather than trusting requested sizes or perfectly consistent totals. An impossible city returned HTTP 200 with status=false, data=null and a misleading pagination message; inspect the business status instead of treating HTTP 200 alone as a successful search.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-search-rent Search Rental Listings by City or ZIP Code
Discover advertised U.S. rentals using location; ZIP code 10001 with sort=newest was live-tested. The response has status=true, message, a flat data array and resultsPerPage, totalResultCount, totalPages and currentPage. Observed rows include property_id, listing_id, status=for_rent, location.address including postal_code, list_date, nullable list_price/list_price_min/list_price_max, bedroom and bathroom values or ranges in description, primary_photo and photos. Advertised rent is not a signed-lease price. pageSize=8 still returned 30 listings; returned totals and page counts may not reconcile with the actual row count. Use explicit unavailable-price states, inspect each page and deduplicate identifiers. Pets, move-in date, features and other optional filters are documented inputs, not individually verified filtering guarantees.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-search-sold Search Sold Homes and Available Sale Records
Search sold-property records by location, with documented price, room, property-type, size and minSoldDate inputs. Austin, TX with sort=newest was live-tested and returned status=true, message, a flat data array and resultsPerPage, totalResultCount, totalPages and currentPage. Observed rows include property_id, listing_id, status=sold, location.address, last_sold_date, nullable last_sold_price, list_price, list_date, description and photos. Keep list_price distinct from recorded last_sold_price, and do not interpret an absent sale price as zero. newest reflects listing ordering and did not necessarily mean the most recent sale date. pageSize=8 returned 30 rows; verify actual page contents and totals. The sale-date filter and other optional filters remain unverified, and this search is not a comprehensive historical transaction feed or a certified appraisal.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-auto-complete Find Property Search Locations
Submit location text to obtain a location-selection list for property searches. The New York, NY test returned an object with a data array; observed suggestion fields include id, full_address, area_type, city, state_code, country, centroid, counties and a nullable propertyId. The first city suggestion had id=city:New York, NY. Pass the returned id to a property search and do not confuse it with property_id or listing_id. The success payload has no status or message envelope. A nonexistent location returned exactly {"data":[]}, which is a valid no-match result. limit=5 returned 10 suggestions, so apply a client-side display cap when needed rather than promising the requested limit is honored.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/property-v2-detail Get Full Property Details
Enrich a selected search result by submitting its property_id as query. The documented query also accepts a property URL, full address or address-style ID; only the property-ID form was live-tested. For the tested search-derived ID, the response matched property_id, listing_id, address and list_price and contained status=true, message and a data object. Observed data fields include status, location.address and coordinates, description.text and housing attributes, photo_count, photos[].href, mortgage.estimate, mortgage.average_rates, hoa, details, tax_history, property_history, last_sold_date, last_sold_price and last_update_date. Not every field is populated for every property. Preserve nullable values and retain retrieval timestamps; returned financing information is an estimate, not a loan offer. Use a fresh search ID when following the example because a listing can change or become unavailable.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/property-search-by-url Search Listings from a Realtor.com Search URL
Supply a complete Realtor.com search URL as url, with optional page and pageSize. The documented inputs include city, state, ZIP-code and other supported search-page URLs; the New York city URL is a source-provided example, not a live-verified request for this route. Use this read to evaluate turning a saved search context into JSON listing candidates. No response fields or pagination behavior were confirmed for property-search-by-url, so inspect the result before depending on a particular listing schema or assuming compatibility with every URL. Prefer the tested city/ZIP search routes when you do not need URL-based input.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
/api/project/realtor/property-search-consumer Search Listings by Market Status
Submit location with an optional single status value: for_sale, for_rent or sold. page and pageSize are optional string-valued request inputs on this route; the status default is for_sale. The documented purpose is a shared listing search across these market states, but this endpoint was not live-tested and no response field names were confirmed. Validate each chosen status, returned geography and pagination before unifying production calls behind it. For verified examples, use the dedicated sale, rental and sold searches instead of assuming their contracts are identical to this route.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-search-mls-id Find Public Listings by MLS Reference
Pass a known MLS listing reference as mlsId; page and pageSize are optional numeric inputs. The documented example is a listing number, not a city name. This lookup was not live-tested, so returned property fields, reference ambiguity and pagination have not been confirmed. Check any returned identity against the intended property and geography before linking records. MLS reference lookup does not provide direct MLS access, an IDX license, comprehensive MLS coverage or permission to redistribute a listing.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
/api/project/realtor/property-detail-by-url Get Property Details from a Listing URL
Submit a complete Realtor.com property-detail URL as url. This documented read offers a URL-based alternative for a saved listing bookmark, but it was not live-tested and its response fields and URL-pattern coverage are unconfirmed. Use a current listing URL, inspect the returned identity and available fields, and do not assume the payload matches property-v2-detail. If a property_id is already available from search, the tested property-v2-detail operation is the preferred enrichment example.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/property-photos Look Up a Property Photo Gallery
Supply query as a known property ID, supported property URL, full address or address-style ID. The optional size input uses the documented w2048_h1536 format; actual image dimensions and resize behavior need validation. This dedicated photo route was not live-tested, so its response envelope, gallery fields and link availability have not been confirmed. The tested property-v2-detail route already exposed photos[].href for one property and can be used when full details are needed. Photo access alone does not grant image reuse or redistribution rights.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/property-get-descriptions Get a Listing Narrative by Property and Listing ID
Pass propertyId and listingId from the same search result; the tested searches expose these as data[].property_id and data[].listing_id. The documented purpose is a separate listing-description read. This route was not live-tested, so the text field name, response envelope and behavior for outdated ID pairs are unconfirmed. Do not mix a property ID from one home with a listing ID from another. For a tested description field, property-v2-detail returned data.description.text together with full details. Confirm content-use rights before displaying narrative text.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/property-similar-homes Find Documented Similar-Home Candidates
Provide a propertyId obtained from a search result, with optional pageSize. The route is documented for similar-home discovery, but it was not live-tested; returned fields, matching criteria and requested result counts are unconfirmed. Inspect candidate identities and attributes independently before offering alternatives to a user. Do not describe the unknown similarity method as personalized intelligence, valuation advice or appraisal-grade sold comparables.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/property-get-commute-time Estimate a Property-to-Destination Commute
Submit propertyId and destinationAddress, with optional transportationType and withTraffic. Documented transportation values are driving, transit, walking and bicycling; withTraffic is a boolean input. This route was not live-tested, so duration units, routing fields and traffic behavior have not been confirmed. Validate each mode and returned geography before showing travel estimates. Treat any available time as an estimate, not a guaranteed journey duration, and avoid retaining a user's workplace or home destination unnecessarily.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-get-surroundings Look Up Documented Property Surroundings
Submit a known propertyId to evaluate the documented surrounding-area information read. This endpoint was not live-tested, and no response categories, scores, boundaries or field names have been confirmed. Inspect the actual payload before designing a neighborhood panel. Do not infer school quality, crime risk, walkability or comprehensive amenity coverage from the endpoint name, and preserve missing context rather than inventing local claims.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/coordinates-search-buy Search Homes for Sale from Coordinates
Provide numeric latitude and longitude to evaluate the documented coordinate-based for-sale search. Optional inputs include expandSearchArea, price, rooms, propertyType, sizes, amenities, sort, page and pageSize. The coordinate examples are numeric source examples, not live-verified search locations for this route. No response fields or radius behavior were confirmed. Validate returned geography and each filter before labeling results nearby, and do not assume support for map polygons, bounding boxes or guaranteed distance coverage.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/coordinates-search-rent Search Rentals from Coordinates
Supply numeric latitude and longitude for the documented coordinate-based rental read. Price, bedrooms, bathrooms, propertyType, features, pets, moveInDate, expandSearchArea, sort, page and pageSize are optional inputs. This endpoint was not live-tested, so its rental fields, filtering effects and search-area coverage are unconfirmed. Keep advertised rents separate from completed leases, check returned locations before calling them nearby, and validate pet and move-in behavior before promising suitable or available rentals.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/coordinates-search-sold Search Sold Properties from Coordinates
Pass numeric latitude and longitude to evaluate sold-property discovery around a point. Optional inputs include minSoldDate, price, rooms, home and lot sizes, propertyType, expandSearchArea, sort, page and pageSize. This coordinate route was not live-tested, so sale-field availability, distance behavior, filtering and ordering are unconfirmed. Inspect available sale dates and sale prices separately from listing fields, and do not treat nearby candidates as comprehensive transactions or appraisal-grade comparables.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/agents-auto-complete Find Locations for Agent Search
Submit query text with optional limit to evaluate the documented agent-location autocomplete route. Its suggestions are intended for selecting the location input used by agents-list; inspect the actual returned identifier before forwarding it. This route was not live-tested, so suggestion field names, empty-result behavior and limit enforcement are unconfirmed. Keep its location values distinct from property-auto-complete IDs and finance-tool locations rather than assuming those formats are interchangeable.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/agents-list Find Real-Estate Agents by Area
Provide id as the documented agent-search location or ZIP-code input. Optional name, language, agentType, agentFilterCriteria, price range, sort, limit and page refine the requested directory search. Documented agent types are BUYER, SELLER and BOTH; language and ordering options are listed in the reference. This route was not live-tested, so filter enforcement, response fields and pagination are unconfirmed. Documentation identifies data[].id as a possible profileId and data[].fulfillment_id as a fulfillmentId; verify their actual paths before using agents-profile or portfolio reads. Finding an agent record does not establish contact permission or professional suitability.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/agents-profile Get a Public Agent Profile
Submit profileId from a verified agents-list result; fulfillmentId is an optional companion input for that same agent. The documented mapping points profileId to a directory record's id and fulfillmentId to fulfillment_id, but those response paths were not live-confirmed. This profile endpoint was also not tested, so biography, office, rating, contact and other profile fields are not guaranteed. Inspect the actual response and render only confirmed, permitted public fields; do not interchange the two identifiers.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
/api/project/realtor/agents-listings Get an Agent's Documented Listing Portfolio
Provide fulfillmentId from an inspected agent-search result. Optional status accepts documented values for_sale, for_rent, off_market, sold, ready_to_build and other, including comma-separated combinations; limit and page are optional. This route was not live-tested, so listing fields, status filtering, page behavior and portfolio completeness are unconfirmed. Check the returned identities and statuses before display, and do not treat one response as the agent's complete inventory or transaction history.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/agents-reviews Read Documented Public Agent Reviews
Submit fulfillmentId for the selected agent to evaluate the documented public-review read. No page or limit parameter is exposed by this contract. The route was not live-tested, so review fields, rating scales, response count and coverage are unconfirmed. Keep review content separate from agents-recommendations, validate the actual format before display, and establish permitted use independently. Public feedback is not an objective guarantee of an agent's service quality.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/agents-recommendations Read Documented Agent Recommendations
Provide fulfillmentId to evaluate the documented recommendation or testimonial read for an agent. This endpoint was not live-tested; item fields, dates, rating content and response envelope are unconfirmed. Inspect what it actually returns rather than assuming the agents-reviews schema applies. Retain retrieval context and do not present recommendation content as verified endorsements or evidence of authenticity.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/mortgage-calculationv1 Evaluate a Location-Based Mortgage Estimate
Supply homePrice, downPayment and location; optional rate, homeInsurance and hoaFees allow explicit scenario inputs. The documented location example is 11212, Brooklyn, NY. This version-1 calculation route was not live-tested, so output fields, implicit assumptions, rate units and insurance periods are unconfirmed. Inspect defaults and units before comparing scenarios, and do not assume the contract or calculations match the other mortgage routes. Treat outputs as illustrative budgeting estimates, not quotes, approvals or personalized financial advice.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/mortgage-calculationv2 Evaluate a Mortgage with Explicit Cost Inputs
Provide price, term, downPayment, rate, propertyTaxRate and homeInsurance; applyVeteransBenefits is optional. These are the documented version-2 numeric inputs. Example rate and tax values use fractional-looking numbers, but their accepted scale and insurance period were not live-validated. No response fields or calculation behavior were confirmed for this endpoint. Verify every unit and optional benefit assumption before comparing scenarios; outputs must remain illustrative estimates rather than financing offers, eligibility decisions or preapproval.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-calculate-down-payment-percentage Estimate Financing by Down-Payment Percentage
Provide homePrice, downPaymentPercentage, mortgageLoanType, interestRate, propertyTaxRate and homeInsurance. This documented calculation accepts the down payment as a percentage; its source example is 20, while the rate examples use fractional-looking numbers. It was not live-tested, so response fields, supported loan-term interpretation, interest and tax scales, and insurance period are unconfirmed. Validate these assumptions before using a percentage slider or comparing estimates. This route does not issue a loan quote or make a lending decision.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/property-calculate-down-payment-price Estimate Financing by Cash Down Payment
Supply homePrice and downPaymentPrice with mortgageLoanType, interestRate, propertyTaxRate and homeInsurance. The documented downPaymentPrice input is a cash contribution rather than a percentage; source examples are scenario inputs, not API pricing. This route was not live-tested, so payment fields, loan-term interpretation, rate scale and insurance period are unconfirmed. Compare scenarios only after verifying all units and returned calculations, and describe the result as an estimate rather than a lender quote or personalized recommendation.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/tools-affordability-calculator Evaluate Home Affordability from Income and Funds
Provide annualIncome and availableFunds as the documented string inputs; monthlyDebt is an optional number and isPmiIncluded is an optional boolean. The source description for isPmiIncluded is inconsistent with its name, so its meaning and effect must be confirmed rather than described as a verified military or insurance benefit. This route was not live-tested and no affordability fields, ratios or assumptions were observed. Use synthetic scenario inputs, minimize retention of personal finances, and treat any available output as a budgeting estimate rather than mortgage preapproval.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/tools-mortgage-calculator Evaluate Mortgage Estimates by Loan Type
Provide homePrice and downPayment with string-valued interestRate, propertyTax and homeInsurance. Optional loanType selects documented fixed-rate, FHA or ARM choices; TWENTY_YEAR_FIX is the documented default. This route was not live-tested, so output fields, tax and insurance interpretation, loan-type effects and adjustable-rate behavior are unconfirmed. Do not mix its loanType codes with tools-mortgage-rates loanTerm codes. Validate cost units and each chosen financing method before display, and keep results illustrative rather than binding offers.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/mortgage-rates Look Up Documented Mortgage Rates by ZIP Code
Submit a U.S. ZIP code as postalCode; the documented example is 10065. This simple mortgage-rate read was not live-tested, so rate fields, dates, loan products, lender attribution and qualification assumptions are unconfirmed. Inspect any timestamps and conditions actually returned before displaying reference rates. A successful response would not itself establish a current binding quote, an available loan offer or a rate the user qualifies for.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/tools-mortgage-rates Evaluate Purchase or Refinance Rate Scenarios
Provide location and optionally loanType, loanTerm, propertyUse, propertyType, creditScore, points, showUsda and financing amounts. Documented loanType codes are 52 for purchase and 54 for refinance. purchasePrice and downPaymentPercent describe purchase inputs; propertyValue and loanBalance are documented for refinance. This route was not live-tested, so returned rate or offer fields, input dependencies and qualification behavior are unconfirmed. The documented showUsda toggle and rate term codes are request options, not proof of product availability. Validate code meanings and scenario handling, minimize personal-finance retention and treat any rates as nonbinding.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
/api/project/realtor/tools-auto-complete Find Locations for Financing Tools
Submit location text to evaluate the documented autocomplete route for financial tools. This route was not live-tested, so suggestion fields, returned location format and no-match behavior are unconfirmed. Documentation points to data.autocomplete[].location for downstream finance requests, but verify that path in an actual response before use. Keep tool locations separate from property search IDs and agent directory IDs; this operation does not itself calculate a mortgage or retrieve a rate.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/tools-get-postal-code Look Up Postal-Code Context from a Location
Provide location as a supported address or place value; the documented finance-tool workflow obtains it from tools-auto-complete. This postal-code route was not live-tested, and no postal-code fields, multiplicity or matching rules were confirmed. Inspect the response before choosing a ZIP for rate requests, especially for cities with many ZIP codes. Treat it as geographic context lookup rather than authoritative postal-delivery validation.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/tools-mortgage-loan-analysis Evaluate Location-Based Mortgage Analysis
Submit location for the documented mortgage-loan analysis read. This endpoint was not live-tested, and no analysis metrics, geographic granularity, calculation assumptions or response field names were confirmed. Inspect actual content before designing a location-level financing panel. Do not infer amortization schedules, underwriting decisions, borrower eligibility or detailed loan offers from the route name.
| Parameter | In | Value |
|---|---|---|
| query |
/api/project/realtor/property-detail-deprecated Get Legacy Property Details (Deprecated)
Legacy detail read requiring both propertyId and listingId from the same search row. This documented route is deprecated and was not live-tested; response fields and continued availability are unconfirmed. It remains in the reference for existing integrations, not as a new quick-start recommendation. New development should use property-v2-detail with a freshly obtained property_id. Compare actual field availability before migrating and preserve the distinction between a property identity and its listing identity.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |