RealtyMX Website API

Version 1.0.0

Resources:

accountVerifyStatus GET /account/getVerifiedStatus

Returns specific client record

Request
Method URL
GET api.realtymx.com/account/getVerifiedStatus
Parameters
Parameter Name Data Type Values
apiKey string required
email string required (default: "")
password string required (default: "")

accountVerifyAccount GET /account/verifyAccount

Verifys user account with verify code

Request
Method URL
GET api.realtymx.com/account/verifyAccount
Parameters
Parameter Name Data Type Values
apiKey string required
email string required (default: "")
verifyCode string required (default: "")

agentsDetails GET /agents/{id}

Returns specific agent

Request
Method URL
GET api.realtymx.com/agents/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required
includeSuspend string optional (default: false)
Include Agents with Suspend status

agentsBlogs GET /agents/blog/{id}

Returns specific agent's blogs

Request
Method URL
GET api.realtymx.com/agents/blog/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

agentsSearch GET /agents/search

Returns list of agents

Request
Method URL
GET api.realtymx.com/agents/search
Parameters
Parameter Name Data Type Values
apiKey string required
sort string optional (default: last)
Provide sorting factor (first / last / office / date)
order string optional (default: asc)
Provide sorting order (desc / asc)
includeSuspend string optional (default: false)
Include Agents with Suspend status
name string optional (default: "")
Provide agent's first or last name
language string optional (default: "")
Provide a language an agent speaks
office numeric optional (default: 0)
Provide agent's office id
team string optional (default: "")
Provide team id or list of tema ids separated by commas

agentsTestimonials GET /agents/testimonials/{id}

Returns specific agent's testimonials

Request
Method URL
GET api.realtymx.com/agents/testimonials/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

agentsTestimonialsSearch GET /agents/testimonialsSearch

Returns list of testimonials

Request
Method URL
GET api.realtymx.com/agents/testimonialsSearch
Parameters
Parameter Name Data Type Values
apiKey string required
order string optional (default: asc)
Provide sorting order (desc / asc)
limit numeric optional (default: 20)
Provide number of properties per page (10 / 20 / 40)
page numeric optional (default: 1)
Provide page number (1 or higher)

agentsVideos GET /agents/videos/{id}

Returns specific agent's videos

Request
Method URL
GET api.realtymx.com/agents/videos/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

alertsInsert POST /alerts

Inserts new leads (we call alerts) into the database

This API resource is only enabled for the specific API users by RealtyMX.
This API requires Stamp and Token paramters in order to accept the data.
Secret key and client id to generate Token paramter are given by ReatlyMX.

Stamp
Current UTC timestamp in milliseconds. The timestamp has to be unique everytime you make API request.
Token
Hmac hashed based authentication code calculated using below method.
  • Algorithm: HMACSHA256
  • Key: Secret key giving by RealtyMX
  • Message: JSON string consist of client id, giving by RealtyMX and UTC time stamp, example, {"stamp":1480542136994,"clientID":7}
  • PHP Example: hash_hmac('sha256', '{"stamp":1480542136994,"clientID":7}', 'key');


