API Dashboard

Taffy 3.1.0

Resources:

tenants DELETE PATCH PUT POST GET /tenants

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns a tenant's (client's) representation registration status: whether an agreement is signed, the signing agent, the sign date, a derived expiration, cell phone and any declared co-signer, plus the optional search criteria captured at registration (apartment size, price range, preferred neighborhoods, pets, move-by date, reason for moving, whether they are sharing). Look a tenant up by email or id, or list a whole book of business by agent_id or agent_email (optionally narrowed to registrations only with has_agreement=1). Lease history is at /leases
get
required string apiKey (default: "")
API KEY
optional string email (default: "")
Email address of the tenant, or a comma-delimited list of email addresses. Required unless id or agent_id is provided. Note that one email can match several contact records, which are returned separately.
optional string id (default: "")
ID number of an individual tenant (contact), or a comma-delimited list of ID numbers. Required unless email or agent_id is provided.
optional string agent_id (default: "")
Agent ID, or a comma-delimited list, matched against the agent currently assigned to the tenant. Required unless email, id or agent_email is provided. Returns every client of that agent, so pair it with has_agreement=1 to get only those who completed a registration. This is the current assignment on the contact record, not necessarily the agent present at signing; see the specification.
optional string agent_email (default: "")
Agent email address, or a comma-delimited list, matched against the agent currently assigned to the tenant. Required unless email, id or agent_id is provided. Matching is case-insensitive. One address can belong to several agent records, in which case the clients of all of them are returned - usually what you want, since the duplicates are the same person. Supplying agent_id as well narrows to agents matching both.
optional string has_agreement (default: "")
Confine results by registration status (1 = a signed representation agreement is on file, 0 = none). Leave empty for both. Requires a database holding clientData.
optional string signed_since (default: "")
Confine results to agreements signed on or after this time, compared against REPRESENTATION.SIGNED_DATE. Format mm/dd/yyyyThh:nn. Requires a database holding clientData.
optional numeric limit (default: 20)
Provide number of tenants per page (max 100)
optional numeric page (default: 1)
Provide page number (1 or higher)
optional numeric agreement_term_days (default: 120)
Term length in days used to derive REPRESENTATION.EXPIRATION_DATE from the signing date. No expiration is stored in the database, so the returned date is always flagged EXPIRATION_IS_DERIVED and is an approximation.

neighborhoods DELETE PATCH PUT POST GET /neighborhoods

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of neighborhoods
get
required string apiKey (default: "")
API KEY
optional string neighborhood_id (default: "")
ID number of an indivisual neighborhood id, or a comma-delimited list of ID numbers

listingsHistory DELETE PATCH PUT POST GET /listingsHistory

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of listingsHistory
get
required string apiKey (default: "")
API KEY
required string listing_id (default: "")
ID number of an individual listing or a comma-delimited list of ID numbers.
optional numeric limit (default: 20)
Number of listings per result (5 / 10 / 20). Up to 100 listings per result
optional numeric page (default: 1)
Page number (1 or higher)
optional string update_type (default: "")
Status for status change or Price for price change
optional string updated_since (default: "")
Confine results to listing history which have benn updated since this time. Format MM/DD/YYYYTHH:MM, updated_since parameter only applies when update_type parameter is specified.
optional string status_type (default: "")
Filter status change logs based on new listing status type or price change log based on the current listing status

