Get a listing
https://api.ruuster.com/v1/properties/{propertyId}One listing with its photo gallery and the home's details (beds, baths, living area, lot, year built, garage, HOA, taxes). Any listing by propertyId, whether or not it's yours; your own listings also by MLS number (mls:<number>).
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: 120 requests per minute per key
Pass a propertyId to read any listing in Ruuster, one per call: your own, or a home one of your leads looked at (the propertyId in an event or in a lead's activity). ownedByYou tells you which. You can also pass mls:<number>, for example /properties/mls:22418765, to find one of your listings by MLS number with the matching rules on MLS numbers; for any other listing's MLS number use Look up any listing by MLS number. An unknown propertyId, or an MLS number that isn't one of your listings, returns 404 not_found.
This is the only call that returns the full gallery and the home's details, so they stay one listing per call. Nothing lists listings beyond your own inventory.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId |
string | The listing's propertyId (uuid), or mls:<number> to find it by MLS number. See MLS numbers |
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
agent |
string | your default agent | Whose page the listing link (url) opens under: an agentId, email or landing-page slug from List agents. Whoever signs up from the link becomes that agent's lead. Without it, the link credits your brokerage's default agent (where unassigned leads go). meta.agent names the agent credited |
Response
data.property is one property object, described on List listings, plus:
| Field | Description |
|---|---|
photos |
Every image URL of the listing in the MLS's order, up to 50. photoUrl is the first of them. The URLs are the MLS feed's own; hosting and expiry are the MLS's, and use is subject to your MLS's rules |
details |
The home, from its MLS record (the same facts a CMA reads for its subject): propertyType (house, townhouse, condo, other), bedrooms, bathrooms (total), bathroomsFull, bathroomsHalf, livingArea (sq ft), lotSizeAcres, yearBuilt, garageSpaces, stories, pool, basement (none, unfinished, finished), view, subdivision, newConstruction, hoa (hasHoa, feeMonthly), taxAnnual, taxYear. A fact the MLS doesn't publish is null |
ownedByYou |
true when the listing is attributed to your brokerage. For another brokerage's listing matchSource, firstSeenAt, lastSeenAt and updatedAt are null |