Request
Method URL
POST api.realtymx.com/alerts
Parameters
Parameter Name Data Type Values
Stamp string required
UTC timestamp in milliseconds
Token string required
Hmac hashed based authentication code
apiKey string required
Your API Key
firstname string required (default: "")
Provide client first name
lastname string required (default: "")
Provide client last name
email string required (default: "")
Provide client email address
phone string optional (default: "")
Provide client phone number
comment string optional (default: "")
Provide client comment
price numeric optional (default: 0)
Provide alert price. Based on this price argument, API will automatically calculate alert price range with +-10%
alertType string optional (default: For Rent)
Provide specific alert type. For Sale or For Rent
minBeds numeric optional (default: 0)
Provide minimum bedroom value which the alert search is looking for
minBath numeric optional (default: 0)
Provide minimum bathroom value which the alert search is looking for
alertAddress string optional (default: "")
Provide specific address which areas alert search look for.
alertSource string optional (default: "")
Provide source name where this alert is originated.
agentEmail string optional (default: "")
Provide a specific agent email address who will be assigned to newly created alert.
listingID numeric optional (default: 0)
Provide specific listing id that user contact to, if this is provided, it will override price, listingType, areas argument.
Post Body Example
{
   "apiKey": "your api key",
   "price": 2000,
   "alertAddress": "99 John Street",
   "phone": "212-212-2121",
   "agentEmail": "[email protected]",   
   "lastname": "Doe",
   "firstname": "John",
   "alertType": "For Rent",
   "email": "[email protected]",
   "comment": "I'm interested in this apartment.",
   "alertSource": "Streeteasy",
   "minBath": 1,
   "minBeds": 1
   "stamp": "1550692140246",
   "token": "8CBD63A936961A489AD20B67D9BCD52ADEBA22A9C67BEADCC6AC64E0886C523F"
}
Response
Status Code Status Response
101 Sucess Response will be JSON object containing the response status code and the status description message.
{ "MESSAGE":"Successfuly inserted Alert for [email protected].", "STATUS":"Success","STATUS_CODE":"101" }
250 Error {"MESSAGE":"Email is required.","STATUS":"Error","STATUS_CODE":"250"}
251 Error {"MESSAGE":"Email is invalid.","STATUS":"Error","STATUS_CODE":"251"}
252 Error {"MESSAGE":"First Name is required.","STATUS":"Error","STATUS_CODE":"252"}
253 Error {"MESSAGE":"Last Name is required.","STATUS":"Error","STATUS_CODE":"253"}
254 Error {"MESSAGE":"The listing id with 4649 does not exist.","STATUS":"Error","STATUS_CODE":"254"}

alertslistingAlert POST /alerts/listingAlert

Inserts new alert with specific listing

This API resource is only enabled for the specific API users by RealtyMX.
This API requires Stamp and Token paramters in order to accept the data.
Secret key and client id to generate Token paramter are given by ReatlyMX.

Stamp
Current UTC timestamp in milliseconds. The timestamp has to be unique everytime you make API request.
Token
Hmac hashed based authentication code calculated using below method.
  • Algorithm: HMACSHA256
  • Key: Secret key giving by RealtyMX
  • Message: JSON string consist of client id, giving by RealtyMX and UTC time stamp, example, {"stamp":1480542136994,"clientID":7}
  • PHP Example: hash_hmac('sha256', '{"stamp":1480542136994,"clientID":7}', 'key');


Request
Method URL
POST api.realtymx.com/alerts/listingAlert
Parameters
Parameter Name Data Type Values
apiKey string required
listingID numeric required (default: "")
Provide specific listing id that user contacting to
firstname string required (default: "")
Provide client first name
lastname string required (default: "")
Provide client last name
email string required (default: "")
Provide client email address
phone string optional (default: "")
Provide client phone number
comment string optional (default: "")
Provide client comment
isRLS boolean optional (default: false)
indicates the listing is RLS or NOT
isMLS boolean optional (default: false)
indicates the listing is MLS or NOT
agentID numeric optional (default: -1)
Provide specific agent id
clientID numeric optional (default: -1)
Provide specific client id
Post Body Example
{
   "apiKey": "your API key here",
   "listingID": 1440541 ,
   "lastname": "Doe",
   "phone": "212-212-2121",
   "firstname": "John",
   "email": "[email protected]",
   "clientID": 0,
   "comment": "Is this still available?",
   "agentID": 3
   "stamp": "1550692140246",
   "token": "8CBD63A936961A489AD20B67D9BCD52ADEBA22A9C67BEADCC6AC64E0886C523F"
}

aprilwebhook POST /april

Update April Vidoe id

Request
Method URL
POST api.realtymx.com/april
Parameters
Parameter Name Data Type Values
apiKey string required
videoId string required (default: "")
Provide video ID
ulid string optional (default: "")
Provide unique listing ID

blogsSearch GET /blog/search/{count}

Returns list of blog articles

