Realty in US Property & Mortgage Data — Try the interactive demo
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.
Endpoints
Your API key is attached automatically to each call.
/api/project/realty-in-us/agents-get-listings-deprecated Legacy agent listing lookup (deprecated)
Details
Retrieve the legacy listing selection associated with an agent. This deprecated operation is intended for maintaining and auditing existing agent pages, not for new integrations. Supply all three required query parameters from the same legacy /agents/list result: numeric agent_id from member/id, numeric fulfillment_id from advertiser_id, and string id from abbreviation. Optional page selects a page; optional type selects all, forSale, forSold, forRent, or openHouses. The documented examples use page=1 and type=all, but no omitted-value behavior or page size is established. The available response documentation contains only an unverified HTTP 200 example of an empty JSON object ({}). No probe response is available, and no listing fields, result count, pagination envelope, or error schema are documented for this route. Do not interpret that example as verified empty inventory or proof that this deprecated operation remains available. Compare identifier requirements and response structure with the current agent-listing contract before migrating saved pages; identifiers must not be assumed interchangeable.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-get-profile-deprecated Legacy agent profile lookup (deprecated)
Details
Look up an agent profile through the deprecated profile contract used by older agent directories and CRM records. Both query parameters are required: numeric advertiser_id and string nrds_id, each taken from the corresponding field in a legacy /agents/list result for the intended agent. Keep nrds_id as text rather than treating it as the numeric advertiser identifier. This route is retained for auditing and migrating existing integrations, not recommended for new profile pages. Its available response documentation consists only of an unverified HTTP 200 example containing an empty JSON object ({}). No probe result is available, so profile attributes, biography, contact information, brokerage fields, and error behavior are not established. The example does not verify a missing profile or continued route availability. When comparing with a current profile contract, reconcile the agent identity explicitly; advertiser_id and nrds_id must not be assumed to equal current fulfillment_id or profile_id values. Review only fields confirmed by the applicable contracts before migrating cached profile content.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-get-recommendations-deprecated Legacy agent recommendations lookup (deprecated)
Details
Retrieve the legacy recommendation resource associated with an agent's advertiser identifier. This deprecated operation is a maintenance and migration reference for existing recommendation widgets, not a recommended starting point for a new integration. Its single required query parameter is numeric advertiser_id, sourced from the advertiser_id field in the legacy /agents/list result for the agent. No pagination or filter inputs are documented. The only available response example is labeled HTTP 200 and contains an empty JSON object ({}); it is an unverified source example, with no observed probe response. Recommendation text, author attribution, dates, scores, counts, result ordering, and error fields are not documented. Do not interpret the example as proof of zero recommendations or a guarantee that the route remains available, and do not treat this resource as a recommended-agent search result or a verified rating feed. When planning a move to a current fulfillment_id-based recommendation contract, verify the agent identity and each identifier mapping explicitly instead of equating advertiser_id with fulfillment_id.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-get-reviews-deprecated Get legacy agent reviews by advertiser ID (deprecated)
Details
Request agent reviews through the deprecated GET /agents/get-reviews route. The only documented input is the required numeric advertiser_id, which the legacy /agents/list route is documented to return. Do not substitute an agent fulfillment_id for this identifier. The available HTTP 200 source example is an empty JSON object, so it establishes no review collection, review text, rating, timestamp, author attribution or pagination fields. No live response was captured for this operation; the empty example is not evidence that a particular agent has no reviews. Retain this route only when auditing or migrating an existing advertiser-ID review workflow, and verify availability and response structure before relying on it.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-list-deprecated Search the legacy agent directory by ZIP code (deprecated)
Details
Search the deprecated GET /agents/list directory with a required postal_code and optional filters for name, buyer or seller agent role, result type, minimum rating, minimum recommendations and price bounds. Documented result types are agent, team and office. Pagination uses limit, documented with a maximum of 20, and offset, the number of entries to skip. The sort input supports five documented orderings covering recent activity, recent sales, for-sale count, recommendation count and rating. The available HTTP 200 source example is an empty JSON object; it establishes no agent collection, record fields, total count or pagination metadata. The legacy review operation documents advertiser_id as originating here, but no populated directory record was captured to verify that handoff. This operation was not live-tested. Use it to audit or migrate older directory filters, not as a recommended new integration; do not assume a current search operation has equivalent filter semantics.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-get-listings Get listings associated with an agent fulfillment ID
Details
Request listings for a selected agent through GET /agents/v2/get-listings. Supply the required string fulfillment_id, documented as coming from /agents/v2/list; the documented input example and default are 1365510. This request takes no documented listing-status filter, date range, limit or offset. No live response was captured for this operation. The supplied HTTP 200 example is a truncated, unverified JSON fragment that contains agent-profile metadata rather than establishing a usable listing collection. Visible source fields include fulfillment_id, fullname, bio and address fields city, country, line, postal_code, state and state_code; broker and office contain their own identity metadata, while ratings and recommendations contain profile metrics. None of these source-only fields is a live-verified response guarantee, and the fragment does not establish listing identifiers, prices, listing status, a listing-array field or pagination metadata. Use this lookup for a selected-agent portfolio workflow only after verifying the returned contract, and do not claim complete inventory, current availability or a distinction between active and sold listings.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-get-profile Get a selected real estate agent's professional profile
Details
Retrieve an agent profile using the required profile_id query parameter, taken from the id field of an /agents/v2/list result. The optional fulfillment_id comes from that result's fulfillment_id field. Keep these identifiers separate; a profile ID and a fulfillment ID are not interchangeable. The documented profile_id example is 56d09a4b2cfde1010000abb1, while fulfillment_id has no supplied default. The available documentation example shows profile identifiers id and _id; fullname, profile_name, bio and profile_description; an address object with line, city, postal_code, state, state_code and country; agent_represents.buyer and agent_represents.seller booleans; an areas_served string; and languages and licenses arrays whose item structures are not established by the empty sample arrays. It also shows broker and office objects with name and fulfillment_id, photo.href, and meta.last_update_date. Feedback-related fields include recommendations.count and a ratings object with average_rating, overall_rating, reviews_count and responseCount. The sample mixes numeric and string rating values, so do not assume one numeric type for every ratings field. These are unverified documentation fields, not observed live-response guarantees: no probe response is available for this operation, and the supplied example is incomplete. Handle absent fields and do not infer current contact details, license validity, photo usage rights or a complete professional history from a returned profile. Retrieve recommendations and reviews through their separate operations when those are the intended views.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-get-recommendations Get recommendations associated with a selected real estate agent
Details
Request recommendations for a selected agent using fulfillment_id, a required string query parameter taken from the fulfillment_id field of an /agents/v2/list result. The documented example is 1365510. Do not pass the agent's profile id in place of its fulfillment identifier. No pagination, sorting or recommendation-author filter is documented for this operation. The available documentation example contains a recommendations object with a numeric count and a ratings object containing recommendation_rating, among other profile fields. It is an incomplete profile-shaped example also supplied for the profile and review operations, not an established collection of recommendation entries. Recommendation text, author attribution, dates, entry identifiers and a recommendation-list envelope are not verified by this evidence. No live probe response is available for this operation. Treat recommendations.count and ratings.recommendation_rating as unverified example fields, not a guaranteed response schema or a promise of current totals. Keep recommendations separate from reviews in the interface. Missing feedback or a missing count means unavailable information, not zero endorsements, poor performance or a licensing or trust verdict.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-get-reviews Get reviews associated with a selected real estate agent
Details
Request reviews for a selected agent by sending fulfillment_id as the required string query parameter. Obtain its value from the fulfillment_id field in an /agents/v2/list result; the documented example is 1365510. This request does not take profile_id. No review-specific pagination, date range, star-rating filter or sorting parameter is documented. The available documentation example is an incomplete profile-shaped object, repeated across the agent profile, recommendation and review operations. Its ratings object includes numeric reviews_count, average_rating and overall_rating fields, plus responseCount, overall_satisfaction, performance_rating, recommendation_rating, show_scores and testimonial_return_rate shown as strings. These are unverified example fields rather than observed review-response guarantees. The evidence does not define a list of individual reviews, review text, reviewer names, review dates, attribution fields or a rating scale. No live probe response is available for this operation. Inspect an actual result before building review cards or aggregating ratings, and preserve any review metadata and attribution that are actually returned. Do not infer a star scale or derive a score from missing fields. If an actual result explicitly returns an empty review collection, label it as no retrieved reviews rather than a poor rating; an absent or unsuccessful response is not evidence of zero reviews.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-list Find real estate agents by ZIP code and profile filters
Details
Search for agents using a postal code, with optional name or marketing-area criteria, buyer/seller role, spoken language, identifier-presence filters, and ranking. This operation marks postal_code as required: although the source description describes marketing_area_city, name, and postal_code as alternative search criteria, this contract still requires postal_code even when another criterion is supplied. marketing_area_city is documented as a location result id from the agent location-search operation; its response format has not been verified here. limit controls the page size, up to 20, and offset skips that many results. The documented sort default is RELEVANT_AGENTS. A successful probe using postal_code=10001, limit=3, offset=0, and sort=RELEVANT_AGENTS returned data.search_agents.matching_rows=486 and three records in data.search_agents.agents. Observed agent records included names, identifiers, brokerages, ratings, and listing statistics. matching_rows is the total match count, not the length of the current agents page. Some returned listing activity referred to October 2026; this does not establish a refresh schedule or the freshness of every record. The supplied source response example is empty, so no additional response fields or guaranteed field completeness are established. Only the probed ZIP-code search and ranking combination was observed; the other documented filters have not been separately verified.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/agents-v2-search-location Search place suggestions for agent service-area selection
Details
Search location information for an agent-discovery workflow using the required input text. The documented default text is cali. Optional area_types controls the location categories: neighborhood, city, county, postal_code, building, and street. Its documented default is the comma-separated string neighborhood,city,county,postal_code,building,street. limit defaults to 10 and has a documented maximum of 20. Treat results as candidates for a user-selected service area rather than automatically choosing a location or sending an agent-list request. No successful probe response is supplied for this endpoint. The unverified source example is truncated and begins with an agents array containing agent-profile information; it does not establish a reliable location-suggestion response schema. Consequently, result field names, identifier formats, coordinates, and an empty-result envelope are not verified. The agent-list contract describes marketing_area_city as a location result id from this endpoint, but that mapping must be checked against an actual response before use. Do not assume identifiers or fields match the property-location autocomplete operation.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/finance-rates Retrieve location-based mortgage rate reference data
Details
Request finance-rate reference information using the required loc postal-code string. The documented example is loc=93505; no other input, lender selector, loan amount, or borrower profile is exposed by this operation. No successful probe is supplied, so the response fields described here come only from an unverified source example. That example has top-level meta and rates objects. The rates object contains string-valued average_rate_10_year, average_rate_15_year, average_rate_20_year, and average_rate_30_year reference fields; average_rate_30_year_fha and average_rate_30_year_va fields; and average_rate_51_arm and average_rate_71_arm fields labeled for adjustable-rate categories. It also contains numeric insurance_rate and property_tax fields and a nested meta.warnings string. The supplied example does not establish a quotation date, refresh interval, lender attribution, APR, discount points, eligibility requirements, or complete unit and calculation rules. Treat these fields as indicative context, not an available loan offer or a guaranteed current rate. Numeric-looking average-rate values are strings in the source example; validate their format and meaning before displaying or calculating with them. Do not infer tax or insurance amounts from the numeric fields without verified units. This operation retrieves reference data; it does not calculate monthly payments. Keep retrieved values separate from any explicitly selected assumptions used in a mortgage calculator.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/locations-auto-complete-deprecated Legacy city and address autocomplete (deprecated)
Details
Retained for existing integrations that submit one required input query string to obtain location suggestions. The documented input covers city, district and place names; the endpoint description also mentions street names and address-to-property-identifier lookup. The example input is new york. This deprecated route is a migration surface, not the recommended choice for a new location picker; evaluate /locations/v2/auto-complete instead. The supplied documentation example contains an autocomplete array. Example candidates include _id as a candidate identity, _score as a relevance value, area_type as a location category, centroid.lat and centroid.lon as coordinates, and city, state_code and country as geography. Example counties entries contain fips, name and state_code. Other type-dependent example fields include geo_id, slug_id, county_needed_for_uniq, city_slug_id, line, postal_code, has_catchment, school and school_id. Do not treat these fields as present on every suggestion or confuse a city identity with a property identifier. No successful response from this deprecated route was recorded in the supplied checks. The fields above come from an unverified, truncated documentation example rather than an observed response. Address-to-property resolution is a documented purpose, not a guarantee that a particular address will yield a property identifier. Before migrating, validate suggestion types, optional fields and the inputs accepted by the next property endpoint; do not assume the replacement route has an identical response contract.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/locations-v2-auto-complete Suggest US locations with explicit no-match handling
Details
Search for US location suggestions with the required input string and optional numeric limit query parameter. Documented input forms include states, cities, districts, street addresses and ZIP codes; examples include California, Los Angeles and 2425 Sahalee Dr W Sammamish, WA. The documented parameter examples are input=new york and limit=10. The limit controls the requested number of response items; no offset, page token or guaranteed page traversal is documented for this operation. Recorded successful checks establish an autocomplete array and a meta.es_total_hits count. With input=New York and limit=3, the response had meta.es_total_hits=5731 and three candidates identified as state:ny, city:ny_new-york and city:ny_manhattan, with state_code=NY and country=USA. The total hit count therefore need not equal the number of returned suggestions. A deliberately nonexistent location returned HTTP 200, meta.es_total_hits=0 and autocomplete=[] without an error object. Treat that combination as a valid no-suggestions result rather than a failed request. These observations establish representative outcomes, not fixed counts, ranking or future candidate availability. A separate, truncated documentation example lists candidate fields _id, _score, area_type, centroid.lat, centroid.lon, city, state_code, country, counties with fips/name/state_code, geo_id and slug_id. It also includes type-dependent city_slug_id, county_needed_for_uniq, line, postal_code, has_catchment, school and school_id fields. These additional example fields were not all verified by the recorded checks and are not mandatory on every candidate. Preserve the selected candidate identity, type and available geography, then verify what the next endpoint accepts. Although the description mentions finding a property identifier from an address, the recorded checks do not establish guaranteed address-to-property resolution.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-calculate-deprecated Legacy mortgage payment calculation (deprecated)
Details
Retained for existing mortgage calculators using six required numeric query parameters: downpayment for the down payment, hoi for home insurance, price for the home price, rate for the interest rate, tax_rate for property tax and term for the mortgage loan type. Preserve these exact parameter names when auditing an older integration. The documented input example is downpayment=44980, hoi=56, price=224900, rate=3.827, tax_rate=1.2485549449920654 and term=30. These are example values, not documented defaults or a list of allowed choices. The supplied documentation example contains a meta object and a mortgage object. Example mortgage fields are down_payment, loan_amount, rate, term, principal_and_interest, monthly_property_taxes, monthly_home_insurance, monthly_mortgage_insurance, hoa_fees, monthly_payment and total_payment. The monthly_* field names distinguish monthly amounts, and principal_and_interest identifies a separate payment component. Do not equate monthly_payment, principal_and_interest and total_payment or infer which charges each aggregate includes without validation. No successful check of this deprecated calculation route is supplied; the response fields above are from an unverified documentation example. The brief parameter descriptions do not explicitly define currency, insurance input period, rate scale, tax-rate units or term units. A term example of 30 does not by itself establish an allowed-term list. Confirm those conventions and payment scope in the existing application before mapping inputs to a current calculator. This route is a legacy migration surface, not a recommended foundation for new calculators, an interest-rate feed, a lender quote or a loan approval decision.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-calculate-affordability-deprecated Calculate income-based home affordability (deprecated)
Details
Legacy GET calculation for an income-based home-purchase budget. Supply annual_income, monthly_debt, debt_to_income_ratio, down_payment, loan_term, interest_rate, tax_rate and homeowner_insurance_rate; hoa_fees and is_pmi_included are optional. The documented ratio and rate examples use decimals, such as 0.43 for a 43% debt-to-income ratio and 0.03119 for a 3.119% interest rate. Preserve the legacy flag with care: its notes associate is_pmi_included with military service and say false sets down_payment to zero, which conflicts with the apparent meaning of its name. That behavior has not been verified. No live response was observed for this deprecated route. The truncated, unverified documentation example contains an affordability object with calculated_price, debt_to_income_ratio, house_expenses_ratio, hoa_fees, monthly_payment, principal_and_interest, monthly_property_taxes, monthly_home_insurance and monthly_mortgage_insurance. It also shows a range object keyed by numeric strings, with nested affordability breakdowns using the same field names. The example represents the output debt-to-income ratio as a percentage-style number even though the input example is fractional. Neither the full range coverage nor a complete response schema is established by that sample. Retain this operation only to document and migrate existing affordability integrations, not for new development. A payment calculator is not automatically an equivalent replacement for an income-based budget estimate. These figures do not establish loan eligibility, underwriting approval or a lender offer.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-check-equity-rates-deprecated Look up home-equity rates (deprecated)
Details
Legacy GET lookup for home-equity financing scenarios, separate from purchase-mortgage rate comparisons. All seven query inputs are required: creditScore, loanAmount, loanProduct, mortgageBalance, propertyValue, state and zip. creditScore is a category rather than a numeric score. loanProduct accepts HELOC or the documented fixed home-equity loan codes, with commas separating multiple products; the example selects 20-year and 30-year fixed equity loans. propertyValue remains a string even though it represents an amount, while loanAmount and mortgageBalance are numbers. No live response was observed for this deprecated route. The truncated, unverified documentation example shows disclosures.advertising_disclosure and disclosures.rate_disclosure; meta.count and meta.version; and a rates array. Example rate entries include advertiser, loanType, loanAmount, loanPayment, apr, annualFee, autoDebitDisc, introApr, introPeriod, maxLTV, minDraw, points, conditions, summary, isEditorial, isSponsored and lastUpdated. loanTerm and rate are null in the visible example, so those fields must not be treated as guaranteed numbers. The sample does not establish a complete response schema, current rate availability or the units and periods of every financial field. Retain this operation for legacy equity-rate migration only. The catalog supplies no verified current equity-rate replacement; a purchase-rate lookup or generic payment estimate is not automatically equivalent. Sample rates are not current lender quotes, approvals or a guarantee of qualification, and sponsored entries should not be represented as impartial rankings.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-check-rates-deprecated Compare mortgage rates by financing scenario (deprecated)
Details
Legacy GET mortgage-rate comparison request for purchase or refinance scenarios. All query inputs are required: creditScore, loanPercent, loanPurpose, loanTypes, points, propertyPrice and zip. creditScore accepts the documented quality categories; loanPurpose selects purchase or refinance; loanTypes selects ALL or one documented fixed-rate or adjustable-rate code; and points selects all, zero, zero_to_one or one_to_two. The documented loanPercent example is 85.2, not the fractional representation 0.852; propertyPrice is a numeric price amount. No live response was observed for this deprecated route. The truncated, unverified documentation example contains disclosures.advertising_disclosure and disclosures.rate_disclosure, meta.count and meta.version, a primary boolean, a providers array, and a rates array. Visible rate-entry fields include advertiser, aprVal, rate, loanFees, loanPayment, loanTypeDisplayName, points and isSponsored. points is represented as a string in the example. The snippet does not establish complete field coverage, current rates, ranking rules or the precise units and periods of all financial values. Treat disclosures and sponsorship indicators as context, not proof that an entry is best for a borrower. Use this route only as a legacy migration reference. Do not silently replace its credit-category, purpose, loan-type, percentage and points filters with a postal-code-only rate lookup: that would lose unverified assumptions. Historical example values are not current lender quotes, rate locks, eligibility decisions or commitments to lend.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-v2-calculate Estimate mortgage payments with fractional interest and tax rates
Details
Estimate a home-loan payment from the required price, down_payment, hoa_fees, home_insurance, property_tax_rate, rate, and term query inputs. The optional apply_veterans_benefits input is boolean. Down payment is a currency amount, not a percentage. Use fractional annual rates: rate=0.065 represents 6.5% interest and property_tax_rate=0.012 represents 1.2% property tax. A recorded check using 6.5 and 1.2 returned HTTP 200 but implausibly large amounts; HTTP success alone does not validate the financial assumptions. The successful check used price=500000, down_payment=100000, hoa_fees=0, home_insurance=100, term=30, and apply_veterans_benefits=false with the fractional rates above. It returned data.loan_mortgage with loan_amount=400000, rate=0.065, term=30, monthly_payment=3128, and total_payment=910178. Its monthly_payment_details reported principal_and_interest=2528, property_tax=500, and home_insurance=100; these monthly components sum to 3128. Keep total_payment as a separately labeled reported loan-total metric: it is not the same as multiplying the all-in monthly payment by 360, and inclusion of every recurring charge is not established. A separate, unverified documentation example uses a top-level mortgage object with down_payment, hoa_fees, loan_amount, monthly_home_insurance, monthly_mortgage_insurance, monthly_payment, monthly_property_taxes, principal_and_interest, rate, term, and total_payment. Do not assume that legacy example layout or a mortgage-insurance component is present in the observed layout. Nonzero HOA treatment and the effect of enabling veterans benefits were not verified. This is a scenario estimate, not a lender quote, eligibility decision, tax assessment, or insurance quote.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/mortgage-v2-check-rates Look up mortgage-rate context for a US postal code
Details
Request mortgage-rate information for the required postal_code query string, using a US ZIP code such as 90004. Keep the ZIP code as a string to preserve any leading zero. No recorded request to this operation is included in the evidence, so live availability, ZIP coverage, freshness, and returned rate units are unverified. The available documentation example is incomplete and shows top-level disclosures, meta, primary, providers, and rates. The disclosures object contains advertising_disclosure and rate_disclosure, while meta contains count and version. The providers array includes Name, Logo, Url, DisclaimerFull, and DisclaimerShort fields. Documented rates records include advertiser, rate, aprVal, loanTypeDisplayName, loanPayment, loanFees, points, isSponsored, and cpcUrl. These are source-example field names, not confirmed current response guarantees; the example does not establish observation timestamps or the interpretation and units of every amount. Display interest rate and APR separately, retain applicable disclosures and sponsorship labels, and verify loan assumptions before comparing payments or fees. Do not pass a returned rate directly into a mortgage calculator without confirming its numeric convention. This ZIP-based lookup is rate context, not a personalized offer, lender commitment, loan approval, or guaranteed real-time quote.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-detail-deprecated Retrieve deprecated property details using paired listing identifiers
Details
Legacy property-detail route retained for compatibility and migration work, not recommended for new integrations. It requires all three query strings: listing_id, property_id, and prop_status. The documented identifier sources are listing_id and property_id fields from property-listing search results, including the legacy list and version-2 list routes. Use the listing and property identifiers belonging to the same search result; they are distinct values and must not be substituted for each other. The documented prop_status choices are for_sale and for_rent. Examples such as listing_id=608763437 and property_id=4599450556 are illustrative, not verified current records. No recorded request to this operation is included, so availability, identifier validity, and the current response contract are unverified. The incomplete source example has a top-level listing object. Its address section shows city, county, state, state_code, postal_code, line, lat, long, neighborhood_name, neighborhoods, and time_zone. Other visible listing fields include beds, baths, baths_full, advertiser_type, agent, branding, broker, client_display_flags, client_display_text, client_event_data, and client_provider_data. These are documentation-example fields only; do not promise their current presence, completeness, or equivalence to a newer detail response. For migration, inventory stored identifier pairs and status values, then separately confirm the input and output contract of the current detail operation before changing links or field mappings. Deprecation does not establish a removal date or guarantee continued service.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-list-by-mls-deprecated Find property listings by MLS number (deprecated)
Details
Deprecated MLS-number search for maintaining and auditing older property lookup workflows. Supply the required mls_id string; optional limit and offset control the number of listings and the number skipped. The documented sort values are price_low, price_high, photos, newest, and open_house_date. An MLS number is not a guaranteed globally unique property identity, so retain MLS context when reconciling records. No live response was observed in the supplied evidence. An unverified documentation example contains a listings array, matching_rows and returned_rows counts, and a meta object. Example listing fields include property_id, listing_id, mls.id, mls.name, mls.abbreviation, address, address_new, beds, baths, prop_type, prop_sub_type, prop_status, price, price_raw, sqft, sqft_raw, photo_count, list_date, and last_update. The address_new object includes city, state_code, postal_code, lat, and lon. The example represents price and sqft as display strings, price_raw as a number, and sqft_raw as null; consumers should handle missing or null values rather than assuming uniform numeric fields. These example fields are not a verified current response contract. A current general property-search endpoint does not by itself establish an equivalent MLS-number filter; validate replacement behavior before migrating.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-list-for-rent-deprecated Search rental property listings (deprecated)
Details
Deprecated rental-search contract for auditing existing rental applications and planning filter-by-filter migrations. The legacy schema marks city, state_code, limit, and offset as required. City and state_code should use values from location autocomplete. Although postal_code is documented as an alternative that must not be combined with city and state_code, those two fields remain required in this schema; a postal-code-only request is not verified. The lat_min, lat_max, lng_min, and lng_max bounding-box inputs are documented as having no effect when postal_code, city, or state_code has a value, so they must not be presented as an effective additional restriction on the required city/state request. Optional filters cover price, bedroom and bathroom minimums, property area, property types, listing date, radius in miles, pet-policy flags, and community amenities. allows_cats and allows_dogs cannot be combined with no_pets_allowed. prop_type and mapi_community_features accept comma-separated documented values. The sort description lists completeness, photos, freshest, price_low, price_high, and newest, while the supplied example uses relevance; this discrepancy is unresolved. No live rental response was observed. A truncated, unverified documentation example begins with a listings array and includes property_id, listing_id, address, address_new, beds, baths, pet_policy, has_specials, price, price_raw, price_reduced, price_reduced_date, sqft, photo, photo_count, prop_type, prop_status, list_date, and last_update. In that fragment beds, baths, price, and sqft are strings, while price_raw is numeric; address_new includes city, state_code, postal_code, lat, and long. The fragment is incomplete and does not establish a complete response envelope, current field availability, freshness, or successful request behavior. Verify pet-policy and community-feature equivalents explicitly before migrating a saved rental search; do not silently omit unsupported constraints.
| 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 |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-list-for-sale-deprecated Search homes for sale with legacy filters (deprecated)
Details
Deprecated for-sale property search for maintaining older buyer-search forms and auditing saved-search migrations. city, state_code, limit, and offset are required by the legacy schema; city and state_code are described as location-autocomplete values. postal_code is documented as an alternative that must not be combined with city and state_code, which conflicts with their requiredness in this contract; postal-only behavior is unverified. The four bounding-box parameters lat_min, lat_max, lng_min, and lng_max are documented as ineffective whenever postal_code, city, or state_code has a value, so they are not a confirmed additional restriction on the required city/state search. Optional buyer-search inputs cover price, bedrooms, bathrooms, home age, property area, lot size, listing date, radius in miles, comma-separated property types and features, and the is_contingent, is_foreclosure, is_matterports, is_new_construction, and is_pending boolean flags. reduced remains a string parameter with documented true/false values, unlike the boolean status flags. Sort values include relevance, price_low, price_high, photos, newest, open_house_date, sqft_high, and price_reduced_date. No live sale-search response was observed in the supplied evidence. A truncated, unverified documentation example begins with a listings array and includes property_id, listing_id, address, address_new, beds, baths, baths_full, price, price_raw, sqft, sqft_raw, prop_type, prop_sub_type, prop_status, is_new_construction, is_new_listing, photo_count, list_date, last_update, and an mls object with id, name, and abbreviation. The fragment represents beds and baths as numbers, price and sqft as display strings, price_raw as a number, and sqft_raw as null. address_new includes city, state_code, postal_code, lat, and lon. Because the example is incomplete, a complete envelope, result totals, current field availability, and successful request behavior are not established. Before migrating, verify each purchase-search status and feature constraint, especially foreclosure, pending, and price-reduction requirements; do not silently drop unsupported filters.
| 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 |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-list-similarities-deprecated Find similar properties by property ID (deprecated)
Details
Retrieve suggested similar properties through a deprecated listing route. All three query parameters are required: property_id is the numeric property identifier from property-list results, prop_status selects for_sale or for_rent, and limit specifies the requested number of suggestions. These are recommendation candidates, not a verified set of completed-sale comparables or an appraisal. No probe response was recorded for this operation. The supplied legacy response example is truncated and unverified, so its fields document an example rather than a guaranteed current schema. It shows results.similar_homes.count and results.similar_homes.properties. Example property entries contain property_id, listing_id, status, list_price, list_date, last_update_date, location, photos, and primary_photo. The description object includes beds, baths, sqft, lot_sqft, type, and year_built; additional_info includes display values and comparison fields such as compared_price_diff and compared_sqft_diff. Price fields including last_sold_price can be null. Do not infer an exact ranking formula, equal coverage with newer routes, or a confirmed sale price from these example fields. Check identifier mapping and missing-field handling when replacing an older recommendation widget.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-list-sold-deprecated Search sold property listings with legacy filters (deprecated)
Details
Search sold-home listing records through a deprecated route. The request contract requires city, state_code, limit, and offset. Optional filters cover price, home age, property size, lot size, property type, radius in miles, postal code, coordinate bounds, and sort order. prop_type accepts comma-separated documented values: single_family, condo, mobile, multi_family, farm, and land. offset is the number of items to skip for pagination, not a page number. The location documentation has important limitations: it says not to combine postal_code with city or state_code, and says coordinate bounds have no effect when postal_code, city, or state_code has a value. Because city and state_code remain required in this request contract, neither postal-only nor bounds-only search is established as usable here. Preserve these constraints rather than silently dropping required inputs. The sort description lists price_low and price_high, while its documented example is relevance; acceptance of that example has not been verified. No maximum limit or complete ordering behavior is documented. No probe response was recorded for this operation. The supplied source example is truncated and unverified. Its visible listings array contains property_id, listing_id, prop_status, prop_type, sold_date, list_date, last_update, address, structured address_new data, coordinates, beds, baths, photo, and photo_count. It also distinguishes formatted price and sqft values from price_raw and sqft_raw. These example fields are not a guaranteed current schema. Neither the price filters nor price_raw alone establish a verified closing price. Record request dates and candidate identifiers when auditing or migrating historical sold-home queries.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-detail-deprecated Look up legacy v2 property details (deprecated)
Details
Retrieve property detail information through the deprecated v2 detail route. Its sole documented input is the required property_id query parameter, declared as a string and obtained from property-list results. Preserve the identifier exactly: the documented example is O3599084026, with a leading letter, so numeric coercion can change the request. This operation does not document an address, listing_id, or geographic search input. No probe response was recorded for this operation. The supplied legacy example is truncated and unverified; it is not evidence of current availability or a complete response contract. The visible example has a meta object with matching_rows, returned_rows, and schema, plus a properties array. Its visible property fields include a structured address with coordinates, postal and state codes, neighborhood information, and time_zone; beds, baths, baths_full; building_size.size and building_size.units; description; and nested agents, broker, buyer_agent_for_far, and buyer_office objects. Optional attributes such as cooling and heating are null in the visible example. When migrating property-detail pages or cached records, keep this array-based example shape distinct from any replacement response. Do not assume a single top-level property object, complete field coverage, stable nesting, or interchangeable schemas. Handle a retrieval failure separately from a missing or null attribute, and validate identifier preservation and field mapping explicitly.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-by-mls-deprecated Legacy v2 MLS property lookup (deprecated)
Details
Look up legacy property listings by the required mls_id. The optional prop_status filter accepts for_sale, for_rent, or recently_sold; limit controls the number of items requested and offset skips items for pagination. Retain MLS source and listing-status context when comparing records: the documentation does not establish global uniqueness of an MLS number. Response documentation, not observed output: the supplied source example contains meta.matching_rows and meta.returned_rows plus a properties array. Illustrated property fields include property_id, listing_id, price, beds, baths, baths_full, prop_status, prop_type, prop_sub_type, photo_count, and last_update. The address object includes line, city, state, state_code, postal_code, lat, and lon; the mls object includes id, abbreviation, name, and type. These fields come from an unverified source example, and no probe response is available for this operation. Their current presence, completeness, and availability are not confirmed. This deprecated route is retained to document legacy MLS-number workflows and migration requirements, not as a recommended entry point for new integrations or a complete MLS feed. Do not assume that a current general property search accepts the same MLS-number query.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-for-rent-deprecated Legacy v2 rental property search (deprecated)
Details
Document an older rental-property search using the required city, state_code, limit, and offset query parameters. Optional inputs cover price bounds, minimum beds and baths, property and lot size, prop_type, prop_sub_type, allows_cats, allows_dogs, comma-separated features, radius, and sort. Documented examples are New York City, NY, 200 items, offset 0, and relevance sorting; these are not confirmed server defaults. radius is documented in miles from 1 to 20. Location caveat: the documentation says postal_code must not be combined with city and state_code, and the latitude/longitude bounds have no effect when postal_code, city, or state_code has a value. However, city and state_code remain required in this retained contract. Do not present postal-only or bounding-box-only search as a verified supported request or assume map bounds constrain the required city/state query. Response documentation, not observed output: the supplied source-example fragment shows meta.matching_rows, meta.returned_rows, and a properties array. Its first entry includes listing_id, listing_status, address, beds, building_size, lot_size, community, last_update, list_date, and photo_count. The address object includes line, city, state_code, postal_code, lat, and lon. The community object shows beds_min, beds_max, baths_min, baths_max, price_min, price_max, sqft_min, and sqft_max; the illustrated community size bounds are null. A photos field starts in the fragment, but the supplied example is truncated and is not a complete parseable response. No probe response is available; these historical fields do not confirm current rental availability, pet policies, amenity coverage, or response completeness. This deprecated route is a migration reference, not a recommended new rental integration. Inventory pet, subtype, and amenity requirements explicitly and verify a replacement contract rather than assuming every legacy filter transfers unchanged.
| 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 |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-for-sale-deprecated Legacy v2 homes-for-sale search (deprecated)
Details
Document a legacy buyer search for properties for sale with required city, state_code, limit, and offset query parameters. Optional criteria include price and property-size bounds, lot size, minimum beds and baths, property age bounds, prop_type, prop_sub_type, comma-separated features, radius, and sort. Boolean flags separately describe open houses, contingent listings, foreclosures, 3D tours, new construction, homes not yet built, and pending listings through has_open_house, is_contingent, is_foreclosure, is_matterports, is_new_construction, is_new_plan, and is_pending. The documented radius range is 1 to 20 miles. New York City, NY, limit 200, offset 0, and relevance sorting are supplied examples, not confirmed defaults. Location caveat: postal_code is documented as incompatible with city/state_code, although city and state_code remain required. The lat_min, lat_max, lng_min, and lng_max bounds are documented as having no effect when postal_code, city, or state_code has a value. Treat these conflicting legacy location modes as migration issues, not as verified postal-only, map-only, or city-plus-bounds search capabilities. Response documentation, not observed output: the truncated source-example fragment shows meta.matching_rows, meta.returned_rows, and a properties array. Visible property fields include property_id, listing_id, price, beds, baths, baths_full, prop_status, prop_type, prop_sub_type, photo_count, last_update, address, and mls. The address object shows line, city, state_code, postal_code, lat, and lon; the mls object shows id, abbreviation, name, and type. The fragment is not a complete parseable response, and no probe response is available. These historical fields do not confirm current inventory, response completeness, open-house availability, or the presence of tour data. Retain this deprecated route as a buyer-search migration reference only. Evaluate open-house, new-plan, new-construction, and listing-status intent against a replacement contract individually; do not assume a current property-search operation accepts the same GET query or identical filter semantics.
| 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 |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-similar-homes-deprecated Find similar homes for sale by property ID (deprecated)
Details
Legacy lookup for homes for sale similar to a reference property. Send the required property_id query parameter as a string, using a property_id returned by a property-listing response. This route is explicitly deprecated and should be retained only for reviewing or migrating an existing sale-recommendation workflow. The deprecation notice points to /properties/v2/list... endpoints; it does not establish an equivalent replacement or identical recommendation ranking. No observed probe response or documented response example is available for this operation. Consequently, no response envelope, result-field names, recommendation count, ordering or current availability is verified.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-similar-rental-homes-deprecated Find similar rental homes by postal code and property ID (deprecated)
Details
Legacy lookup for rental homes similar to a reference property. Both postal_code and property_id are required string query parameters: take postal_code from a listing response and property_id from a property-listing response. A postal code alone is not a complete request, and the documented contract does not establish a configurable search radius. This route is explicitly deprecated; its notice points to /properties/v2/list... endpoints without confirming an equivalent rental recommendation contract. No observed probe response or documented response example is available for this operation, so the response envelope, rental-status fields, asking-rent fields, ordering and empty-result format are unverified. Do not treat suggested rental candidates as evidence of completed leases or achieved rents.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v2-list-sold-deprecated Search sold properties with legacy filters and paging (deprecated)
Details
Deprecated sold-property search with required city, state_code, limit and offset query parameters. Use city and state_code strings from location autocomplete results; limit is a numeric requested page size and offset is a numeric count of records to skip. Optional numeric filters cover home age, minimum bedrooms and bathrooms, price, building size, lot size, geographic bounds and a radius of 1 to 20 miles. prop_type accepts documented property-type values, comma-separated for multiple types; sort accepts sold_date, beds_high, price_low, price_high or lot_sqft_high. The location documentation is internally constrained: postal_code must not be combined with city/state_code, but city/state_code remain required in this retained contract. Coordinate bounds are documented as ineffective whenever postal_code, city or state_code has a value; do not promise a postal-only or bounding-box-only request. No observed probe response is available. An unverified, truncated source example shows meta.matching_rows and meta.returned_rows, plus a properties array with property_id, listing_id, prop_status, prop_type, price, beds, baths, baths_full and nullable baths_half. It also shows address fields including line, city, state_code, postal_code, lat and lon; building_size and lot_size objects with size and units; photo_count, photos, list_date and last_update. These are source-example fields, not a verified response schema or a guarantee of current availability. The example does not establish that price is a completed sale price or that list_date is a closing date. Retain this endpoint for legacy migration review and independently verify sold status and transaction fields before valuation use.
| 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 |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-detail Get US property details by property ID
Details
Retrieve a selected US home using the required property_id from property search. An optional listing_id can carry the listing context returned by search; it does not replace property_id. Both inputs are query strings. The successful observed response used data.home and returned property_id, listing_id, list_price, last_update_date, address information, description text and photos. The checked home had a list_price of 1325000 and 75 photos; these are observations for one record, not required values or guaranteed media coverage. Treat last_update_date as the returned record timestamp, not a guarantee of feed-wide freshness. Inspect the response body as well as the HTTP status. An observed invalid property_id returned HTTP 200 with data.home=null and an errors entry containing extensions.code=HTTP_ERROR and extensions.data.code=500. Do not treat every HTTP 200 as a found home or every null home as a clean not-found result. The endpoint documentation mentions a Home Value feature, but the supplied successful observation does not establish valuation field names, an automated valuation model, or a historical value series. The retained source example is truncated and listing-oriented; it is unverified and should not override the observed data.home response shape.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-get-commute-time Request commute time from a property to a destination
Details
Request travel time from a US property to a destination address. Supply the required property_id from property search and destination_address as query strings. Use a complete destination, including locality information when available; location autocomplete is documented as a way to obtain a more complete address. Optional transportation_type accepts the documented values bicycling, driving, transit and walking. The example value walking is not an established default. Optional with_traffic is a boolean described as requesting rush-hour time calculation; false is the documented example, not a verified omission default. These input controls do not establish real-time traffic coverage or availability of every mode for every journey. No observed probe response is available for this operation. The retained source example is truncated and begins with listing data rather than an identifiable commute result. No commute-specific response field names, time units, route geometry or traffic forecast fields are established by that example. Validate the actual response contract before parsing travel times or presenting numerical commute comparisons; do not assume a duration key or unit from the endpoint name.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-get-photos Get a property photo gallery by property ID
Details
Retrieve photos associated with a US property by supplying the required property_id query string from property search. This operation has no listing_id input, pagination control, image-size selector or documented photo-filter parameter. The observed successful response placed matching records under data.home_search.results rather than directly under data.home. It contained one result with property_id, listing_id and 75 photos with image URLs and image tags. Traverse the results collection, associate the photos with the returned identifiers, and accommodate empty collections or missing media. The observed photo count is specific to one property, not a fixed gallery size or coverage guarantee. Exact URL and tag member names were not recorded in the probe summary and should be checked before binding an image component. The retained source example is truncated and listing-oriented; it is unverified and does not establish an alternative response schema. A property-keyed request should not be treated as a guarantee of immutable listing-specific media, fixed image ordering or stable URL lifetimes. Returned image URLs provide access references, not an image redistribution or commercial-use license; confirm rights before storing or republishing photographs.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-get-surroundings Get property surroundings with optional flood information
Details
Retrieve surroundings data for one US residential property with GET /properties/v3/get-surroundings. The required property_id query parameter is the property_id returned by a property-list operation, not its listing_id. The optional boolean enable_flood query parameter controls whether flood information is included; false is the documented example, not a verified server default. No successful response probe or parseable JSON response example is available in the supplied evidence, so response field names, nesting, coverage and flood-specific values remain unverified. Do not assume that the response includes a flood zone, risk score, map geometry or any particular neighborhood metric. Use available surroundings data as optional context, treat absent environmental information as unknown rather than safe, and obtain an authoritative flood determination or insurance assessment separately.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-list Search US properties for sale, rent or sold listings
Details
Search residential listings with POST /properties/v3/list and an optional JSON request body. The documented body fields are state_code (string), status and type (arrays), list_price, beds, baths and sort (objects), cats and dogs (booleans), and limit and offset (integers). No body parameter is marked required. A successful HTTP 200 probe used state_code="CA", status=["for_sale"], limit=3, offset=0 and sort={"direction":"desc","field":"list_date"}. That probe verifies this California for-sale request, not every state, status, property type or filter combination. Nested schemas for list_price, beds and baths, additional sort values, array enums and pet-filter behavior were not established by the supplied evidence; do not import a ZIP-code body or filter syntax from another route. The observed response contains data.home_search.count, total and results. The sample returned count=3 and three results while total=161224 described the broader matching set, not the number of rows on the page. Observed result fields include property_id, listing_id, status, list_price, list_date, last_sold_date and last_sold_price; location.address contains line, city, postal_code, state_code, state, country and coordinate. The description object includes type, sub_type, beds, baths, baths_full and sqft. Additional observed fields such as primary_photo, photo_count and some size and flag values can be null. Keep property_id and listing_id distinct for subsequent lookups. The sample had California addresses and 2026-10-22 listing dates; those observations do not establish complete inventory, a real-time update guarantee or non-null data for every listing. No separate source response example is supplied for this operation; the listed response fields come from the successful probe.
| Parameter | In | Value |
|---|---|---|
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body | ||
| body |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/properties-v3-list-similar-homes Find similar homes for a selected property
Details
Request similar-home candidates with GET /properties/v3/list-similar-homes. Supply the required property_id query string from the property_id field of a property-list result, not its listing_id. The optional status query string accepts one documented value: for_sale, ready_to_build, for_rent, sold, off_market, other or new_community. The optional numeric limit controls the number of items per response; 10 is the documented example, not a verified default or maximum. Only limit is exposed for response sizing on this route; no offset, page number or cursor input is documented. There is no successful response probe or source response example in the supplied evidence. Consequently, the response envelope, candidate field names, actual result count, similarity criteria, ranking and geographic scope have not been verified. Present any returned homes as suggested alternatives, verify their geography, status and property attributes before comparison, and do not treat this operation as a comparable-sales appraisal or valuation.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/schools-detail Look up an individual US school by its school ID
Details
Retrieve detailed information for one school using GET /schools/detail. The required query parameter id is a string containing an existing school identifier; it is not a school name, district ID, property ID, or address. The source documentation identifies schools[].id in a school-list result as the identifier source, but that school-search route is unavailable as a discovery dependency. Use a school ID confirmed separately and pass it unchanged. Response coverage is unverified for this operation: the supplied evidence contains neither a successful probe response nor a response example. No response envelope or individual detail fields are therefore established. In particular, do not promise a name, address, ratings, contact details, enrollment counts, attendance boundaries, or district membership until the actual response has been verified. Missing-ID behavior and field nullability are also undocumented. Use the result to enrich a known school record, retaining source provenance and explicit missing-data states. A school-detail lookup does not establish that a property is assigned to the school, that a student can enroll, or that the record is complete or current.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/schools-get-school-district Retrieve a US school district record by district ID
Details
Retrieve detailed information for a school district using GET /schools/get-school-district. Supply the required query parameter id as a string containing a confirmed district identifier. This is a district lookup, not an individual school lookup or an address-to-district search. The source documentation identifies districts[].id in a school-list result as the identifier source, but the school-search route is unavailable as a discovery dependency. Obtain a verified district ID separately and preserve its value. No successful probe response or response example is supplied for this operation. Consequently, the response envelope and district record fields are unverified. The evidence does not establish a district name or address field, school membership list, contact information, boundary geometry, ratings, enrollment rules, or missing-record error format. Do not describe any of these as guaranteed output or reuse a schema from another school operation. A district-information panel should expose only fields verified in the actual response and retain missing-data and provenance indicators. District facts alone do not resolve property attendance boundaries, school assignment, or enrollment eligibility; those require current official verification.
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
/api/project/realty-in-us/schools-list-nearby-deprecated List schools near coordinates using the deprecated legacy route
Details
Deprecated: retain GET /schools/list-nearby only for auditing or migrating existing integrations, not for new development. The operation is documented to list schools near a property location. Supply both required numeric query parameters: lat for latitude and lon for longitude, expressed as decimal-degree coordinates. The documented example values are lat=35.129431 and lon=-117.937021. No property ID, address, radius, pagination, grade filter, or attendance-assignment input is documented. There is no supplied live probe response for this operation. An unverified source example labeled HTTP 200 is present but truncated, so it is not a complete valid JSON response or proof of current route availability. Its visible top-level fields are districts (an empty array in the example), meta.build, and schools. A complete school record within the example includes id, name, greatschools_id, nces_id, funding_type, education_levels, grades.range.low and grades.range.high, lat, lon, and distance_in_miles. It also shows district.id and district.name; location.city, city_slug_id, county, postal_code, state, and street; phone; ratings.great_schools_rating and ratings.parent_rating; relevance; student_count; student_teacher_ratio; and boundary_trimmed.type with nested boundary_trimmed.coordinates. These are example fields, not observed or guaranteed current output. The example has a null ratings.great_schools_rating value, and its empty districts array establishes no district-list schema. Do not assume fixed ordering, complete school coverage, a stable search radius, a particular rating scale, or fresh enrollment statistics. Proximity and example boundary geometry do not establish attendance assignment or enrollment eligibility. Use the route only to understand an existing nearby-school dependency and its nullable fields. Validate a replacement independently before promising continuing nearby-school coverage; do not depend on the unavailable school-search route as a replacement or ID discovery step.
| Parameter | In | Value |
|---|---|---|
| query | ||
| query |
Request cost is temporarily unavailable. No price is assumed.