API Dashboard

Taffy 3.1.0

Resources:

vtourInsert DELETE PATCH PUT POST GET /vtour

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Inserts new client into the database
post
required string apiKey
optional string vtourURL (default: "")
Provide virtual tour URL
optional string vtourURL2 (default: "")
Provide second virtual tour URL
required string listingID (default: "")
Provide RealtyMX listing id #

videosSearch DELETE PATCH PUT POST GET /videos/search/{count}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns list of videos
get
required numeric count
Provide number of vidoes to show
optional string keyword
Provide a keyword to search for within a title
optional string month_year
Provide month and year combination from which to extract videos (4-2014)

videosDetails DELETE PATCH PUT POST GET /videos/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific video
get
required string apiKey
required numeric id

teamsTestimonials DELETE PATCH PUT POST GET /teams/testimonials/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific agent's testimonials
get
required string apiKey
required numeric id

teamsDetails DELETE PATCH PUT POST GET /teams/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific team
get
required string apiKey
required numeric id

teamsList DELETE PATCH PUT POST GET /teams

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all teams
get
required string apiKey

propertiesviewCounter DELETE PATCH PUT POST GET /properties/viewCounter/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Update View Counter for specific listing
post
required string apiKey
required numeric listingID
listing id

propertiesRandom DELETE PATCH PUT POST GET /properties/random/{count}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns random list of listings
get
required string apiKey
required numeric count
Provide number of properties to show
optional string status (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)
optional string cat (default: "")
Provide specific neighborhood id(s) [CSV]
optional numeric priceMin (default: 0)
Provide minimum price
optional numeric priceMax (default: 100000000)
Provide maximum price
optional numeric bedsMin (default: 0)
Provide minimum bedroom count
optional numeric bedsMax (default: 10)
Provide maximum bedroom count
optional numeric agent (default: 0)
Provide specific agent id
optional string extras (default: "")
Provide special limitation (featured / furnished / developments / nofee / openhouse)

propertiesPhotos DELETE PATCH PUT POST GET /properties/photos/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific listing's photos
get
required string apiKey
required numeric id
Provide id of the property
optional boolean isMLS (default: false)

propertiesAmenities DELETE PATCH PUT POST GET /properties/amenities/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific listing's amenities
get
required string apiKey
required numeric id
Provide id of the property
optional boolean isMLS (default: false)

propertiesDetails DELETE PATCH PUT POST GET /properties/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific listing
get
required string apiKey
required numeric id
optional boolean isMLS (default: false)
optional boolean addPhotos (default: false)
Boolean value either to include all listings photo or not
optional boolean addOpenHouse (default: false)
Boolean value either to include all listings openhouse or not
optional boolean addHitCounter (default: false)
Boolean value either to include web site views counter
optional boolean addCustomValues (default: false)
Boolean value either to include web site views counter
optional boolean addLabels (default: false)
Boolean value to include labels

