RealtyMX Data API

Version 1.0

Resources:

neighborhoods GET /neighborhoods

Returns list of neighborhoods

Request
Method URL
GET dataapi.realtymx.com/neighborhoods
Parameters
Parameter Name Data Type Values
apiKey string required (default: "")
API KEY
neighborhood_id string optional (default: "")
ID number of an indivisual neighborhood id, or a comma-delimited list of ID numbers

listingsHistory GET /listingsHistory

Returns list of listingsHistory

Request
Method URL
GET dataapi.realtymx.com/listingsHistory
Parameters
Parameter Name Data Type Values
apiKey string required (default: "")
API KEY
listing_id string required (default: "")
ID number of an individual listing or a comma-delimited list of ID numbers.
limit numeric optional (default: 20)
Number of listings per result (5 / 10 / 20). Up to 100 listings per result
page numeric optional (default: 1)
Page number (1 or higher)
update_type string optional (default: "")
Status for status change or Price for price change
updated_since string optional (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.
status_type string optional (default: "")
Filter status change logs based on new listing status type or price change log based on the current listing status
Response Body Example
    Example: https://dataapi.realtymx.com/listingsHistory/?apikey=your_api_key&listing_id=850072

    {
        "TOTAL_LISTING_COUNT": 1,
        "LISTING_HISTORY": [
           {
              "HISTORY_NOTES": [
                 {
                    "LOG_DATE": "2019-03-16 10:10:10",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Listed Date",
                    "PRICE_PRECENTAGE_CHANGE": "",
                    "LISTING_ID": 850072,
                    "COMMENT": "Listed",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": "",
                    "NEW_PRICE": "",
                    "ID": 6093764,
                    "TYPE": 8,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-03-16 10:10:10",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Status Change",
                    "PRICE_PRECENTAGE_CHANGE": "",
                    "LISTING_ID": 850072,
                    "COMMENT": "Initial Status: For Sale",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "For Sale",
                    "OLD_PRICE": "",
                    "NEW_PRICE": "",
                    "ID": 6093766,
                    "TYPE": 2,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-03-16 10:10:10",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "History Log",
                    "PRICE_PRECENTAGE_CHANGE": "",
                    "LISTING_ID": 850072,
                    "COMMENT": "Original Price: $548,000",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": "",
                    "NEW_PRICE": "",
                    "ID": 6093765,
                    "TYPE": 0,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-04-29 18:39:15",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Price Change",
                    "PRICE_PRECENTAGE_CHANGE": -5.47,
                    "LISTING_ID": 850072,
                    "COMMENT": "Price Change: $548,000 to $518,000 (- 5.47%)",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": 548000,
                    "NEW_PRICE": 518000,
                    "ID": 6164544,
                    "TYPE": 1,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-06-05 12:56:39",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Price Change",
                    "PRICE_PRECENTAGE_CHANGE": -3.86,
                    "LISTING_ID": 850072,
                    "COMMENT": "Price Change: $518,000 to $498,000 (- 3.86%)",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": 518000,
                    "NEW_PRICE": 498000,
                    "ID": 6228633,
                    "TYPE": 1,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-09-03 11:51:53",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Price Change",
                    "PRICE_PRECENTAGE_CHANGE": -10.04,
                    "LISTING_ID": 850072,
                    "COMMENT": "Price Change: $498,000 to $448,000 (- 10.04%)",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": 498000,
                    "NEW_PRICE": 448000,
                    "ID": 6375831,
                    "TYPE": 1,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-09-23 17:53:41",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Status Change",
                    "PRICE_PRECENTAGE_CHANGE": "",
                    "LISTING_ID": 850072,
                    "COMMENT": "Status Change: For Sale to In Contract",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "For Sale",
                    "NEW_STATUS": "In Contract",
                    "OLD_PRICE": "",
                    "NEW_PRICE": "",
                    "ID": 6412976,
                    "TYPE": 2,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2019-09-23 18:54:04",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Price Change",
                    "PRICE_PRECENTAGE_CHANGE": 1.56,
                    "LISTING_ID": 850072,
                    "COMMENT": "Price Change: $448,000 to $455,000 (+ 1.56%)",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "",
                    "NEW_STATUS": "",
                    "OLD_PRICE": 448000,
                    "NEW_PRICE": 455000,
                    "ID": 6413069,
                    "TYPE": 1,
                    "NOTE_UPDATED_BY": "RLS "
                 },
                 {
                    "LOG_DATE": "2020-04-13 01:58:14",
                    "AGENT_ID": 1,
                    "NOTE_TYPE": "Status Change",
                    "PRICE_PRECENTAGE_CHANGE": "",
                    "LISTING_ID": 850072,
                    "COMMENT": "Status Change: In Contract to Sold",
                    "COMPANY": "Douglas Elliman Real Estate",
                    "OLD_STATUS": "In Contract",
                    "NEW_STATUS": "Sold",
                    "OLD_PRICE": "",
                    "NEW_PRICE": "",
                    "ID": 6660304,
                    "TYPE": 2,
                    "NOTE_UPDATED_BY": "RLS "
                 }
              ],
              "LISTING_ID": 850072
           }
        ]
     }
ListingsHistory Fields Explanation
Field Name Description
TOTAL_LISTING_COUNT Integer. Total listing count returned from API
LISTING_ID Integer. Listing ID number
ID Integer. Notes ID number
LOG_DATE Date and Time field in YYYY-MM-DD HH:MM:SS format
NOTE_TYPE Text.
  • History Log
  • Price Change
  • Status Change
  • User Comments
  • Change Log
  • Listed Date
COMMENT Text. Listing History Note
COMPANY Text. Company assocaited with the listing
TYPE Integer, History Notes Type
  • 0 = History Log
  • 1 = Price Change
  • 2 = Status Change
  • 4 = User Comments
  • 6 = Change Log
  • 8 = Listed Date
OLD_STATUS Text. Old Status before the Status change.
Available when NOTE_TYPE = "Status Change" or TYPE = "2"
  • Suspend
  • For Sale
  • In Contract
  • Offer In
  • Sold
  • For Rent
  • App. Pending
  • Rented
  • Sales Inactive
  • Rental Inactive
  • In Contract Inactive
  • Offer In Inactive
  • Sold Inactive
  • App. Pending Inactive
  • Rented Inactive
NEW_STATUS Text. New Status after the Status change.
Available when NOTE_TYPE = "Status Change" or TYPE = "2"
  • Suspend
  • For Sale
  • In Contract
  • Offer In
  • Sold
  • For Rent
  • App. Pending
  • Rented
  • Sales Inactive
  • Rental Inactive
  • In Contract Inactive
  • Offer In Inactive
  • Sold Inactive
  • App. Pending Inactive
  • Rented Inactive
OLD_PRICE Integer. Old property price before the price change.
Available when NOTE_TYPE = "Price Change" or TYPE = "1"
NEW_PRICE Integer. New property price after the price change.
Available when NOTE_TYPE = "Price Change" or TYPE = "1"
PRICE_PRECENTAGE_CHANGE Decimal. Price percentage change
Available when NOTE_TYPE = "Price Change" or TYPE = "1"

listings GET /listings

Returns list of listings

Request
Method URL
GET dataapi.realtymx.com/listings
Parameters
Parameter Name Data Type Values
apiKey string required (default: "")
API KEY
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)
sort string optional (default: date)
Provide sorting factor (price / size / date). Default sorting value is date update
order string optional (default: desc)
Provide sorting order (desc / asc)
id string optional (default: "")
ID number of an individual listing,or a comma-delimited list of ID numbers.
status string optional (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)
updated_since string optional (default: "")
Confine results to listings which have benn updated since this time. Format MM/DD/YYYYTHH:MM
type string optional (default: "")
Listing Building Type
distribute numeric optional (default: 0)
Public listings only set to 0 or to include Internal Listings set to -2
neighborhood_id string optional (default: "")
ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers
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
shortTerm boolean optional (default: 0)
Brings only short term listings
sortByCompanyID numeric optional (default: 0)
Company internal CID to bring the company listing at first
includeCoAgent boolean optional (default: false)
True or False to include co-agent fileds or not
includeContacts boolean optional (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.
includeDoc boolean optional (default: false)
True or False to include document assigned on assocaited contact level
includeLastOffmarketDate boolean optional (default: 0)
include the last date when the listing becomes off market status
addLabels boolean optional (default: false)
Boolean value to include labels associated with each listing
label string optional (default: "")
Provide label name to search for
rls_id string optional (default: "")
Provide RLS ID
mls_no string optional (default: "")
Provide MLS No to search
category string optional (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)
amenities string optional (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)
address string optional (default: "")
listing address to search for, API will return best matching results
expand string optional (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.
featured boolean optional (default: false)
true or false to bring featured listings
Response Body Example
{  
   "TOTAL_COUNT":1,
   "LISTINGS":[  
      {  
         "MANAGEMENT_COMPANY_ID":104,
         "CONTACTS":[  
            {  
               "CONTACT_CELL_PHONE":"",
               "CONTACT_TYPE":"Landlord,Management,",
               "CONTACT_EMAIL":"[email protected]",
               "CONTACT_ID":104,
               "CONTACT_OFFICE_PHONE":"(212) 727-3500",
               "CONTACT_COMPANY":"TF Cornerstone",
               "CONTACT_WEBSITE":"http:\/\/www.tfcornerstone.com\/"
            }
         ],
         "LABELS":[  
            {  
               "ID":8,
               "NAME":"Check Status every Monday"
            },
            {  
               "ID":9,
               "NAME":"Company Exclusive"
            }
         ],
         "ACRIS_ID": "2021110900322001",
         "ACRIS_DOC_URL": "https://a836-acris.nyc.gov/DS/DocumentSearch/DocumentDetail?doc_id=2021110900322001",
         "ACRIS": [
            {
               "RECORDED_DATE": "2007-08-08 00:00:00",
               "RECORDED_PRICE": 880000
            },
            {
               "RECORDED_DATE": "2020-06-18 00:00:00",
               "RECORDED_PRICE": 1200000
            }
         ],
         "MONTHSFREEREQMINLEASE":0,
         "CLOSING_DATE":"",
         "MANAGEMENT_COMPANY":"TF Cornerstone",
         "OPEN_HOUSE_REMARK":"",
         "STREET_NUMBER":"45",
         "HEATING_SYSTEM":"",
         "MANAGEMENT_COMPANY_URL":"http:\/\/www.tfcornerstone.com\/",
         "TOTAL_ROOMS":2.0000,
         "MANAGEMENT_COMPANY_PHONE":"(212) 727-3500",
         "STATUS":"For Rent",
         "AMENITIES":"Balcony,Patio,Laundry In Unit,Doorman,Elevator,Health Club,Garage,Subway,Laundry,Bicycle Room,Storage,Lounge,Valet,Roof Deck,WiFi,Common Outdoor Space,Concierge,Live In Super,Children Playroom,Pied a Terre,",
         "ID":15264,
         "IDX":0,
         "NETRENT": 3201.92,
         "COBROKE_FEE":"0%",
         "PHOTOS":[  
            {  
               "PHOTO_TITLE":"floorplan",
               "PHOTO_URL":"http:\/\/tfc.com\/sites\/default\/files\/floorplans\/45WAA1_1601.pdf",
               "SORT_ORDER":0,
               "WIDTH":"",
               "HEIGHT":""
            },
            {  
               "PHOTO_TITLE":"Photo 2",
               "PHOTO_URL":"https:\/\/images.realty.mx\/618441d41cce47dbcfd9bed6e5ff64e6\/images\/assets\/15264_11171435.jpg",
               "SORT_ORDER":0,
               "WIDTH":768,
               "HEIGHT":768
            },
            {  
               "PHOTO_TITLE":"Photo 3",
               "PHOTO_URL":"https:\/\/images.realty.mx\/618441d41cce47dbcfd9bed6e5ff64e6\/images\/assets\/15264_11171436.jpg",
               "SORT_ORDER":0,
               "WIDTH":768,
               "HEIGHT":768
            }
         ],
         "NEIGHBORHOOD_ID":16,
         "PRICE":3493,
         "BATHROOMS":1.0000,
         "UTILITIESINCLUDED":"",
         "EXPOSURE_REMARK":"",
         "NAME":"",
         "MAINTENANCE":0,
         "OPEN_HOUSE_START_3":"",
         "PETS_POLICY":"Pets OK",
         "OPEN_HOUSE_START_4":"",
         "MAX_LEASE_TERM":0,
         "OPEN_HOUSE_START_1":"",
         "ADDRESS":"45 Wall Street, Unit 1601",
         "OPEN_HOUSE_START_2":"",
         "DATE_LISTED":"2018-12-08",
         "LISTING_TITLE":"Wall Street",
         "SQUARE_FOOTAGE":0,
         "CONDITION":"",
         "OPEN_HOUSE_END_4":"",
         "MIN_LEASE_TERM":0,
         "OPEN_HOUSE_END_2":"",
         "LATITUDE":40.706177,
         "OPEN_HOUSE_END_3":"",
         "OPEN_HOUSE_END_1":"",
         "VOW":0,
         "DOWN_PAYMENT":"0%",
         "FLOOR_NUMBER":"",
         "NEIGHBORHOODS":"Financial District",
         "NUM_IMAGES":28,
         "ZIP_CODE":"10005",
         "LONGITUDE":-74.00992,
         "TAXES":0,
         "STORIES":27,
         "STATE":"NY",
         "NO_SHARES":0,
         "VTOUR":"",
         "CYOF":0,
         "COMMON_CHARGES":0,
         "DESCRIPTION":"1 Full Month OP*. $1,000 Security Deposit -  Exclusions Apply. Incentives Apply to New Residents Only. Prices Listed Are the Net Effective Rents with 1 Month Free on 12 Month Leases Unless Stated Otherwise. *Restrictions May Apply.Fantastic Studio with a Large, Windowed Home Office, an Open Kitchen, Incredible Closet Space, and a Very Spacious Living and Dining Area with a Southern Exposure. Listed Price Reflects the Net Effective Rent on a 14-Month Lease with 2 Months Free.45 Wall Street is a unique mix of the new and historic, with modern conveniences alongside original architectural features. The building offers studio, one-, two- and three-bedroom apartments, as well as many homes with alcoves and home offices, all of which feature sleek, modern finishes and creative layouts. Many apartments feature extra high ceilings, pass-through kitchens or open plan layouts, wood strip floors, and large windows. Some residences also include private terraces and home offices with separate entrances.\n\nRecently expanded, the amenities at 45 Wall Street are superb. Sunbathe on the wraparound terrace, relax in the penthouse-level Club, play a game in the half-court basketball court, or enjoy a workout in the yoga room or one of our two state-of-the-art fitness centers.\n\nSituated in the one of the city’s oldest and historical thoroughfares, where New York City began, this dynamic neighborhood offers an exciting mix of green spaces, boutique shops, A-list bars, Michelin-starred restaurants, movie theaters, live music venues, museums and galleries. Whether you seek a new adventure at Governor’s Island or like to people-watch on the quaint cobblestones of Stone Street, the Financial District has it all.\r\n\r\nother",
         "HIDEADDRESS":0,
         "MANAGEMENT_COMPANY_EMAIL":"[email protected]",
         "DEDUCTIBLE":"0%",
         "BEDROOMS":0.0000,
         "COOLING_SYSTEM":"",
         "PROPERTY_TYPE":"Apartment",
         "BUILDING_ID":1600,
         "DATE_CREATE":"2008-07-25 07:40:00",
         "OP":"1 Month(s)",
         "SOURCEDB":"LD",
         "OPEN_HOUSE_REMARK_2":"",
         "ACCESS_NOTE":"Tel: 212.797.7000 • Fax: 212.797.7000 Mon.-Sun. 10:00-6:00",
         "FEE":"0%",
         "OPEN_HOUSE_REMARK_4":"",
         "OPEN_HOUSE_REMARK_3":"",
         "STREET":"Wall Street",
         "CUSTOMFIELDS":"",
         "CONCESSION":"1 Full Month OP.* $1,000 Security Deposit - Exclusions Apply.  Incentives Apply to New Residents Only. - Prices Listed Are the Net Effective Rents with  1 Month Free on 12 Month Leases Unless Stated Otherwise.",
         "DATE_AVAILABLE":"",
         "CLOSING_PRICE":"",
         "CROSS_STREET":"WILLIAM ST.",
         "FREEMONTH":0.0,
         "LISTING_CATEGORY":"OPEN",
         "CITY":"New York",
         "BROKER_NOTE":"",
         "UNIT_NUMBER":"1601",
         "DATE_UPDATE":"2019-02-01 10:00:00",
         "DOC_URL":"http:\/\/www.listingforce.com\/admin\/docs\/content\/3A085D59-945F-93CB-55E43423F1E408F2.pdf"
      }
   ]
}
Listings Fields Explanation
Field Name Description
TOTAL_COUNT Total listing count returned from API
ID Listing ID number
IDX 0 or 1, Indicate listing is IDX listing
Field is only used for RLS listings
VOW 0 or 1, Indicate listing is VOW listing
Field is only used for RLS listings
REBNY_LISTING_ID Rebny assigned listing ID similar to MLS ID
Field is only used for RLS listings
STREET_NUMBER Listing Address Street Number
ADDRESS Listing Address House Number + Street Name
NEIGHBORHOOD_ID Listing neighborhood ID
LATITUDE Decimal. Listing Latitude
LONGITUDE Decimal. Listing Longitude
STATUS
  • Suspend : 0
  • For Sale : 1
  • In Contract : 11
  • Offer In : 12
  • Sold : 19
  • For Rent : 2
  • App. Pending : 21
  • Rented : 22
  • Sales Inactive : -1
  • Rental Inactive : -11
  • In Contract Inactive : -12
  • Offer In Inactive : -19
  • Sold Inactive : -2
  • App. Pending Inactive : -21
  • Rented Inactive : -22
OFF_MARKET_STATUS Indicates off market status for inactive listings
  • Off Market (Withdrawn)
  • Temporary Off Market (30 days)
Field is only used for RLS listings
LISTING_CATEGORY
  • OPEN :0
  • Semi-Exclusive :1
  • Exclusive :2
  • Co-Broke :6
  • Private :4
AGENT_ID Integer. Listing agent ID
AGENT_NAME Listing agent name
AGENT_EMAIL Listing agent email address
AGENT_PHONE Listing agent office phone number
AGENT_MOBILE Listing agent mobile phone number
AGENT_IMAGE Listing main agent image URL
VEDNOR_AGENT_ID Vendor Listing Agent ID
Field is only used for RLS listings
REBNY_AGENT_ID Rebny Listing Agent ID
Field is only used for RLS listings
CO_AGENT_ID Integer. listing co-agent ID
CO_AGENT_NAME Listing co-agent name
CO_AGENT_EMAIL Listing co-agent email address
CO_AGENT_PHONE Listing co-agent office phone number
CO_AGENT_MOBILE Listing co-agent mobile phone number
CO_AGENT_IMAGE Listing co-main agent image URL
OFFICE_ID Integer. Listing agent office ID
OFFICE_NAME Listing agent office name, e.g. Brooklyn Office
OFFICE_EMAIL Listing agent office email address
OFFICE_PHONE Listing agent office phone number
OFFICE_FAX Listing agent office fax number
OFFICE_ADDRESS Listing agent office address
OFFICE_WEBSITE Listing agent office website URL
MANAGEMENT_COMPANY_ID ID of managment company assocaited with listing
Only available for Open Listings DB (Listing Force)
MANAGEMENT_COMPANY Managment company name
Only available for Open Listings DB (Listing Force)
MANAGEMENT_COMPANY_URL Managment company web site URL
Only available for Open Listings DB (Listing Force)
MANAGEMENT_COMPANY_PHONE Managment company phone number
Only available for Open Listings DB (Listing Force)
BEDROOMS Decimal. Bedroom count
BATHROOMS Decimal. Bathroom count
TOTAL_ROOMS Decimal. Total room count
PRICE Montly rent or Sales price
FEE Total fee %
COBROKE_FEE % fee paid to renter or buyer side broker or agent
OP Description of the fees paid by Owner such as 1 Month fee (Rental Only)
SECURITYDEPOSIT Description of the security deposit (Rental Only)
NETRENT Net Effective Rent (Rental Only)
FREEMONTH Number of free month(s) for rental (Rental Only)
MONTHSFREEREQMINLEASE Required minimum free month term to qualify free rent indicated at FREEMONTH (Free Month) field (Rental Only)
MAINTENANCE Monthly maintenance fee for Coop (Sales Only)
COMMON_CHARGES Monthly common charges for Condo (Sales Only)
DOWN_PAYMENT % of minimum down payment(Sales Only)
DEDUCTABLE Tax Deduction Percent(Sales Only)
CLOSING_PRICE Sold or Rented
CLOSING_DATE Date the property is Sold or Rented
ZONE Building Zoning
AGENTS_NOTE Building Agents Note
HEATING_SYSTEM
  • Gas-Forced-Air
  • Radiator
  • Central
  • Gas
  • Other
SERVICE_LEVEL
  • N/A
  • Full Service
  • Doorman (w/g)
  • Doorman (f/t)
  • Doorman (p/t)
  • Attended Lobby
  • Unattended Lobby
  • Virtual Doorman Only
  • Elevator
  • Brownstone
  • Walkup
  • Video
  • Voice
PUBLIC_TRANSPORT Public Transporation information such as subway lines and bus stops
FAMILIES Number of families. Usually used for building type House or Townhouse
UNITS Number of units in building
YEAR_BUILT Year when building was built
AMENITIES A list of one or more listing amenitites
  • Balcony
  • Bicycle Room
  • Brownstone
  • Business Center
  • Children Playroom
  • City View
  • Common Outdoor Space
  • Concierge
  • Convertible
  • Courtyard
  • Dining Room
  • Diplomats OK
  • Dishwasher
  • Doorman
  • Driveway
  • Duplex
  • Eat In Kitchen
  • Elevator
  • Fireplace
  • Freight Elevator
  • Furnished
  • Garage
  • Garden
  • Granite Kitchen
  • Green Building
  • Hardwood
  • Health Club
  • High Ceilings
  • High Speed Internet
  • Lake View
  • Laundry
  • Laundry In Unit
  • Laundry Services
  • Light
  • Live In Super
  • Live Work
  • Loft
  • Lounge
  • Maid Service
  • Marble Bath
  • Microwave
  • Multi Level
  • NO FEE
  • New Construction
  • Nursery
  • One Month Free
  • Open Kitchen
  • Open View
  • Original Details
  • Outdoor Space
  • Park View
  • Patio
  • Pied a Terre
  • Pool
  • Private Deck
  • Receiving Room
  • Recreational Room
  • Renovated
  • River View
  • Roof Deck
  • Room For Rent
  • Senior Housing
  • Skyline View
  • Sponsor Unit
  • Stainless Steel Appliances
  • Storage
  • Subway
  • Terrace
  • Triplex
  • Vacation Rental
  • Valet
  • Virtual Doorman
  • Walk In Closet
  • Wall to Wall Carpeting
  • Washer
  • Wheelchair Access
  • WiFi
  • Wine Cooler
PETS_POLICY
  • Unknown
  • No Pets
  • Cats Only
  • Dogs Only
  • Small Pets
  • Pets OK
  • Case By Case
UTILITIESINCLUDED
  • Gas
  • Electricity
  • Heat
  • Water
  • Cable/Internet
  • A/C
PARKING
  • Indoor
  • Outdoor
  • Assigned Parking
  • Heated
  • Valet
  • Street
  • Easy Street No Permit
  • Street with Permit
CONDITION
  • New Mint
  • Excellent
  • Good
  • Fair
  • Wreck
  • Estate
PHOTOS
  • PHOTO_TITLE: Photo title
  • PHOTO_URL: Photo URL
  • PHOTO_ORDER: numeric value for photo ordering
  • WIDTH: photo width in pixel
  • HEIGHT: photo height in pixel
CONTACTS
Contacts included when includeContacts flag set to TRUE
  • CONTACT_ID: Contact ID##
  • CONTACT_COMPANY: Contact Company Name
  • CONTACT_EMAIL: Contact Email Address
  • CONTACT_OFFICE_PHONE: Contact Office Phone Number
  • CONTACT_CELL_PHONE: Contact Cell Phone Number
  • CONTACT_WEBSITE: Contact Company Web Site URL
  • CONTACT_TYPE: Type of Contact
    • Landlord
    • Management
    • Broker
    • Super
    • Tenant
    • Agent
    • Doorman
    • Lawyer
    • Mortgage
    • Appraiser
    • Seller
    • ListingManager
    • Developer
    • Onsite
    • Group
    • Contractor
    • Inspector
    • Guarantor
    • Board
    • Other
LABELS
Labels included when addLabels flag set to TRUE
  • ID: Label ID##
  • NAME: Label Name
ACRIS_ID Acris ID
Field is only used for Acris listings
ACRIS_URL Link to ACRIS Document
Field is only used for Acris listings
ACRIS
Acris data is only enabled for the authorized API users
  • RECORDED_DATE: Sold / Closing recorded date from ACRIS
  • RECORDED_PRICE: Sold / Closing recorded price from ACRIS
BUILDING_CLASS
  • Indoor
  • Outdoor
  • Assigned Parking
  • Heated
  • Valet
  • Street
  • Easy Street No Permit
  • Street with Permit

deals GET /deals

Returns list of deals

Request
Method URL
GET dataapi.realtymx.com/deals
Parameters
Parameter Name Data Type Values
apiKey string required (default: "")
API KEY
limit numeric optional (default: 100)
Provide number of properties per page (10 / 20 / 40)
page numeric optional (default: 1)
Provide page number (1 or higher)
sort string optional (default: date)
Provide sorting factor (id / date)
order string optional (default: desc)
Provide sorting order (desc / asc)
id string optional (default: "")
ID number of an individual deal ,or a comma-delimited list of ID numbers.
updated_since string optional (default: "")
Confine results to deals which have benn updated since this time. Format mm/dd/yyyyThh:nn
Response Body Example
{
   "TOTAL_COUNT": 1,
   "deals": [
      {
         "ID": 3254,
         "LISTING_ADDRESS": "99 JOHN ST. #1F",
         "DEAL_TYPE": "Rental",
         "DEAL_STATUS": "Pending",
         "DEAL_DATE": "2016-01-27 00:00:00",
         "LEASE_SIGN_DATE": "2016-01-27 00:00:00",
         "AGENTS": [
            {
               "ID": 413,
               "EMAIL": "[email protected]",
               "NAME": "Rob Rodriguez"
            },
            {
               "ID": 423,
               "EMAIL": "[email protected]",
               "NAME": "Takumi Iwasaki"
            }
         ],
         "CLIENTS": [
            {
               "ID": 50,
               "EMAIL": "[email protected]",
               "NAME": "test test"
            },
            {
               "ID": 897,
               "EMAIL": "[email protected]",
               "NAME": "test realtymx"
            }
         ]
         "GURANTORS": [
            {
               "ID": 953,
               "EMAIL": "[email protected]",
               "NAME": "test Guarantor"
            }
         ],
      }
   ]
}
Deals Fields Explanation
Field Name Description
TOTAL_COUNT Total listing count returned from API
ID Deal ID number
LISTING_ADDRESS Listing address associated with deal record.
DEAL_TYPE
  • Rental
  • Sales
DEAL_STATUS
  • -999 : Draft
  • -1 : Pending
  • 1 : Approved
  • 2 : Paid
  • 0 : Cancelled
DEAL_DATE Date when deal is made
LEASE_SIGN_DATE Date when lease singed
AGENTS
  • ID: Agent ID
  • NAME: Agent Name
  • Email: Agent Email
CLIENTS
  • ID: Client ID
  • NAME: Client Name
  • Email: Client Email
GURANTORS
  • ID: Gurantor ID
  • NAME: Gurantor Name
  • Email: Gurantor Email

buildings GET /buildings

Returns list of buildings

Request
Method URL
GET dataapi.realtymx.com/buildings
Parameters
Parameter Name Data Type Values
apiKey string required (default: "")
API KEY
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)
sort string optional (default: date)
Provide sorting factor (id / date)
order string optional (default: desc)
Provide sorting order (desc / asc)
id string optional (default: "")
ID number of an individual listing,or a comma-delimited list of ID numbers.
updated_since string optional (default: "")
Confine results to buildings which have benn updated since this time. Format mm/dd/yyyyThh:nn
type string optional (default: "")
Building Type ()
neighborhood_id string optional (default: "")
ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers
Response Body Example
{
    "TOTAL_COUNT": 7756,
    "BUILDINGS": [
      {
         "MANAGEMENT_COMPANY_ID": 990,
         "MANAGEMENT_COMPANY": "TF Cornerstone",
         "ZONE": "ABC",
         "STREET_NUMBER": "99",
         "AGENTS_NOTE": "Pets Policy: Yes - Case by Case",
         "HEATING_SYSTEM": "Central",
         "MANAGEMENT_COMPANY_URL": "",
         "SERVICE_LEVEL": "Full Service",
         "MANAGEMENT_COMPANY_PHONE": "(212) 627-1000",
         "PUBLIC_TRANSPORT": "A,C,1,2,4,5",
         "FAMILIES": 0,
         "YEAR_BUILT": 2003,
         "AMENITIES": "Doorman,Elevator,Health Club,Garage,Subway,Laundry,Bicycle Room,Storage,Lounge,Valet,Roof Deck,WiFi,Common Outdoor Space,Live In Super,Children Playroom,Courtyard,Pied a Terre,",
         "ID": 1530,
         "PARKING": "Indoor",
         "UNITS": 439,
         "PHOTOS": [
            {
               "PHOTO_TITLE": "",
               "PHOTO_URL": "http://demo.realtymx.com/images/assets/1530_13380.jpg",
               "SORT_ORDER": 1,
               "WIDTH": 259,
               "HEIGHT": 194
            }
         ],
         "NEIGHBORHOOD_ID": 16,
         "BUILDING_CLASS": "",
         "BLOCK": 0,
         "STYLE": "N/A",
         "UTILITIESINCLUDED": "",
         "NAME": "99 John Deco Lofts",
         "LOT": 0,
         "SHARES_POLICY": "Shares Allowed",
         "DEALS_NOTE": "USA guarantors accepted\r\n2-3 week Approval time \r\nSigned application sublease form complete the sub-tenant info sheet recent tax and/or W2 signed at least 2 months of bank statements 3 months of pay stubs photo id verification of renters insurance \r\n$350 processing fee\r\n$175 application fee\r\n$110 Credit check \r\nPets Case by Case\r\n1 month free on 8 or 18 month lease",
         "ALTERNATE_ADDRESS": "",
         "PETS_POLICY": "No Pets",
         "ADDRESS": "99 John Street",
         "PERIOD": "Postwar",
         "PUBLIC_NOTE": "Built in 1933, the 99 John Deco Lofts building straddles the Financial District and the South Street Seaport and is an imposingly attractive structure decked out in limestone and granite. The building renovations were completed in 1999, delivering 442 loft apartments that vary according to 100 distinct floor plans configured as studios, 1-and 2-bedrooms as well as a few 3- and 4-bedroom units and penthouses.",
         "BUILDING_EXTENSION": "",
         "LATITUDE": 40.70836,
         "NEIGHBORHOODS": "Financial District",
         "NUM_IMAGES": 1,
         "BUILDING_WEBSITE": "http://www.99johndecolofts.com/",
         "ZIP_CODE": "10038",
         "LONGITUDE": -74.006004,
         "PRIVATE_NOTE": "",
         "BUILDING_KEYS": "KWDM",
         "STORIES": 25,
         "STATE": "NY",
         "LOT_SIZE": "",
         "CYOF": 0,
         "KEY_CODE": "",
         "CATEGORY": "OPEN",
         "MANAGEMENT_COMPANY_EMAIL": "",
         "COOLING_SYSTEM": "Central AC",
         "PROPERTY_TYPE": "Condo",
         "BUILDING_PHONE": "212-212-2121",
         "DATE_CREATE": "2018-03-29 14:27:27",
         "SOURCEDB": "demo",
         "ACCESS_NOTE": "TEL: (212) 217-9999 FAX: (212) 217-9995\r\nshows mon - fri 1-1:30pm & 3-3:30PM",
         "SCHOOL_CODE": "D2",
         "WALLS_POLICY": "Pressurized Walls",
         "STREET": "John Street",
         "CONCESSION": "",
         "CROSS_STREET": "CLIFF ST.",
         "CITY": "New York",
         "BUILDING_SIZE": "",
         "DATE_UPDATE": "2018-03-29 14:42:47"
      }
   ]
}
Buildings Fields Explanation
Field Name Description
TOTAL_COUNT Integer. Total building count returned from API
ID Integer. Building ID number
STREET_NUMBER Building Street Number
ADDRESS Building Address
ALTERNATE_ADDRESS Building Alternate Address
LATITUDE Decimal. Building Latitude
LONGITUDE Decimal. Building Longitude
ALTERNATE_ADDRESS Building Alternate Address
CATEGORY
  • Open
  • Semi-Exclusive
  • Exclusive
  • Co-Broke
  • Private
PROPERTY_TYPE
  • Apartment
  • House
  • Townhouse
  • Condo
  • Coop
  • Condop
  • Building
  • Commercial
  • Office
  • Retail
  • Investment
  • Development
  • Land
  • Parking Spots
  • Mixed Use
AMENITIES A list of one or more building amenitites
  • Bicycle Room
  • Brownstone
  • Business Center
  • Children Playroom
  • Common Outdoor Space
  • Concierge
  • Courtyard
  • Diplomats OK
  • Doorman
  • Driveway
  • Elevator
  • Freight Elevator
  • Garage
  • Green Building
  • Health Club
  • High Speed Internet
  • Laundry
  • Laundry Services
  • Live In Super
  • Lounge
  • Maid Service
  • New Construction
  • Nursery
  • Pied a Terre
  • Pool
  • Receiving Room
  • Roof Deck
  • Storage
  • Subway
  • Valet
  • Virtual Doorman
  • Wheelchair Access
  • WiFi
AGENTS_NOTE Building Agents Note
DEALS_NOTE Building Deals Note
PUBLIC_NOTE Building Note for public
PRIVATE_NOTE Building Note for internal use
ACCESS_NOTE Building Access Note
PUBLIC_TRANSPORT Public Transporation information such as subway lines and bus stops
FAMILIES Integer. Number of families. Usually used for building type House or Townhouse
UNITS Integer. Number of units in building
YEAR_BUILT Integer. Year when building was built e.g 2000
PERIOD
  • Prewar
  • Postwar
  • New
  • N/A
HEATING_SYSTEM
  • Gas-Forced-Air
  • Radiator
  • Central
  • Gas
  • Other
COOLING_SYSTEM
  • Central AC
  • Window/Wall
  • None
SERVICE_LEVEL
  • N/A
  • Full Service
  • Doorman (w/g)
  • Doorman (f/t)
  • Doorman (p/t)
  • Attended Lobby
  • Unattended Lobby
  • Virtual Doorman Only
  • Elevator
  • Brownstone
  • Walkup
  • Video
  • Voice
PETS_POLICY
  • Unknown
  • No Pets
  • Cats Only
  • Dogs Only
  • Small Pets
  • Pets OK
  • Case By Case
WALLS_POLICY
  • Pressurized Walls
  • Bookcase Walls
  • Glass Sliding Door
  • Walkabout Wall
  • Divider
  • No Walls
  • Case by case
SHARES_POLICY
  • Shares Allowed
  • Shares Not Allowed
  • Case by case
PARKING
  • Indoor
  • Outdoor
  • Assigned Parking
  • Heated
  • Valet
  • Street
  • Easy Street No Permit
  • Street with Permit
ZONE Building Zoning
BUILDING_CLASS Building class for commercial building use.
  • A
  • B
  • C
BUILDING_EXTENSION Building extension code for commercial building use.
PHOTOS
  • PHOTO_TITLE: Photo title
  • PHOTO_URL: Photo URL
  • PHOTO_ORDER: integer. numeric value for photo ordering
  • WIDTH: integer. photo width in pixel
  • HEIGHT: integer. photo height in pixel
MANAGEMENT_COMPANY_ID Integer. ID of building managment company (contact record)
MANAGEMENT_COMPANY Building contact company name
MANAGEMENT_COMPANY_URL Building conatct web site URL
MANAGEMENT_COMPANY_PHONE Building conatct phone number

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