Request
Method URL
GET api.realtymx.com/blog/search/{count}
Parameters
Parameter Name Data Type Values
apiKey string required
count numeric required
Provide number of articles to show
label numeric optional (default: 0)
Provide a keyword to search for within a title or subtitle.
month_year string optional (default: "")
Provide month and year combination from which to extract articles. (4-2014)

blogsDetails GET /blogs/{id}

Returns specific blog

Request
Method URL
GET api.realtymx.com/blogs/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

blogsLabels GET /blogs/labels

Returns list of all blog labels

Request
Method URL
GET api.realtymx.com/blogs/labels
Parameters
Parameter Name Data Type Values
apiKey string required

buildingsSearch GET /buildings

Returns list of buildings

Request
Method URL
GET api.realtymx.com/buildings
Parameters
Parameter Name Data Type Values
apiKey string required
page numeric optional (default: 1)
Provide page number (1 or higher)
count numeric optional (default: 10)
Provide number of buildings per page. Max 50 buildings
cat string optional (default: "")
Provide specific neighborhood id(s) [CSV]
amenities string optional (default: "")
Provide amenities limitation [CSV] (doorman / outdoorSpace / elevator / healthClub / pets / newConstruction / nofee)
category string optional (default: "")
Provide specific category value(s) [Accept comma sepeated values] 0=Open Listings, 1=Semi-Exclusive Listings, 2=Exculsive Listings, 6=Co-Broke
hasListings boolean optional (default: false)
If set to TRUE, only reutrns buildings with listings
extras string optional (default: "")
Provide special limitation (featured / developments)

buildingsDetails GET /buildings/{id}

Returns specific building

Request
Method URL
GET api.realtymx.com/buildings/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

buildingsPhotos GET /buildings/photos/{id}

Returns specific building's photos

Request
Method URL
GET api.realtymx.com/buildings/photos/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required
Provide id of the building

clientsInsert POST /clients

Inserts new client into the database

Request
Method URL
POST api.realtymx.com/clients
Parameters
Parameter Name Data Type Values
apiKey string required
firstname string required (default: "")
Provide user's first name
lastname string required (default: "")
Provide user's last name
email string required (default: "")
Provide user's email address
password string required (default: "")
Provide user's password

clientsDetails GET /clients/{id}

Returns specific client record

Request
Method URL
GET api.realtymx.com/clients/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

clientsListFavorite POST /clients/ListFavoriteListingID/

Retrive favorite listing based on ID

Request
Method URL
POST api.realtymx.com/clients/ListFavoriteListingID/
Parameters
Parameter Name Data Type Values
apiKey string required
clientID numeric required
client id number to insert client trail

clientsUpdate POST /clients/Update

Inserts new client into the database

Request
Method URL
POST api.realtymx.com/clients/Update
Parameters
Parameter Name Data Type Values
apiKey string required
clientID numeric required
client id number to insert client trail
firstname string optional (default: "")
Provide user's first name
lastname string optional (default: "")
Provide user's last name
email string optional (default: "")
Provide user's email address
phone string optional (default: "")
Provide user's phone number
password string optional (default: "")
Provide user's password

clientsfavorite POST /clients/favoriteListing/

favorite listing

Request
Method URL
POST api.realtymx.com/clients/favoriteListing/
Parameters
Parameter Name Data Type Values
apiKey string required
clientID numeric required
client id number to insert client trail
listingID numeric required
listing id number to favorite or unfavorite
isFavorite boolean optional (default: true)
true as favorite/ false as unfavorite
isRLS boolean optional (default: false)
indicates the listing is RLS or NOT
isMLS boolean optional (default: false)
indicates the listing is MLS or NOT

clientsclientTrail POST /clients/insertClientTrail/

Insert client trail records to specific clients

Request
Method URL
POST api.realtymx.com/clients/insertClientTrail/
Parameters
Parameter Name Data Type Values
apiKey string required
clientID numeric required
client id number to insert client trail
trailKey numeric required (default: "")
trail key for the action 1:Logged In Account; 2:Logged Out Account; 5:Viewed Property; 6:Saved Property; 7:Removed Property; 12:Property Search; 9:Password Renew; 10:Comment Added; 11:Comment Removed; 13:Timed Out
userIP string optional
client ip address, required for trailKey = 1, action Logged in Account
listingID numeric optional (default: 0)
listing id, required for trailKey = 5, action Viewed Property
comment string optional (default: "")
client comment
pageURL string optional (default: "")
visited query string

