Look up any listing by MLS number or address
https://api.ruuster.com/v1/properties/lookupResolve one MLS number or street address to a listing in your MLSs, whether or not it's yours. A lookup call (20 per minute). Use it to turn an MLS number or address from a buyer's email, a showing request or a user's question into a propertyId.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: lookup call, 20 per minute per key, within the 120 per minute
Finds a listing in any of your brokerage's MLSs by its MLS number, including listings other brokerages hold. It answers one number per call and is a lookup call, so it shares the lower limit of 20 per minute (see Limits). To search your own inventory only, use ?mlsRecordId= on List listings instead.
The number is matched exactly as the MLS publishes it, or as the digits-only form where the MLS stores one (see MLS numbers). Older sales are found too, however long ago they closed, as far back as Ruuster's history for that MLS goes.
With address, send the street line plus a city or zip code (the state helps). The house number and the first word of the street name are matched, so "Trail" and "Trl" or a missing unit both find the home; a house number on more than one street of that name returns each, newest first, up to 10.
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
mlsRecordId |
string | required unless address |
The MLS number, with or without its leading letters |
address |
string | Instead of mlsRecordId: a street address with a city or zip, for example 1013 Crossroads Trl, Milton, GA 30004 |
|
mlsId |
string | all your MLSs | Limit the search to one of your brokerage's MLSs (see /me › mlsIds) |
agent |
string | your default agent | Whose page the listing links (url) open under: an agentId, email or landing-page slug from List agents. Whoever signs up from such a link becomes that agent's lead. Without it, links credit your brokerage's default agent (where unassigned leads go). meta.agent names the agent credited |
Response
data.properties holds every match, each a property object as described on List listings, plus matchedOn (exact or digits for an MLS number, address for an address). ownedByYou is true for a listing attributed to your brokerage and false otherwise. data.ambiguous is true when more than one listing matched; send the full number or add mlsId to pick one. No match returns an empty list with 200.
From the result, Get a listing returns the full gallery, List a listing's viewers with scope=any names your leads who viewed it, and Get listing engagement with scope=any returns your leads' activity on it over time.