Get property surroundings with optional flood information
View all Realty in US Property & Mortgage Data endpoints →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.
API Features
Live API Demo
🔒 Sign in to try it live
Log in to call this API with your own API key. New accounts get 100 free credits — no card required.
Log in / Sign upNo active API key found. Create one in your Dashboard, then reload this page. Dashboard →
/api/project/realty-in-us/properties-v3-get-surroundings API Response (JSON)
{} curl -X GET 'https://api.opendata-api.com/api/project/realty-in-us/properties-v3-get-surroundings?key=<API_KEY>&property_id=<property_id>'
Query Result
Use Cases
- Add an optional surroundings panel to a shortlisted home using its property_id from search results.
- Let a homebuyer choose whether a surroundings request should include flood information through enable_flood.
- Display an environmental-data-unavailable state when the surroundings response does not supply usable context, rather than labeling the home safe.
- Use property surroundings as preliminary context before directing a buyer to an authoritative flood determination or insurer assessment.
Frequently asked questions
Which identifier does the surroundings request require?
Supply the property_id from a property-list result in the required property_id query parameter. A listing_id is a separate identifier and should not be substituted.
How do I request flood information for a property?
Set the optional enable_flood query parameter to true. It is documented as controlling inclusion of flood information, but the supplied evidence does not verify any particular flood field or coverage.
Does omitting enable_flood mean flood information is disabled?
The documented example is false, but there is no verified default for an omitted flag. Set enable_flood explicitly when the choice matters to the application.
Which surroundings response fields have been verified?
None have been verified in the supplied evidence: there is no successful probe or parseable JSON response example for this operation. Do not build a fixed schema around assumed risk scores, flood zones or map geometry.
Can missing surroundings or flood data establish that a home is safe?
No. Unavailable information means the environmental context is unknown. This lookup is not an official flood determination, an insurance assessment or a guaranteed property-risk report.