clientsList GET /clients/list

Returns list of clients who are registered as member from front-end my account

Request
Method URL
GET api.realtymx.com/clients/list
Parameters
Parameter Name Data Type Values
apiKey string required
order string optional (default: desc)
Provide sorting order (desc / asc)
limit numeric optional (default: 20)
Provide number of properties per page (10 / 20 / 40)
page numeric optional (default: 1)
Provide page number (1 or higher)
id numeric optional (default: 0)
Provide client id
email string optional (default: "")
Provide client email
verified boolean optional
True to bring verified users. False to bring unverified users
includeDealInfo boolean optional (default: false)
True to bring deal infomration assocaited with this client

docsSearch GET /docs/search

Returns list of doc records

Request
Method URL
GET api.realtymx.com/docs/search
Parameters
Parameter Name Data Type Values
apiKey string required
order string optional (default: desc)
Provide sorting order (desc / asc)
limit numeric optional (default: 40)
Provide number of docs per page (10 / 20 / 40)
page numeric optional (default: 1)
Provide page number (1 or higher)
id numeric optional (default: 0)
Provide lsit of doc ids

labelsList GET /labels

Returns list of all offices

Request
Method URL
GET api.realtymx.com/labels
Parameters
Parameter Name Data Type Values
apiKey string required

labelsDetails GET /labels/{id}

Returns specific labels

Request
Method URL
GET api.realtymx.com/labels/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

linksList GET /links

linksCategory GET /links/{category}

Returns list of all links within a category

Request
Method URL
GET api.realtymx.com/links/{category}
Parameters
Parameter Name Data Type Values
apiKey string required
category numeric required
Provide category id

linksCategories GET /links/categories

Returns list of all link categories

Request
Method URL
GET api.realtymx.com/links/categories
Parameters
Parameter Name Data Type Values
apiKey string required

neighborhoodsList GET /neighborhoods

Returns list of all neighborhoods

Request
Method URL
GET api.realtymx.com/neighborhoods
Parameters
Parameter Name Data Type Values
apiKey string required

neighborhoodsDetails GET /neighborhoods/{id}

Returns specific neighborhood

Request
Method URL
GET api.realtymx.com/neighborhoods/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

officesList GET /offices

Returns list of all offices

Request
Method URL
GET api.realtymx.com/offices
Parameters
Parameter Name Data Type Values
apiKey string required

officesDetails GET /offices/{id}

Returns specific office

Request
Method URL
GET api.realtymx.com/offices/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

pressDetails GET /press/{id}

Returns specific press article

Request
Method URL
GET api.realtymx.com/press/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

pressSearch GET /press/search/{count}

Returns list of press article

Request
Method URL
GET api.realtymx.com/press/search/{count}
Parameters
Parameter Name Data Type Values
count numeric required
Provide number of articles to show
keyword string optional
Provide a keyword to search for within a title or subtitle.
month_year string optional
Provide month and year combination from which to extract articles. (4-2014)
agent_id string optional (default: "")
Provide list of agent_id

propertiesSearch GET /properties

Returns list of listings

