Returns list of listings
get
required
string
apiKey
(default: "")
API KEY
optional
numeric
limit
(default: 20)
Provide number of properties per page (10 / 20 / 40)
optional
numeric
page
(default: 1)
Provide page number (1 or higher)
optional
string
sort
(default: date)
Provide sorting factor (price / size / date). Default sorting value is date update
optional
string
order
(default: desc)
Provide sorting order (desc / asc)
optional
string
id
(default: "")
ID number of an individual listing,or a comma-delimited list of ID numbers.
optional
string
status
(default: 1,2)
Provide specific status id(s) [CSV] (Sales : 1, Rentals : 2, In Contract : 11, Offer In : 12, App. Pending : 21, Sold : 19, Rented : 22, Suspended : 0, Sales Inactive : -1, Rentals Inactive : -2, In Contract Inactive : -11, Offer In Inactive : -12, App. Pending Inactive : -21, Sold Inactive : -19, Rented Inactive : -22)
optional
string
updated_since
(default: "")
Confine results to listings which have benn updated since this time. Format MM/DD/YYYYTHH:MM
optional
string
type
(default: "")
Listing Building Type
optional
string
distribute
(default: 0)
Public listings only set to 0 or to include Internal Listings set to -2
optional
boolean
internal
(default: false)
Set to true to filter only internal listings (distribute values: 0, 3, -3, -2)
optional
string
neighborhood_id
(default: "")
ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers
optional
numeric
priceMin
(default: 0)
Provide minimum price
optional
numeric
priceMax
(default: 0)
Provide maximum price
optional
numeric
bedsMin
(default: -1)
Provide minimum bedroom count
optional
numeric
bedsMax
(default: -1)
Provide maximum bedroom count
optional
numeric
bathMin
(default: 0)
Provide minimum bathroom count
optional
numeric
bathMax
(default: 0)
Provide maximum bathroom count
optional
boolean
shortTerm
(default: 0)
Brings only short term listings
optional
numeric
sortByCompanyID
(default: 0)
Company internal CID to bring the company listing at first
optional
boolean
includeCoAgent
(default: false)
True or False to include co-agent fileds or not
optional
boolean
includeContacts
(default: false)
True or False to include contact records associated with listings. This option applies to company Databse only, no RLS DB nor MLS DB. Opne Listing DB (Listing Force) automtically includes contact records.
optional
boolean
includeDoc
(default: false)
True or False to include document assigned on assocaited contact level
optional
boolean
includeLastOffmarketDate
(default: 0)
include the last date when the listing becomes off market status
optional
boolean
addLabels
(default: false)
Boolean value to include labels associated with each listing
optional
string
label
(default: "")
Provide label name to search for
optional
string
rls_id
(default: "")
Provide RLS ID
optional
string
mls_no
(default: "")
Provide MLS No to search
optional
string
category
(default: "")
Provide a category value or a list of the listing category values. (0: Open, 1: Semi-exclusive, 2: Exclusive, 4: Private 6: Co-Broke)
optional
string
amenities
(default: "")
Provide amenities limitation [CSV] (Fireplace,Private Deck,Balcony,Terrace,Outdoor Space,Garden,Patio,Dining Room,Multi Level,Duplex,Triplex,Loft,Furnished,Dishwasher,Washer,Hardwood,High Ceilings,Renovated,Marble Bath,Granite Kitchen,Light,NO FEE,Vacation Rental,Eat In Kitchen,Walk In Closet,Laundry In Unit,Doorman,Elevator,Brownstone,Health Club,Pool,Garage,Subway,New Construction,Diplomats OK,Laundry,Bicycle Room,Storage,Nursery,Lounge,Valet,Roof Deck,Wheelchair Access,WiFi,Common Outdoor Space,Virtual Doorman,Receiving Room,Business Center,Green Building,River View,Park View,City View,Open View,Lake View,Freight Elevator,Concierge,Senior Housing,Live Work,Original Details,Skyline View,High Speed Internet,Maid Service,Live In Super,Children Playroom,Courtyard,Driveway,,Microwave,Stainless Steel Appliances,Pied a Terre,Room For Rent,Laundry Services,Wall to Wall Carpeting,One Month Free,Recreational Room,Convertible,Wine Cooler,Open Kitchen)
optional
string
address
(default: "")
listing address to search for, API will return best matching results
optional
string
expand
(default: "")
The list of expanded resource types you want included in the returned data. Curretnly expand supports agents and contacts. Agents return array of all agents associated with the listings.
optional
boolean
featured
(default: false)
true or false to bring featured listings
optional
numeric
square_footage_min
(default: 0)
Minimum Square Footage
optional
string
pets_policy
(default: "")
List of pets option to search for (0: Unknown, 99: No Pets, 1: Cats Only,4: Dogs Only, 2: Small Pets, 3: Pets OK,98: Case By Case
optional
string
agent_email
(default: "")
Search by agent email
optional
string
marketplace_name
(default: "")
marketplace name from api_user table