propertiesSearch DELETE PATCH PUT POST GET /properties

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of listings
get
required string apiKey
optional string sort (default: price)
Provide sorting factor (price / size / date)
optional string order (default: desc)
Provide sorting order (desc / asc)
optional numeric page (default: 1)
Provide page number (1 or higher)
optional numeric perPage (default: 10)
Provide number of properties per page (10 / 20 / 40 /100). Maximum 200 listings per page
optional numeric id (default: 0)
Provide listing id # to filter.
optional string status (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)
optional string cat (default: "")
Provide specific neighborhood id(s) [Accept comma sepeated values]
optional string amenities (default: "")
Provide amenities limitation [Accept comma sepeated values] (doorman / outdoorSpace / elevator / healthClub / pets / newConstruction / nofee/ dishwasher / hardwood / LaundryInUnit /Patio / roofdeck / privatedeck /garage)
optional numeric priceMin (default: 0)
Provide minimum price
optional numeric priceMax (default: 0)
Provide maximum price
optional numeric bedsMin (default: 0)
Provide minimum bedroom count
optional numeric bedsMax (default: 0)
Provide maximum bedroom count
optional numeric bathMin (default: 0)
Provide minimum bathroom count
optional numeric bathMax (default: 0)
Provide maximum bathroom count
optional numeric roomsMin (default: 0)
Provide minimum room count
optional numeric roomsMax (default: 0)
Provide maximum room count
optional numeric familiesMin (default: 0)
Provide minimum families count
optional numeric familiesMax (default: 0)
Provide maximum families count
optional numeric MinLeaseTerm (default: 0)
Provide minimum lease terms (in months)
optional numeric MaxLeaseTerm (default: 0)
Provide maximum lease terms (in months)
optional numeric yearBuiltMin (default: 0)
Provide minimum year built lookup
optional numeric yearBuiltMax (default: 0)
Provide maximum year built lookup
optional numeric taxesMin (default: 0)
Provide minimum taxwas
optional numeric taxesMax (default: 0)
Provide maximum taxes
optional string pets (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
optional numeric minSize (default: 0)
Provide minimum SQFT size
optional string type (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
optional string apartmentFeatures (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
optional string buildingFeatures (default: "")
Provide building feaure options to search specific listings. Options: Doorman, Elevator, Laundry, Pool, Pets, Common Outdoor Space, Driveway
optional numeric zipcode (default: 0)
Provide zipcode to search listings
optional string address (default: "")
Provide listing address to search
optional string city (default: "")
Provide listing city to search
optional string availableDate (default: "")
Provide listing available date. Format mm/dd/yyyy
optional string cooling (default: "")
Provide specific cooling value(s) [Accept comma sepeated values] 1=Central AC, 2=Window/Wall, 3=None
optional string parking (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
optional numeric agent (default: 0)
Provide specific agent id to search listings by the agent id
optional numeric buildingId (default: 0)
Provide specific building id #
optional string category (default: "")
Provide specific category value(s) [Accept comma sepeated values] 0=Open Listings, 1=Semi-Exclusive Listings, 2=Exculsive Listings, 6=Co-Broke
optional boolean shortTerm (default: 0)
Boolean value either to filter short term listings
optional string label (default: "")
Provide label name to search listings associated with the label
optional boolean addDescription (default: false)
Boolean value either to include description to serach result
optional string extras (default: "")
Provide special limitation (featured / furnished / developments / nofee / openhouse)
optional boolean addPhotos (default: false)
Boolean value to include listings photos to search result
optional boolean addOpenHouse (default: false)
Boolean value to include open listings to search result
optional boolean addHitCounter (default: false)
Boolean value to include web site views counter to search result
optional boolean addCustomValues (default: false)
Boolean value to include custom field to search result
optional string customValue (default: "")
Provide specific custom value to filter the result
optional boolean addLabels (default: false)
Boolean value to include labels name associated with listings to search result
optional boolean distribute (default: false)
Boolean value to filter website listings only
optional string updatedSince (default: "")
Confine results to listings which have benn updated since this time. Format MM/DD/YYYYTHH:MM

pressSearch DELETE PATCH PUT POST GET /press/search/{count}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns list of press article
get
required numeric count
Provide number of articles to show
optional string keyword
Provide a keyword to search for within a title or subtitle.
optional string month_year
Provide month and year combination from which to extract articles. (4-2014)
optional string agent_id (default: "")
Provide list of agent_id

pressDetails DELETE PATCH PUT POST GET /press/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific press article
get
required string apiKey
required numeric id

officesDetails DELETE PATCH PUT POST GET /offices/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific office
get
required string apiKey
required numeric id

officesList DELETE PATCH PUT POST GET /offices

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all offices
get
required string apiKey

neighborhoodsDetails DELETE PATCH PUT POST GET /neighborhoods/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific neighborhood
get
required string apiKey
required numeric id

neighborhoodsList DELETE PATCH PUT POST GET /neighborhoods

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all neighborhoods
get
required string apiKey

linksCategories DELETE PATCH PUT POST GET /links/categories

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all link categories
get
required string apiKey

linksCategory DELETE PATCH PUT POST GET /links/{category}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns list of all links within a category
get
required string apiKey
required numeric category
Provide category id

linksList DELETE PATCH PUT POST GET /links

labelsDetails DELETE PATCH PUT POST GET /labels/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific labels
get
required string apiKey
required numeric id

labelsList DELETE PATCH PUT POST GET /labels

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all offices
get
required string apiKey

docsSearch DELETE PATCH PUT POST GET /docs/search

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of doc records
get
required string apiKey
optional string order (default: desc)
Provide sorting order (desc / asc)
optional numeric limit (default: 40)
Provide number of docs per page (10 / 20 / 40)
optional numeric page (default: 1)
Provide page number (1 or higher)
optional numeric id (default: 0)
Provide lsit of doc ids

clientsList DELETE PATCH PUT POST GET /clients/list

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of clients who are registered as member from front-end my account
get
required string apiKey
optional string order (default: desc)
Provide sorting order (desc / asc)
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 numeric id (default: 0)
Provide client id
optional string email (default: "")
Provide client email
optional boolean verified
True to bring verified users. False to bring unverified users
optional boolean includeDealInfo (default: false)
True to bring deal infomration assocaited with this client

clientsclientTrail DELETE PATCH PUT POST GET /clients/insertClientTrail/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Insert client trail records to specific clients
post
required string apiKey
required numeric clientID
client id number to insert client trail
required numeric trailKey (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
optional string userIP
client ip address, required for trailKey = 1, action Logged in Account
optional numeric listingID (default: 0)
listing id, required for trailKey = 5, action Viewed Property
optional string comment (default: "")
client comment
optional string pageURL (default: "")
visited query string

clientsfavorite DELETE PATCH PUT POST GET /clients/favoriteListing/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

favorite listing
post
required string apiKey
required numeric clientID
client id number to insert client trail
required numeric listingID
listing id number to favorite or unfavorite
optional boolean isFavorite (default: true)
true as favorite/ false as unfavorite
optional boolean isRLS (default: false)
indicates the listing is RLS or NOT
optional boolean isMLS (default: false)
indicates the listing is MLS or NOT

clientsUpdate DELETE PATCH PUT POST GET /clients/Update

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Inserts new client into the database
post
required string apiKey
required numeric clientID
client id number to insert client trail
optional string firstname (default: "")
Provide user's first name
optional string lastname (default: "")
Provide user's last name
optional string email (default: "")
Provide user's email address
optional string phone (default: "")
Provide user's phone number
optional string password (default: "")
Provide user's password

clientsListFavorite DELETE PATCH PUT POST GET /clients/ListFavoriteListingID/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Retrive favorite listing based on ID
post
required string apiKey
required numeric clientID
client id number to insert client trail

clientsDetails DELETE PATCH PUT POST GET /clients/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific client record
get
required string apiKey
required numeric id

clientsInsert DELETE PATCH PUT POST GET /clients

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Inserts new client into the database
post
required string apiKey
required string firstname (default: "")
Provide user's first name
required string lastname (default: "")
Provide user's last name
required string email (default: "")
Provide user's email address
required string password (default: "")
Provide user's password

buildingsPhotos DELETE PATCH PUT POST GET /buildings/photos/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific building's photos
get
required string apiKey
required numeric id
Provide id of the building

buildingsDetails DELETE PATCH PUT POST GET /buildings/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific building
get
required string apiKey
required numeric id

buildingsSearch DELETE PATCH PUT POST GET /buildings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

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

blogsLabels DELETE PATCH PUT POST GET /blogs/labels

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of all blog labels
get
required string apiKey

blogsDetails DELETE PATCH PUT POST GET /blogs/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific blog
get
required string apiKey
required numeric id

blogsSearch DELETE PATCH PUT POST GET /blog/search/{count}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns list of blog articles
get
required string apiKey
required numeric count
Provide number of articles to show
optional numeric label (default: 0)
Provide a keyword to search for within a title or subtitle.
optional string month_year (default: "")
Provide month and year combination from which to extract articles. (4-2014)

aprilwebhook DELETE PATCH PUT POST GET /april

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Update April Vidoe id
post
required string apiKey
required string videoId (default: "")
Provide video ID
optional string ulid (default: "")
Provide unique listing ID

alertslistingAlert DELETE PATCH PUT POST GET /alerts/listingAlert

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Inserts new alert with specific listing
post
required string apiKey
required numeric listingID (default: "")
Provide specific listing id that user contacting to
required string firstname (default: "")
Provide client first name
required string lastname (default: "")
Provide client last name
required string email (default: "")
Provide client email address
optional string phone (default: "")
Provide client phone number
optional string comment (default: "")
Provide client comment
optional boolean isRLS (default: false)
indicates the listing is RLS or NOT
optional boolean isMLS (default: false)
indicates the listing is MLS or NOT
optional numeric agentID (default: -1)
Provide specific agent id
optional numeric clientID (default: -1)
Provide specific client id

alertsInsert DELETE PATCH PUT POST GET /alerts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Inserts new leads (we call alerts) into the database
post
required string apiKey
Your API Key
required string firstname (default: "")
Provide client first name
required string lastname (default: "")
Provide client last name
required string email (default: "")
Provide client email address
optional string phone (default: "")
Provide client phone number
optional string comment (default: "")
Provide client comment
optional numeric price (default: 0)
Provide alert price. Based on this price argument, API will automatically calculate alert price range with +-10%
optional string alertType (default: For Rent)
Provide specific alert type. For Sale or For Rent
optional numeric minBeds (default: 0)
Provide minimum bedroom value which the alert search is looking for
optional numeric minBath (default: 0)
Provide minimum bathroom value which the alert search is looking for
optional string alertAddress (default: "")
Provide specific address which areas alert search look for.
optional string alertSource (default: "")
Provide source name where this alert is originated.
optional string agentEmail (default: "")
Provide a specific agent email address who will be assigned to newly created alert.
optional numeric listingID (default: 0)
Provide specific listing id that user contact to, if this is provided, it will override price, listingType, areas argument.

agentsVideos DELETE PATCH PUT POST GET /agents/videos/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific agent's videos
get
required string apiKey
required numeric id

agentsTestimonialsSearch DELETE PATCH PUT POST GET /agents/testimonialsSearch

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of testimonials
get
required string apiKey
optional string order (default: asc)
Provide sorting order (desc / asc)
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)

agentsTestimonials DELETE PATCH PUT POST GET /agents/testimonials/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific agent's testimonials
get
required string apiKey
required numeric id

agentsSearch DELETE PATCH PUT POST GET /agents/search

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of agents
get
required string apiKey
optional string sort (default: last)
Provide sorting factor (first / last / office / date)
optional string order (default: asc)
Provide sorting order (desc / asc)
optional string includeSuspend (default: false)
Include Agents with Suspend status
optional string name (default: "")
Provide agent's first or last name
optional string language (default: "")
Provide a language an agent speaks
optional numeric office (default: 0)
Provide agent's office id
optional string team (default: "")
Provide team id or list of tema ids separated by commas

agentsBlogs DELETE PATCH PUT POST GET /agents/blog/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific agent's blogs
get
required string apiKey
required numeric id

agentsDetails DELETE PATCH PUT POST GET /agents/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Returns specific agent
get
required string apiKey
required numeric id
optional string includeSuspend (default: false)
Include Agents with Suspend status

accountVerifyAccount DELETE PATCH PUT POST GET /account/verifyAccount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Verifys user account with verify code
get
required string apiKey
required string email (default: "")
required string verifyCode (default: "")

accountVerifyStatus DELETE PATCH PUT POST GET /account/getVerifiedStatus

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns specific client record
get
required string apiKey
required string email (default: "")
required string password (default: "")

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