Request
Method URL
GET api.realtymx.com/properties
Parameters
Parameter Name Data Type Values
apiKey string required
sort string optional (default: price)
Provide sorting factor (price / size / date)
order string optional (default: desc)
Provide sorting order (desc / asc)
page numeric optional (default: 1)
Provide page number (1 or higher)
perPage numeric optional (default: 10)
Provide number of properties per page (10 / 20 / 40 /100). Maximum 200 listings per page
id numeric optional (default: 0)
Provide listing id # to filter.
status string optional (default: 2)
Provide specific status id(s) [Accept comma sepeated values] (Sales - 1, Rentals - 2, In Contract - 11, Offer In - 12, App. Pending - 21, Sold - 19, Rented - 22)
cat string optional (default: "")
Provide specific neighborhood id(s) [Accept comma sepeated values]
amenities string optional (default: "")
Provide amenities limitation [Accept comma sepeated values] (doorman / outdoorSpace / elevator / healthClub / pets / newConstruction / nofee/ dishwasher / hardwood / LaundryInUnit /Patio / roofdeck / privatedeck /garage)
priceMin numeric optional (default: 0)
Provide minimum price
priceMax numeric optional (default: 0)
Provide maximum price
bedsMin numeric optional (default: 0)
Provide minimum bedroom count
bedsMax numeric optional (default: 0)
Provide maximum bedroom count
bathMin numeric optional (default: 0)
Provide minimum bathroom count
bathMax numeric optional (default: 0)
Provide maximum bathroom count
roomsMin numeric optional (default: 0)
Provide minimum room count
roomsMax numeric optional (default: 0)
Provide maximum room count
familiesMin numeric optional (default: 0)
Provide minimum families count
familiesMax numeric optional (default: 0)
Provide maximum families count
MinLeaseTerm numeric optional (default: 0)
Provide minimum lease terms (in months)
MaxLeaseTerm numeric optional (default: 0)
Provide maximum lease terms (in months)
yearBuiltMin numeric optional (default: 0)
Provide minimum year built lookup
yearBuiltMax numeric optional (default: 0)
Provide maximum year built lookup
taxesMin numeric optional (default: 0)
Provide minimum taxwas
taxesMax numeric optional (default: 0)
Provide maximum taxes
pets string optional (default: "")
Provide specfic pets value(s) [Accept comma sepeated values] Options: No pets=99, Cats Only=1, Dogs Only = 4, Small Pets=2, Pets OK=3, Case by Case=98
minSize numeric optional (default: 0)
Provide minimum SQFT size
type string optional (default: "")
Provide specfic building type value(s) [Accept comma sepeated values] Options: Apartment,House,Townhouse,Condo,Coop,Condop,Building,Commercial,Office,Retail,Investment,Development,Land,N/A
apartmentFeatures string optional (default: "")
Provide apartment feaure options to search specific listings. Options: Furnished, Renovated, Dishwasher, Laundry In Unit, Private Outdoor Space,Open House, Fireplace, Lake View, River View
buildingFeatures string optional (default: "")
Provide building feaure options to search specific listings. Options: Doorman, Elevator, Laundry, Pool, Pets, Common Outdoor Space, Driveway
zipcode numeric optional (default: 0)
Provide zipcode to search listings
address string optional (default: "")
Provide listing address to search
city string optional (default: "")
Provide listing city to search
availableDate string optional (default: "")
Provide listing available date. Format mm/dd/yyyy
cooling string optional (default: "")
Provide specific cooling value(s) [Accept comma sepeated values] 1=Central AC, 2=Window/Wall, 3=None
parking string optional (default: "")
Provide specific parking value(s) [Accept comma sepeated values] 1=Indoor, 2=Outdoor, 3=Heated, 4=Valet, 5=Street No Permit, 6=Easy Street No Permit, 7=Street with Permit, 8=Assigned Parking
agent numeric optional (default: 0)
Provide specific agent id to search listings by the agent id
buildingId numeric optional (default: 0)
Provide specific building id #
category string optional (default: "")
Provide specific category value(s) [Accept comma sepeated values] 0=Open Listings, 1=Semi-Exclusive Listings, 2=Exculsive Listings, 6=Co-Broke
shortTerm boolean optional (default: 0)
Boolean value either to filter short term listings
label string optional (default: "")
Provide label name to search listings associated with the label
addDescription boolean optional (default: false)
Boolean value either to include description to serach result
extras string optional (default: "")
Provide special limitation (featured / furnished / developments / nofee / openhouse)
addPhotos boolean optional (default: false)
Boolean value to include listings photos to search result
addOpenHouse boolean optional (default: false)
Boolean value to include open listings to search result
addHitCounter boolean optional (default: false)
Boolean value to include web site views counter to search result
addCustomValues boolean optional (default: false)
Boolean value to include custom field to search result
customValue string optional (default: "")
Provide specific custom value to filter the result
addLabels boolean optional (default: false)
Boolean value to include labels name associated with listings to search result
distribute boolean optional (default: false)
Boolean value to filter website listings only
updatedSince string optional (default: "")
Confine results to listings which have benn updated since this time. Format MM/DD/YYYYTHH:MM

