Listings
List listings
GET
https://api.ruuster.com/v1/propertiesListings attributed to your brokerage, including listings that left the market in about the last 18 months. Also finds a listing by MLS number.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: 120 requests per minute per key
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
status |
string | active |
active (Active, Coming Soon), pending (Pending, Under Contract, Contingent), closed or all |
mlsRecordId |
string | Find by MLS number, with or without its leading letters. Searches your listings only and adds ambiguous to the response. See MLS numbers |
|
mlsId |
string | Limit to one of your MLSs (see mlsIds in /me) |
|
matchSource |
string | agent (the listing agent's MLS id is on one of your agents' profiles), office (an office Ruuster confirmed as yours) or both |
|
dateField |
string | updated |
Which date from and to filter on: updated (record changed), onMarket or closed |
from |
date | First day, YYYY-MM-DD, included. No date filter when omitted |
|
to |
date | Day after the last day, YYYY-MM-DD, excluded |
|
cursor |
string | meta.nextCursor from the previous page. Omit for the first page |
|
limit |
integer | 100 |
Rows per page, 1 to 500 |
countOnly |
0 | 1 |
0 |
1 returns { "total": n } and no rows |
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 is a list of property objects. meta.total is the number of matching listings and meta.nextCursor pages through them. With mlsRecordId, data.ambiguous is true when the digits matched more than one of your listings; send the full number or add mlsId to pick one.
Property object
| Field | Description |
|---|---|
propertyId |
Ruuster's id for the listing (uuid), the id in …/listings/<propertyId> on your site |
mlsId, mlsName |
The MLS the listing comes from |
mlsRecordId |
MLS number as the MLS publishes it |
mlsRecordIdCore |
The MLS number with its leading letters removed |
address, city, state, postalCode, price |
Listing facts |
status |
Ruuster status group: active, pending, closed or other |
mlsStatus |
The MLS's own status |
onMarketDate, closeDate |
Dates |
listAgentMlsId, listOfficeMlsId |
From the MLS |
matchSource |
Why it's attributed to your brokerage: agent, office or both |
photoUrl, mediaCount |
Primary photo and number of photos |
url |
The listing page on your Ruuster site, under an agent's page, …/agent/<slug>/listings/<propertyId>, so whoever signs up from it becomes that agent's lead: the agent you pass, else your brokerage's default agent (where unassigned leads go). Every link in one response credits the same agent, named in meta.agent. The plain …/listings/<propertyId> when your brokerage has no default agent and you passed none |
previousPropertyIds |
Planned. Earlier Ruuster ids when the listing was re-listed. [] until available |
firstSeenAt, lastSeenAt |
When Ruuster first and last attributed the listing to you |
mlsModifiedAt, updatedAt |
Last MLS change, and last change to this record |
ownedByYou |
true for every listing here. Property objects from Get a listing and Look up any listing by MLS number can describe another brokerage's listing, with ownedByYou: false |