listingsUpdate DELETE PATCH PUT POST GET /listings/{listing_id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Updates the essential fields on a single listing: price, status and availability date, plus the closing fields for a sale or rental marked Sold or Rented. Updates are partial - only the fields present in the request body are changed and everything omitted is left as it is. PATCH is the documented verb; PUT is accepted as an alias and behaves identically (it does not clear omitted fields). Requires HTTP Basic authentication - Authorization: Basic base64(api_key:secret_key) - in addition to the API key. The endpoint reproduces what the RealtyMX web app does on save: price and status history, the days-on-market lifecycle, and closing-field auto-fill, so an API change is indistinguishable from an agent's and is returned by /listingsHistory
put
Alias of PATCH, provided for clients whose tooling cannot send PATCH. Behaves identically: omitted fields are left untouched, not cleared. See PATCH for the full parameter list.
patch
Updates price, status and/or availability on one listing.
required string apiKey (default: "")
API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.
required string listing_id (default: "")
ID number of the listing to update. Taken from the URL path.
optional any price
New asking price. Numeric and greater than zero. Optional, but at least one of price, status or date_available must be supplied.
optional any status
New listing status. One of 1 (For Sale), 2 (For Rent), 11 (In Contract), 12 (Offer In), 21 (App. Pending), 19 (Sold), 22 (Rented), 0 (Suspend), or the negative of any of these for the off-market equivalent. Optional, but at least one of price, status or date_available must be supplied.
optional any date_available
New availability date as YYYY-MM-DD. ISO dates only - any other text is rejected. Optional, but at least one of price, status or date_available must be supplied.
optional any closingDate
Closing date as YYYY-MM-DD. Applies when status is 19 (Sold) or 22 (Rented); ignored otherwise. If omitted when closing a listing, it defaults to today, as the web app does.
optional any closingPrice
Closing price in whole currency units - the column is an integer and cannot hold cents. Applies when status is 19 (Sold) or 22 (Rented); ignored otherwise. If omitted when closing a listing, it defaults to the listing's current price, as the web app does.
optional any agent_id
ID of the agent the change is attributed to. Must exist in the client database. If omitted the change is recorded against the system account and shows no author in the listing history.
optional any size
Interior size in square feet. Whole number, zero or greater.
optional any beds
Bedroom count. Zero or greater; fractions allowed.
optional any bath
Bathroom count. Zero or greater; fractions allowed, so 1.5 is valid.
optional any rooms
Total room count. Zero or greater; fractions allowed. A value below the bedroom count is applied but returns a warning.
optional any remark
Short remark about the space, shown beside the room counts - for example '1 Bedroom' or 'Loft Style Studio'. Up to 50 characters. Send an empty string to clear it. Appears in the listing history as Space Type.
optional any net_effective_rent
Whether the price is quoted as net effective rent. true/false or 1/0. Setting this on requires months_free and min_lease_required to both be greater than zero, either in this request or already on the listing.
optional any months_free
Number of free months offered. Numeric, zero or greater; fractions allowed.
optional any min_lease_required
Minimum lease length in months required to qualify for the free months. Numeric, zero or greater.
optional any owner_pays_amount
OP (Owner Pays) amount. Numeric, zero or greater. Interpreted according to owner_pays_type.
optional any owner_pays_type
Unit for owner_pays_amount: 0 (N/A), 1 (Months), 4 (Weeks), 2 (Percent), 3 (Dollars).
optional any lease_term_min
Minimum lease term in months. Whole number, zero or greater; zero clears the value rather than storing 0, matching the web app.
optional any lease_term_max
Maximum lease term in months. Whole number, zero or greater; zero clears the value rather than storing 0. Must not be lower than lease_term_min.
optional any concessions
Free-text concessions description shown with the listing. Send an empty string to clear it.
optional any cyof
Collect Your Own Fee. true/false or 1/0.
optional any rent_type
Lease type: 0 (N/A), 1 (Stabilized), 2 (Controlled), 3 (Decontrolled), 4 (Preferential).

listings DELETE PATCH PUT POST GET /listings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of listings
post
Creates a listing. Requires HTTP Basic authentication - Authorization: Basic base64(api_key:secret_key) - in addition to the API key. Supply either building_id or the address fields (house, address, zip, city, state); the address is normalised and matched against existing buildings, so any common spelling finds the same building. The status is stored exactly as requested - the web app's new-listing approval audit is deliberately not applied. Returns 201 with the new listing id, the building it was attached to, and any warnings.
required string apiKey (default: "")
API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.
required any status (default: "")
Listing status: 1 (For Sale), 2 (For Rent), 11 (In Contract), 12 (Offer In), 21 (App. Pending), 19 (Sold), 22 (Rented), 0 (Suspend), or the negative of any of these for the off-market equivalent. Stored as supplied.
required any price (default: "")
Asking price. Numeric and greater than zero. A sales listing (status 1, 11, 12, 19) below 10,000 is rejected; a rental at 100,000 or more is accepted with a warning.
required any type (default: "")
Property type: Apartment, House, Townhouse, Condo, Coop, Condop, Building, Commercial, Office, Retail, Investment, Development, Land, Parking Spots, Mixed Use. When the listing is attached to an existing building the building's type is used and a differing value produces a warning.
required any agent_id (default: "")
ID of the listing's primary agent. Must be an active agent in the client database. Also recorded as the creator and as the author of the listing history entries.
optional any building_id
ID of an existing building to attach the listing to. Required unless house, address, zip, city and state are supplied. Cannot be combined with them.
optional any house
House number, up to 10 characters (Queens-style 43-12 accepted). Required unless building_id is supplied.
optional any address
Street name. Any common spelling is accepted (W 23rd St, West 23 Street, W23RD ST.) - it is normalised before matching existing buildings. Required unless building_id is supplied.
optional any zip
Zip code. Part of the building match. Required unless building_id is supplied.
optional any city
City, up to 20 characters. Required unless building_id is supplied.
optional any state
State, up to 3 characters. Required unless building_id is supplied.
optional any apt
Unit number, up to 10 characters; letters, digits, *, - and / only. Required when type is Apartment, Condo, Coop or Condop. A value starting with * bypasses the duplicate-listing check, as it does in the web app.
optional any neighborhood_id
Area (cats.cat_id, see /neighborhoods). Normally taken from the matched building; required only when that building carries no valid area. A supplied value that differs from the building's produces a warning.
optional any co_agent_id
ID of the co-agent. Must exist and differ from agent_id.
optional any category
0 (Open, default), 1 (Semi-Exclusive), 2 (Exclusive), 4 (Private), 6 (Co-Broke). An Exclusive listing requires a description.
optional any distribute
Distribution: 2 (External - website and marketplaces, default), -2 (Internal only), 0 (both), 1 (website only).
optional any description
Listing description. Subject to the client's description rules: phone numbers and/or email addresses may be removed, banned words removed and a disclaimer appended; the response reports any change. Required when category is 2.
optional any web_title
Web title, up to 100 characters. Banned words are removed.
optional any date_available
Availability: a date as YYYY-MM-DD, or one of Immediately, ASAP, NOW!.
optional any floor
Floor, up to 10 characters.
optional any size
Interior size in square feet. Whole number, zero or greater.
optional any beds
Bedroom count. Zero or greater; fractions allowed.
optional any bath
Bathroom count. Zero or greater; fractions allowed.
optional any rooms
Total room count. Zero or greater; fractions allowed. A value below the bedroom count returns a warning.
optional any remark
Short remark about the space, up to 50 characters - for example '1 Bedroom'.
optional any net_effective_rent
Whether the price is quoted as net effective rent. true/false. Requires months_free and min_lease_required greater than zero. Rentals only.
optional any months_free
Number of free months offered. Numeric, zero or greater. Rentals only.
optional any min_lease_required
Minimum lease length in months required for the free months. Numeric, zero or greater. Rentals only.
optional any owner_pays_amount
OP (Owner Pays) amount. Numeric, zero or greater. Rentals only.
optional any owner_pays_type
Unit for owner_pays_amount: 0 (N/A), 1 (Months), 4 (Weeks), 2 (Percent), 3 (Dollars). Rentals only.
optional any lease_term_min
Minimum lease term in months. Whole number; zero stores no value. Rentals only.
optional any lease_term_max
Maximum lease term in months. Whole number; zero stores no value; must not be lower than lease_term_min. Rentals only.
optional any concessions
Free-text concessions description. Rentals only.
optional any cyof
Collect Your Own Fee. true/false. Rentals only.
optional any rent_type
Lease type: 0 (N/A), 1 (Stabilized), 2 (Controlled), 3 (Decontrolled), 4 (Preferential). Rentals only.
optional any fee
Fee amount. Numeric, zero or greater; cannot exceed 100 when fee_type is percent.
optional any fee_type
Unit for fee: 0 (N/A), 1 (%), 2 ($), 3 (Month).
optional any cobroke_amount
Co-broke amount. Numeric, zero or greater; cannot exceed fee when both are percentages.
optional any cobroke_type
Unit for cobroke_amount: 0 (N/A), 1 (% office fee), 2 ($ office fee), 3 (Month office fee).
optional any pets
Pets policy: 0 (Unknown), 99 (No Pets), 1 (Cats Only), 4 (Dogs Only), 2 (Small Pets), 3 (Pets OK), 98 (Case By Case).
optional any hide_address
Hide the address on the website. true/false.
optional any furnished
Furnished. true/false.
optional any amenities
Array of amenity names, for example ["Doorman", "Roof Deck"]. Names are matched case-insensitively ignoring spaces. Amenities set on the building are applied automatically.
optional any expiration_date
Exclusive expiration date as YYYY-MM-DD. Exclusive listings only; must not be earlier than exclusive_start_date, and not in the past for an active status.
optional any exclusive_start_date
Exclusive start date as YYYY-MM-DD. Exclusive listings only; 1999-01-01 or later.
optional any closingDate
Closing date as YYYY-MM-DD. Applies when status is 19 (Sold) or 22 (Rented); defaults to today.
optional any closingPrice
Closing price in whole currency units. Applies when status is 19 or 22; defaults to price.
optional any access_info
Access notes / showing instructions.
optional any broker_note
Broker-to-broker note, up to 300 characters.
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

leases DELETE PATCH PUT POST GET /leases

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns a tenant's signed lease history by email address: sign/start/end dates, address, beds/baths, monthly rent, agents and co-signers. Executed rentals only (Approved or Paid); Draft, Cancelled and Pending are excluded. Representation status is at /tenants
get
required string apiKey (default: "")
API KEY
optional string email (default: "")
Email address of the tenant, or a comma-delimited list of email addresses. Required unless id is provided. Returns the tenant's full signed lease history, newest first.
optional string id (default: "")
Contact ID of the tenant, or a comma-delimited list of ID numbers. Required unless email is provided.
optional numeric limit (default: 20)
Provide number of leases per page (max 100)
optional numeric page (default: 1)
Provide page number (1 or higher)
optional string order (default: desc)
Sort order on lease sign date (desc / asc). Default desc, so the most recent signed lease is first.
optional string updated_since (default: "")
Confine results to leases signed on or after this time. Format mm/dd/yyyyThh:nn

leads DELETE PATCH PUT POST GET /leads

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns inbound leads and saved searches from the Alerts table, newest first: contact details, lead source, assigned agents, pipeline progress and the search criteria attached to the lead. Intended for CRM sync — poll with updated_since to pull only what changed. Note that this table holds both leads captured from listing sites and searches saved by hand, and no column reliably separates the two; see SOURCE, LISTING_ID and ALERT_NAME to classify.
get
required string apiKey (default: "")
API KEY
optional string id (default: "")
ID number of an individual lead, or a comma-delimited list of ID numbers.
optional string email (default: "")
Email address of the lead, or a comma-delimited list of email addresses. Note that email is not unique: the same address can appear on many unrelated leads, and is often an agent or placeholder address.
optional numeric limit (default: 20)
Provide number of leads per page (max 100)
optional numeric page (default: 1)
Provide page number (1 or higher)
optional string sort (default: date)
Provide sorting factor (date / updated / id). date sorts on DATE_CREATE, updated on DATE_UPDATE.
optional string order (default: desc)
Provide sorting order (desc / asc). Default desc, so the newest lead is first.
optional string updated_since (default: "")
Confine results to leads changed on or after this time, compared against DATE_UPDATE. Use this to sync incrementally. Format mm/dd/yyyyThh:nn
optional string created_since (default: "")
Confine results to leads created on or after this time, compared against DATE_CREATE. Format mm/dd/yyyyThh:nn
optional string source (default: "")
Source ID, or a comma-delimited list of source IDs, as returned in SOURCE.ID. These IDs are defined per client database and are not portable between clients.
optional string agent_id (default: "")
Assigned agent ID, or a comma-delimited list. Matches a lead if the agent is any one of its assigned agents. Use 0 to return unassigned leads.
optional string status (default: "")
Filter on the alert active flag (1 = active, 0 = inactive). This flag controls whether the saved search still emails the client; it is NOT the lead pipeline stage, which is PROGRESS. Most historic rows are 0, so leave this empty unless you specifically want active alerts.
optional string lead_type (default: "")
Filter on lead type (sale / rent). Leads whose stored type is neither are returned only when this filter is empty; see LEAD_TYPE.

docs DELETE PATCH PUT POST GET /docs

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Serves the API documentation page
get
Returns the API documentation page

deals DELETE PATCH PUT POST GET /deals

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of deals
get
required string apiKey (default: "")
API KEY
optional numeric limit (default: 100)
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 (id / date)
optional string order (default: desc)
Provide sorting order (desc / asc)
optional string id (default: "")
ID number of an individual deal ,or a comma-delimited list of ID numbers.
optional string updated_since (default: "")
Confine results to deals which have benn updated since this time. Format mm/dd/yyyyThh:nn

buildings DELETE PATCH PUT POST GET /buildings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Returns list of buildings
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 (id / date)
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 updated_since (default: "")
Confine results to buildings which have benn updated since this time. Format mm/dd/yyyyThh:nn
optional string type (default: "")
Building Type ()
optional string neighborhood_id (default: "")
ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers
optional string expand (default: "")
Comma-separated list of related data to include (listings,contacts)
optional string featured (default: "")
Filter by featured flag (1 = featured, 0 = not featured)

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