propertiesDetails GET /properties/{id}

Returns specific listing

Request
Method URL
GET api.realtymx.com/properties/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required
isMLS boolean optional (default: false)
addPhotos boolean optional (default: false)
Boolean value either to include all listings photo or not
addOpenHouse boolean optional (default: false)
Boolean value either to include all listings openhouse or not
addHitCounter boolean optional (default: false)
Boolean value either to include web site views counter
addCustomValues boolean optional (default: false)
Boolean value either to include web site views counter
addLabels boolean optional (default: false)
Boolean value to include labels

propertiesAmenities GET /properties/amenities/{id}

Returns specific listing's amenities

Request
Method URL
GET api.realtymx.com/properties/amenities/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required
Provide id of the property
isMLS boolean optional (default: false)

propertiesPhotos GET /properties/photos/{id}

Returns specific listing's photos

Request
Method URL
GET api.realtymx.com/properties/photos/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required
Provide id of the property
isMLS boolean optional (default: false)

propertiesRandom GET /properties/random/{count}

Returns random list of listings

Request
Method URL
GET api.realtymx.com/properties/random/{count}
Parameters
Parameter Name Data Type Values
apiKey string required
count numeric required
Provide number of properties to show
status string optional (default: 2)
Provide specific status id(s) [CSV] (Sales - 1, Rentals - 2, In Contract - 11, Offer In - 12, App. Pending - 21, Sold - 19, Rented - 22)
cat string optional (default: "")
Provide specific neighborhood id(s) [CSV]
priceMin numeric optional (default: 0)
Provide minimum price
priceMax numeric optional (default: 100000000)
Provide maximum price
bedsMin numeric optional (default: 0)
Provide minimum bedroom count
bedsMax numeric optional (default: 10)
Provide maximum bedroom count
agent numeric optional (default: 0)
Provide specific agent id
extras string optional (default: "")
Provide special limitation (featured / furnished / developments / nofee / openhouse)

propertiesviewCounter POST /properties/viewCounter/

Update View Counter for specific listing

Request
Method URL
POST api.realtymx.com/properties/viewCounter/
Parameters
Parameter Name Data Type Values
apiKey string required
listingID numeric required
listing id

teamsList GET /teams

Returns list of all teams

Request
Method URL
GET api.realtymx.com/teams
Parameters
Parameter Name Data Type Values
apiKey string required

teamsDetails GET /teams/{id}

Returns specific team

Request
Method URL
GET api.realtymx.com/teams/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

teamsTestimonials GET /teams/testimonials/{id}

Returns specific agent's testimonials

Request
Method URL
GET api.realtymx.com/teams/testimonials/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

videosDetails GET /videos/{id}

Returns specific video

Request
Method URL
GET api.realtymx.com/videos/{id}
Parameters
Parameter Name Data Type Values
apiKey string required
id numeric required

videosSearch GET /videos/search/{count}

Returns list of videos

Request
Method URL
GET api.realtymx.com/videos/search/{count}
Parameters
Parameter Name Data Type Values
count numeric required
Provide number of vidoes to show
keyword string optional
Provide a keyword to search for within a title
month_year string optional
Provide month and year combination from which to extract videos (4-2014)

vtourInsert POST /vtour

Inserts new client into the database

Request
Method URL
POST api.realtymx.com/vtour
Parameters
Parameter Name Data Type Values
apiKey string required
vtourURL string optional (default: "")
Provide virtual tour URL
vtourURL2 string optional (default: "")
Provide second virtual tour URL
listingID string required (default: "")
Provide RealtyMX listing id #

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.