Realtor Property Description API - Narrative by 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.

API Features

Matched description identifiers Both propertyId and listingId are required and should originate from the same discovered listing.

Narrative-only read intent The documented operation targets listing descriptions rather than providing the verified full-detail contract.

Listing-version awareness A property can have different listing identities over time; keep the chosen ID pair together.

Text-schema verification No description payload was observed for this route, so verify the returned text field before rendering it.

Live API Demo

GET /api/project/realtor/property-get-descriptions

API Response (JSON)

{}

curl -X GET 'https://api.opendata-api.com/api/project/realtor/property-get-descriptions?key=<API_KEY>&propertyId=<propertyId>&listingId=<listingId>'

curl -X GET 'https://api.opendata-api.com/api/project/realtor/property-get-descriptions?key=<API_KEY>&propertyId=<propertyId>&listingId=<listingId>'

📢

Need Help?

If you encounter API issues or need other API requirements, please contact us.

Use Cases

Load authorized narrative content on demand for a specific selected listing after validating the response.
Run human listing-quality reviews that compare narrative claims with observed housing attributes.
Check whether descriptions change across distinct listing IDs for the same saved property.
Evaluate a smaller description-only read for editorial review queues that do not need photo galleries.

Frequently asked questions

Where do propertyId and listingId come from?

Take property_id and listing_id from the same current search row and pass them as propertyId and listingId. They identify different entities and must not be swapped or combined across records.

Is the narrative always at data.description.text?

That path was confirmed only in the tested property-v2-detail response. This separate description operation was not live-tested, so do not assume it uses the same field.

Can I keep reusing an old listingId when propertyId stays the same?

Do not assume so. A property can be relisted, and behavior for outdated ID pairs is unconfirmed. Preserve the pairing and check current search results for the intended listing identity.

Related operations

Guides

View Subscription Plans →

Get a Listing Narrative by Property and Listing ID