Data API reference

Total listing count returned from API

Listing ID number

0 or 1, Indicate listing is IDX listing Field is only used for RLS listings

0 or 1, Indicate listing is VOW listing Field is only used for RLS listings

Rebny assigned listing ID similar to MLS ID Field is only used for RLS listings

0 or 1, Indicate listing is shared with RLS participants only. These are withheld unless the API key is entitled to them, and they carry RLS_ID but usually no REBNY_LISTING_ID. The field itself is always returned, like IDX and VOW. Field is only used for RLS listings

Listing Address Street Number

Listing Address House Number + Street Name

Listing neighborhood ID

Listing Latitude

Listing Longitude

Property/Building Type. Multiple types can be specified as a comma-separated list (e.g. "Condo,Apartment" or "Commercial,Retail") Commercial Building Types: • Commercial • Retail • Office • Building • Land • Investment • Mixed Use Residential Building Types: • Condo • Apartment • Coop • Townhouse • House

Comma-separated list of related data to include in the response. Available options: • listings - Includes all active listings associated with the building • contacts - Includes all contacts associated with the building Note: When using expand, the response will include additional arrays (LISTINGS and/or CONTACTS) containing the expanded data.

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

Indicates off market status for inactive listings • Off Market (Withdrawn) • Temporary Off Market (30 days) Field is only used for RLS listings

OPEN :0 • Semi-Exclusive :1 • Exclusive :2 • Co-Broke :6 • Private :4

Listing agent ID

Listing agent name

Listing agent email address

Listing agent office phone number

Listing agent mobile phone number

Listing main agent image URL

Vendor Listing Agent ID Field is only used for RLS listings

Rebny Listing Agent ID Field is only used for RLS listings

listing co-agent ID

Listing co-agent name

Listing co-agent email address

Listing co-agent office phone number

Listing co-agent mobile phone number

Listing co-main agent image URL

Listing agent office ID

Listing agent office name, e.g. Brooklyn Office

Listing agent office email address

Listing agent office phone number

Listing agent office fax number

Listing agent office address

Listing agent office website URL

ID of managment company assocaited with listing Only available for Open Listings DB (Listing Force)

Managment company name Only available for Open Listings DB (Listing Force)

Managment company web site URL Only available for Open Listings DB (Listing Force)

Managment company phone number Only available for Open Listings DB (Listing Force)

Bedroom count

Bathroom count

Total room count

Montly rent or Sales price

Total fee %

% fee paid to renter or buyer side broker or agent

Description of the fees paid by Owner such as 1 Month fee (Rental Only)

Description of the security deposit (Rental Only)

Net Effective Rent (Rental Only)

Number of free month(s) for rental (Rental Only)

Required minimum free month term to qualify free rent indicated at FREEMONTH (Free Month) field (Rental Only)

Monthly maintenance fee for Coop (Sales Only)

Monthly common charges for Condo (Sales Only)

% of minimum down payment(Sales Only)

Tax Deduction Percent(Sales Only)

Sold or Rented

Date the property is Sold or Rented

Building Zoning

Building Agents Note

Gas-Forced-Air • Radiator • Central • Gas • Other

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 Transporation information such as subway lines and bus stops

Number of families. Usually used for building type House or Townhouse

Number of units in building

Year when building was built

Comma-separated amenity names, for example Dishwasher,Doorman,Roof Deck, with a possible trailing comma. Any of the 136 names listed under Update a listing → Available amenities can appear, limited to the amenities the client's database has.

Unknown • No Pets • Cats Only • Dogs Only • Small Pets • Pets OK • Case By Case

Gas • Electricity • Heat • Water • Cable/Internet • A/C

Indoor • Outdoor • Assigned Parking • Heated • Valet • Street • Easy Street No Permit • Street with Permit

New Mint • Excellent • Good • Fair • Wreck • Estate

PHOTO_ID: integer. The photo's ID - target it with PUT/DELETE /listings/{listing_id}/photos/{photo_id} • PHOTO_TITLE: Photo title • PHOTO_URL: Photo URL • SORT_ORDER: integer. numeric value for photo ordering • WIDTH: integer. photo width in pixel • HEIGHT: integer. photo height in pixel

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 included when addLabels flag set to TRUE • ID: Label ID# • NAME: Label Name

Acris ID Field is only used for Acris listings

Link to ACRIS Document Field is only used for Acris listings

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

Indoor • Outdoor • Assigned Parking • Heated • Valet • Street • Easy Street No Permit • Street with Permit

Boolean (0 or 1). Indicates if the listing is in Coming Soon status. A Coming Soon status means the listing is under contract with a listing agent but not yet fully active in the MLS. This status is used when a property is being prepared for sale but is not ready for showings. This status aligns with RESO (Real Estate Standards Organization) StandardStatus lookups

API KEY

Provide number of properties per page (10 / 20 / 40)

Provide page number (1 or higher)

Provide sorting factor (price / size / date). Default sorting value is date update

Provide sorting order (desc / asc)

ID number of an individual listing,or a comma-delimited list of ID numbers.

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)

Confine results to listings which have benn updated since this time. Format MM/DD/YYYYTHH:MM

Listing Building Type

Public listings only set to 0 or to include Internal Listings set to -2

Set to true to filter only internal listings (distribute values: 0, 3, -3, -2)

ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers

Provide minimum price

Provide maximum price

Provide minimum bedroom count

Provide maximum bedroom count

Provide minimum bathroom count

Provide maximum bathroom count

Brings only short term listings

Company internal CID to bring the company listing at first

True or False to include co-agent fileds or not

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.

True or False to include document assigned on assocaited contact level

include the last date when the listing becomes off market status

Boolean value to include labels associated with each listing

Provide label name to search for

Provide RLS ID

Provide MLS No to search

Provide a category value or a list of the listing category values. (0: Open, 1: Semi-exclusive, 2: Exclusive, 4: Private 6: Co-Broke)

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)

listing address to search for, API will return best matching results

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.

true or false to bring featured listings

Minimum Square Footage

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

Search by agent email

marketplace name from api_user table

Success on 201; Error otherwise.

What happened, or what failed.

ID of the created listing.

The stored status - always exactly what was requested.

The building the listing was attached to.

How the building was found: building_id, address (canonical match, zip agrees), address_zip_mismatch (address matched, stored zip differs), or address_loose (matched a building stored without a street-type word).

Address path only. Every building that matched, best first. More than one means the address exists as duplicate building records.

Address path only. The canonical form of the submitted street name used for matching. Also returned on a 404 so you can see what was searched.

The stored distribution (2 External by default).

True when the client's content rules altered the description; the details are in warnings and in the listing history.

on_market when the new listing is active - its days-on-market clock started and a Listed history entry was written. Absent otherwise.

Non-fatal notices: values replaced by building overrides, unusual prices, content removed from the description. Presence never means failure.

On 409 only. The existing listings for the same unit that blocked the insert: listing_id, status, agent_id, date_create.

Link to the listing in the RealtyMX admin.

API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.

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.

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.

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.

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.

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.

House number, up to 10 characters (Queens-style 43-12 accepted). Required unless building_id is supplied.

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.

Zip code. Part of the building match. Required unless building_id is supplied.

City, up to 20 characters. Required unless building_id is supplied.

State, up to 3 characters. Required unless building_id is supplied.

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.

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.

ID of the co-agent. Must exist and differ from agent_id.

0 (Open, default), 1 (Semi-Exclusive), 2 (Exclusive), 4 (Private), 6 (Co-Broke). An Exclusive listing requires a description.

Distribution: 2 (External - website and marketplaces, default), -2 (Internal only), 0 (both), 1 (website only).

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.

Web title, up to 100 characters. Banned words are removed.

Availability: a date as YYYY-MM-DD, or one of Immediately, ASAP, NOW!.

Floor, up to 10 characters.

Interior size in square feet. Whole number, zero or greater.

Bedroom count. Zero or greater; fractions allowed.

Bathroom count. Zero or greater; fractions allowed.

Total room count. Zero or greater; fractions allowed. A value below the bedroom count returns a warning.

Short remark about the space, up to 50 characters - for example '1 Bedroom'.

Whether the price is quoted as net effective rent. true/false. Requires months_free and min_lease_required greater than zero. Rentals only.

Number of free months offered. Numeric, zero or greater. Rentals only.

Minimum lease length in months required for the free months. Numeric, zero or greater. Rentals only.

OP (Owner Pays) amount. Numeric, zero or greater. Rentals only.

Unit for owner_pays_amount: 0 (N/A), 1 (Months), 4 (Weeks), 2 (Percent), 3 (Dollars). Rentals only.

Minimum lease term in months. Whole number; zero stores no value. Rentals only.

Maximum lease term in months. Whole number; zero stores no value; must not be lower than lease_term_min. Rentals only.

Free-text concessions description. Rentals only.

Collect Your Own Fee. true/false. Rentals only.

Lease type: 0 (N/A), 1 (Stabilized), 2 (Controlled), 3 (Decontrolled), 4 (Preferential). Rentals only.

Fee amount. Numeric, zero or greater; cannot exceed 100 when fee_type is percent.

Unit for fee: 0 (N/A), 1 (%), 2 ($), 3 (Month).

Co-broke amount. Numeric, zero or greater; cannot exceed fee when both are percentages.

Unit for cobroke_amount: 0 (N/A), 1 (% office fee), 2 ($ office fee), 3 (Month office fee).

Pets policy: 0 (Unknown), 99 (No Pets), 1 (Cats Only), 4 (Dogs Only), 2 (Small Pets), 3 (Pets OK), 98 (Case By Case).

Hide the address on the website. true/false.

Furnished. true/false.

Array of amenity names, for example ["Doorman", "Roof Deck"]. Names are matched case-insensitively ignoring spaces. Amenities set on the building are applied automatically. See available amenities.

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.

Exclusive start date as YYYY-MM-DD. Exclusive listings only; 1999-01-01 or later.

Closing date as YYYY-MM-DD. Applies when status is 19 (Sold) or 22 (Rented); defaults to today.

Closing price in whole currency units. Applies when status is 19 or 22; defaults to price.

Virtual tour URL, for example a Matterport link - returned as VTOUR by GET /listings. An absolute http(s) URL of up to 200 characters.

Second virtual tour URL - returned as VTOUR2 by GET /listings. Same rules as virtual_tour_url.

Agent and access notes / showing instructions. Not shown on the web site. Same name as the ACCESS_NOTE field GET /listings returns.

Deprecated alias of access_note, still accepted for existing integrations. Ignored when access_note is also sent.

Broker-to-broker note, up to 300 characters.

ID of the listing that was updated.

Success or Error.

Human readable outcome. On an error response this states which field failed validation and why.

One entry per field whose value actually changed, each with a from and a to. amenities is the exception: added and removed lists of amenity names. A field supplied in the request that already held that value does not appear here, and writes no listing history.

Present only when a change was allowed but is worth flagging - a rental priced at 100,000 or more, total rooms below the bedroom count, a bath count below 1, an inherit_building_access_note request that found no building notes to copy, a description the client's rules changed, or a cleared tour URL that GET /listings will fill with the listing's April video. Its presence never means the update failed.

on_market or off_market, present only when the status change moved the listing across that boundary.

Days the listing spent on market, present when it has just gone off market. Reported even when it is zero.

true when the listing was closed without closing values and they were filled in from the current price and today's date.

true when inherit_building_access_note was sent and the listing's access notes were replaced with a copy of its building's.

Present when description was sent: true when the client's description rules removed phone numbers, email addresses or banned words, or appended the client's disclaimer. The stored text is in changes.description.to.

Link to the listing in the RealtyMX admin, where the change and its history are visible.

For Sale -1

For Rent -2

In Contract -11

Offer In -12

App. Pending -21

Sold -19

Rented -22

Suspend n/a

A price change entry in the listing history, returned by /listingsHistory. A decrease also records the previous price and the reduction date, which is what drives price drop indicators. An increase does not, and leaves any earlier reduction on record.

A status change entry in the listing history, carrying the old and new status.

A change log entry recording the old and new value.

A change log entry for each field that moved.

A change log entry for each field that moved, except the two lease term fields, which the edit form does not log either.

A change log entry recording the old and new notes.

A change log entry recording the old and new description, flattened to one line.

A change log entry per tour URL that moved, labelled Virtual Tour or Virtual Tour2.

One change log entry per amenity added or removed.

A Listed or Relisted entry, and the days on market clock restarts.

The listing's last updated time, which updated_since filters read on the GET endpoints, and the updating agent taken from agent_id when supplied.

No writable field supplied; price not positive; unrecognised status; malformed date; a sales listing priced under 10,000; rental terms on a sales listing; closing values on a listing that is not Sold or Rented; net effective rent without free months and a minimum lease; minimum lease term above the maximum; unknown agent_id; access_note that is not a string, or sent on an MLS feed database; inherit_building_access_note that is not true/false, or sent together with an access_note value; description that is not a string; amenities that is not an array, or names an unknown amenity or one the client has no column for; a tour URL that is not an absolute http(s) URL or is longer than 200 characters.

API key missing, or the Authorization header is absent.

Key not authorized to write; wrong secret; secret missing or still derived from the public key.

No listing with that ID exists in the database this key is bound to.

Rate limit exceeded.

API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.

ID number of the listing to update. Taken from the URL path.

New asking price. Numeric and greater than zero. Optional, but at least one of price, status or date_available must be supplied.

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.

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.

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.

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.

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.

Interior size in square feet. Whole number, zero or greater.

Bedroom count. Zero or greater; fractions allowed.

Bathroom count. Zero or greater; fractions allowed, so 1.5 is valid.

Total room count. Zero or greater; fractions allowed. A value below the bedroom count is applied but returns a warning.

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.

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.

Number of free months offered. Numeric, zero or greater; fractions allowed.

Minimum lease length in months required to qualify for the free months. Numeric, zero or greater.

OP (Owner Pays) amount. Numeric, zero or greater. Interpreted according to owner_pays_type.

Unit for owner_pays_amount: 0 (N/A), 1 (Months), 4 (Weeks), 2 (Percent), 3 (Dollars).

Minimum lease term in months. Whole number, zero or greater; zero clears the value rather than storing 0, matching the web app.

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.

Free-text concessions description shown with the listing. Send an empty string to clear it.

Collect Your Own Fee. true/false or 1/0.

Lease type: 0 (N/A), 1 (Stabilized), 2 (Controlled), 3 (Decontrolled), 4 (Preferential).

Agent and access notes / showing instructions for this listing. Not shown on the web site. Send text to set the listing's own notes, or null or an empty string to clear them. To use the building's access notes instead, send inherit_building_access_note. Refused on MLS feed databases, where this column carries the listing agent's contact details.

Optional. true/false or 1/0, default false. When true, the building's access notes are copied onto the listing as its access_note. The copy is taken now; later edits to the building do not follow. Cannot be combined with an access_note value; access_note may be omitted or sent as null. If the listing has no building, or the building has no notes, the listing's notes are cleared and a warning is returned.

Listing description, replacing the current one. Send null or an empty string to clear it. Subject to the client's description rules, as in the web app: phone numbers and/or email addresses may be removed, banned words removed and a disclaimer appended; the response reports any change in description_modified and warnings.

The listing's complete amenity list as an array of names, for example ["Dishwasher", "Doorman"] - the names GET /listings returns in AMENITIES. Replaces the whole list: every amenity not named is removed, building amenities such as Doorman included. Send an empty array or null to clear every amenity. Names are matched case-insensitively ignoring spaces. See available amenities.

Virtual tour URL, for example a Matterport link - returned as VTOUR by GET /listings. An absolute http(s) URL of up to 200 characters. Send null or an empty string to clear it.

Second virtual tour URL - returned as VTOUR2 by GET /listings. Same rules as virtual_tour_url.

Total listing count returned from API

Listing ID number

Notes ID number

Date and Time field in YYYY-MM-DD HH:MM:SS format

Text. • History Log • Price Change • Status Change • User Comments • Change Log • Listed Date

Text. Listing History Note

Text. Company assocaited with the listing

Integer, History Notes Type • 0 = History Log • 1 = Price Change • 2 = Status Change • 4 = User Comments • 6 = Change Log • 8 = Listed Date

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

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 property price before the price change. Available when NOTE_TYPE = "Price Change" or TYPE = "1"

New property price after the price change. Available when NOTE_TYPE = "Price Change" or TYPE = "1"

Price percentage change Available when NOTE_TYPE = "Price Change" or TYPE = "1"

API KEY

ID number of an individual listing or a comma-delimited list of ID numbers.

Number of listings per result (5 / 10 / 20). Up to 100 listings per result

Page number (1 or higher)

Status for status change or Price for price change

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.

Filter status change logs based on new listing status type or price change log based on the current listing status

The photo's ID. Stable for the life of the photo, including when its image is replaced. Also returned in GET /listings PHOTOS.

The full-size image. Always absolute.

Caption; empty when none.

1-based display order, always 1..N. Position 1 is the listing's main photo (the first non-PDF).

Stored pixel size, after resizing. null on old rows that never recorded it.

Whether the stored image carries the client's watermark. Known only for photos uploaded through the API; null otherwise.

true if your API key uploaded this photo, or adopted it by replacing it with a source_id. Use it to keep your sync to your own photos.

Your ID for the image, as sent on upload. Only when MANAGED_BY_YOU is true.

Lower-case hex SHA-256 of the file you sent - not of the stored image, which is resized, re-encoded and possibly watermarked. Compare it with your source file to detect changes. Only when MANAGED_BY_YOU is true; RealtyMX holds no checksum for agent or feed photos.

ISO 8601 UTC time of the upload or last replace through the API. null for other photos.

API KEY

ID number of the listing. Taken from the URL path.

Success; for a batch, Partial when some photos failed, Error when all did.

What happened, or what failed.

The listing.

Single upload. The photo object (upper-case keys, as on GET /listings PHOTOS), with its final SORT_ORDER.

Photos on the listing after the upload, from every source.

true when the source_id already held this same file, so nothing was written (HTTP 200 instead of 201).

Batch only. One entry per photo in index order: index, source_id, http_status (what that photo would have returned on its own), then photo and idempotent_replay, or error.

Present when something was adjusted, e.g. watermark=true sent to a client with no watermark configured.

The listing's page in the RealtyMX back office.

API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.

ID number of the listing. Taken from the URL path.

The image, as a multipart file part. JPEG or PNG, at most 15 MB. Required for a single upload; for a batch use photos[n][file] instead.

Your stable ID for this image, 1-200 characters, matched case-insensitively. Required with file. Uploading the same source_id and file again returns the existing photo; the same source_id with a different file is a 409 - replace it with PUT. For a batch use photos[n][source_id].

Optional caption, up to 50 characters. A title of floorplan, floor plan or floor-plan marks a floor plan, which is never watermarked. For a batch use photos[n][title].

Optional 1-based position to insert the photo at. Omit to add it at the end; values past the end are clamped to the end. For a batch use photos[n][position].

Optional. false skips the client's watermark for this upload; omit it, or send true, to follow the client's setting. In a batch this is the default for every photo, and photos[n][watermark] overrides it.

Success, or Error.

Photo updated, or No changes when everything sent already matched.

The photo object after the change.

Photos on the listing.

Each changed field - photo_url, photo_title, sort_order - with its from and to value. Empty when nothing changed.

Present when something was adjusted.

The listing's page in the RealtyMX back office.

API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.

ID number of the listing. Taken from the URL path.

ID number of the photo. Taken from the URL path.

Optional new image, as a multipart file part. JPEG or PNG, at most 15 MB. Processed and watermarked like an upload.

Optional, with file only. Records the new image under this source_id. On a photo your key did not upload, this adopts the photo: it becomes MANAGED_BY_YOU. Must not belong to another photo on the listing.

Optional new caption, up to 50 characters. An empty value clears it.

Optional new 1-based position. The other photos shift to make room; values past the end move the photo to the end.

Optional, with file only. false skips the client's watermark for the new image.

API KEY. May be supplied as the username half of the Authorization header instead of as a parameter.

ID number of the listing. Taken from the URL path.

ID number of the photo. Taken from the URL path.

Total building count returned from API

Building ID number

Building Street Number

Building Address

Building Alternate Address

Building Latitude

Building Longitude

Building Alternate Address

Open • Semi-Exclusive • Exclusive • Co-Broke • Private

Apartment • House • Townhouse • Condo • Coop • Condop • Building • Commercial • Office • Retail • Investment • Development • Land • Parking Spots • Mixed Use

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

Building Agents Note

Building Deals Note

Building Note for public

Building Note for internal use

Building Access Note

Public Transporation information such as subway lines and bus stops

Number of families. Usually used for building type House or Townhouse

Number of units in building

Year when building was built e.g 2000

Prewar • Postwar • New • N/A

Gas-Forced-Air • Radiator • Central • Gas • Other

Central AC • Window/Wall • None

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

Unknown • No Pets • Cats Only • Dogs Only • Small Pets • Pets OK • Case By Case

Pressurized Walls • Bookcase Walls • Glass Sliding Door • Walkabout Wall • Divider • No Walls • Case by case

Shares Allowed • Shares Not Allowed • Case by case

Indoor • Outdoor • Assigned Parking • Heated • Valet • Street • Easy Street No Permit • Street with Permit

Building Zoning

Building class for commercial building use. • A • B • C

Building extension code for commercial building use.

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

Comma-separated list of related data to include in the response. Available options: • listings - Every listing attached to the building, active or not (ID, UNIT_NUMBER, STATUS, PRICE, BEDROOMS, BATHROOMS, ROOMS, DATE_UPDATE), newest update first. Inactive statuses end in "Inactive" • contacts - All contacts linked to the building (ID, COMPANY, EMAIL, OFFICEPHONE) Note: When using expand, the response will include additional arrays (LISTINGS and/or CONTACTS) containing the expanded data.

Present only when the request has address. Counted after every other filter, so management_company_id or contact_id can settle an ambiguous address. • STATUS - not_found (0 buildings), unique (1) or ambiguous (2 or more: the same address stored as several buildings) • BUILDING_IDS - every matching building ID, across all pages • HOUSE / NORMALIZED_ADDRESS - the house number and canonical street key that were searched, e.g. east 38 street • ZIP - the zip applied, from zip or the end of address; empty when none • ZIP_MISMATCH_IDS - buildings at the same address with a different stored zip, left out of BUILDING_IDS. Check these before creating a building on not_found

ID of the building's management company (contact record). Where several contacts are linked, this is the one with the lowest ID

Building contact company name

Building conatct web site URL

Building conatct phone number

API KEY

Provide number of properties per page (10 / 20 / 40)

Provide page number (1 or higher)

Provide sorting factor (id / date)

Provide sorting order (desc / asc)

ID number of an individual listing,or a comma-delimited list of ID numbers.

Confine results to buildings which have benn updated since this time. Format mm/dd/yyyyThh:nn

Building Type ()

ID number of an indivisual category id (neighborhood id), or a comma-delimited list of ID numbers

Comma-separated list of related data to include (listings,contacts)

Filter by featured flag (1 = featured, 0 = not featured)

Street address to look up, starting with the house number, e.g. 555 W 23rd St or 555 West 23rd Street, New York, NY 10011 (only the part before the first comma is matched; a trailing zip is used when zip is not given). Matched exactly after normalisation - abbreviations, ordinals and directions are equated (W 23 St = West 23rd Street) against the building's address and alternate address. Adds a MATCH block to the response.

5-digit zip code. Only used with address: buildings whose stored zip differs are excluded (and listed in MATCH.ZIP_MISMATCH_IDS).

Contact ID of the management company (the MANAGEMENT_COMPANY_ID returned for each building), or a comma-delimited list

Contact ID, or a comma-delimited list. Matches buildings linked to any of these contacts, not only through MANAGEMENT_COMPANY_ID

Neighborhood ID. This is the value to pass as neighborhood_id when filtering listings or buildings.

Neighborhood name, for example Battery Park City.

ID of the area this neighborhood sits inside. 0 means it is itself a top-level area, such as a borough.

Name of the parent area. An empty string on a top-level area, which is how you tell boroughs from the neighborhoods within them.

Image URL for the neighborhood. Frequently empty.

Free-text description. Frequently empty.

API KEY

ID number of an indivisual neighborhood id, or a comma-delimited list of ID numbers

Total contact count matching the request, not the number returned on this page.

Contact ID number.

Company name. Often the only name a contact has, since many contacts are companies rather than people.

What the contact is. A contact can be several things at once, so this is a comma-separated list built from the individual flags below, and it carries a trailing comma - Broker, rather than Broker. An empty string means no type is set. • Landlord • Management • Broker • Super • Tenant • Agent • Doorman • Lawyer • Mortgage • Appraiser • Seller • ListingManager • Developer • Onsite • Group • Contractor • Inspector • Guarantor • Board • Limited • Other

Whether the contact record is active. • Active • Inactive

The exclusivity arrangement with this contact. • OPEN • Semi-Exclusive • Exclusive • Co-Broke • Private

Contact email address. Not a unique identifier - the same address can appear on several contact records, and some are agent addresses rather than the contact's own.

Office phone number.

Contact website.

Full address as street, city state zip. Returned as an empty string when the street address is blank, rather than a partial address made up of city and state alone.

The contact's pets policy, applied to their listings. • Unknown • Cats Only • Small Dogs • Pets OK • Dogs Only • Case By Case • No Pets

Where a guarantor may be based for this contact's listings. • Unknown • No Guarantor • Case by Case • New York City • New York State • Tri State • USA • Anywhere

Free-text concessions offered across this contact's listings.

1 when the contact's listings must not be advertised, otherwise 0.

How to get into the building - keys, doorman, lockbox.

Internal note for agents. Not intended for public display.

IDs of up to three listing agents assigned to this contact. Empty when the slot is unused, so a contact with one agent returns values in the first slot only.

First and last name of the agent in the matching ID slot.

When the contact record was created.

When the contact record was last changed. This is what updated_since filters on.

API KEY

Provide number of properties per page (10 / 20 / 40)

Provide page number (1 or higher)

Provide sorting factor (id / date)

Provide sorting order (desc / asc)

ID number of an individual contact ,or a comma-delimited list of ID numbers.

Confine results to contacts which have benn updated since this time. Format mm/dd/yyyyThh:nn

Total tenant count matching the lookup (not the number returned on this page)

Tenant (contact) ID number

Tenant name

Tenant email address. Not a unique identifier — one email can match several contact records, which are returned as separate entries. Some addresses are agent emails or placeholders shared by many unrelated clients.

Cell number. May be empty even when HOME_PHONE is populated.

Home number

Office number

Tenant representation registration status. • HAS_AGREEMENT: true when a signed representation agreement is on file • SIGNATURE: the name the tenant signed with • SIGNED_DATE: date the agreement was signed • ACKNOWLEDGED: legacy acknowledgement flag; left null on recent records, so HAS_AGREEMENT is the reliable field • IS_TENANT_AGENT: agreement is tenant-side. Only captured since 2026-02-13 — older signed agreements return false because the flag did not exist yet, which is not evidence of landlord-side representation • IS_LANDLORD_AGENT: agreement is landlord-side • EXPIRATION_DATE: derived, see EXPIRATION_IS_DERIVED below • IS_ACTIVE: true when the derived EXPIRATION_DATE has not passed; inherits the same approximation • EXPIRATION_IS_DERIVED: always true. No expiration is stored in the database. EXPIRATION_DATE is calculated as SIGNED_DATE + EXPIRATION_TERM_DAYS. The agreement text actually runs from the date the tenant is introduced to a given property, which is per-property and not stored, so treat this date as indicative rather than contractual • EXPIRATION_TERM_DAYS: term used for the calculation (agreement_term_days request parameter, default 120) • AGENT: the agent associated with the tenant (ID / NAME / EMAIL). This is the agent currently assigned to the contact record, which is what the agent_id request parameter filters on. A tenant reassigned to a new agent carries their past registrations with them, so this is not a reliable record of who was present at signing

The optional "Search Criteria" block of the registration form. Every field is optional, and most registrants leave part of it blank, so check HAS_CRITERIA before treating an empty value as meaningful. Fields the tenant did not fill in are returned as an empty string, never as 0. • HAS_CRITERIA: true when the tenant supplied at least one criterion. SHARING_APARTMENT is deliberately excluded from this test, because false there does not distinguish "answered No" from "never answered" • APT_SIZE: size code, 1–6. Empty when not provided (stored as the -1 sentinel) • APT_SIZE_LABEL: the label for that code — Studio / Loft, Alcove Studio, One Bedroom, Two Bedroom, Three Bedroom, Four Bedroom +. The mapping lives in the registration form rather than the database; see the specification if you consume more than one client database • PRICE_MIN / PRICE_MAX: monthly rent range in dollars. Empty when the box was left blank (stored as the -1 sentinel). A returned 0 is stored distinctly from blank — read it as "no minimum" rather than as a missing value • PREFERRED_AREAS: neighborhoods the tenant selected, in the order they were stored. Empty array when none were chosen. The list mixes granularity: an entry may be a top-level region (Downtown, Brooklyn) or a neighborhood within one (East Village), and a tenant can pick both a region and neighborhoods inside it. • ID / NAME: neighborhood ID and name, matching /neighborhoods • PARENT_ID / PARENT_NAME: the region the neighborhood sits in; both empty when the entry is itself a top-level region • HAS_PETS: true when the tenant declared pets. There is no pets column in the database — the form stores the literal string "No" when the answer was No and when the question was skipped, so false does not distinguish the two • PETS_DESCRIPTION: free text describing the pets, e.g. "Cat", "2 small dogs". Empty when HAS_PETS is false • MOVE_BY: date the tenant must move by (yyyy-mm-dd). Self-reported and not validated, so a small number of records carry obviously mistyped years • REASON_FOR_MOVING: free text, e.g. "Lease ending" • SHARING_APARTMENT: true when the tenant said they would share the apartment. False covers both "answered No" and "never answered"

Co-signer (guarantor) declared on the tenant's application. Empty when none is declared. For co-signers recorded against a specific lease, use /leases. • NAME: Co-signer name • RELATIONSHIP: Relationship to the tenant, e.g. Father • INCOME: Free-text income. -1 means "not provided" • STATE: Co-signer state • SOURCE: Where the co-signer came from; "application" for the tenant's own application

Answer to the registration form's "Will you be using professional moving services?" question: true (Yes), false (No), or an empty string when it was not answered. The form pre-selects Yes, so true can mean the tenant left the default rather than actively asked for movers.

Answer to the registration form's "Will you need a telecommunications / internet service provider?" question: true (Yes), false (No), or an empty string when it was not answered. Despite the name this covers telecom / internet only, not gas or electricity. The form pre-selects Yes, so true can mean the tenant left the default. Empty on some 2019–2020 registrations taken on a form version that did not ask it.

API KEY

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.

ID number of an individual tenant (contact), or a comma-delimited list of ID numbers. Required unless email or agent_id is provided.

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.

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.

Confine results by registration status (1 = a signed representation agreement is on file, 0 = none). Leave empty for both. Requires a database holding clientData.

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.

Provide number of tenants per page (max 100)

Provide page number (1 or higher)

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.

Total lease count matching the lookup (not the number returned on this page)

Deal ID number of the lease

Date the lease was signed. Results are sorted on this field, newest first by default, so the most recent signed lease is the first entry.

Date the lease term begins

Date the lease term ends

Address recorded on the deal (house + street + apartment). Stored on the deal at deal time, so it may differ from the listing's current address.

Address parts recorded on the deal

Rent recorded when the deal closed

Bedrooms. Read from the listing's current record rather than a snapshot taken at signing, and null when the listing no longer resolves.

Bathrooms. Same caveat as BEDS.

ID of the listing the lease was signed on

Executed leases only. Draft (-999), Cancelled (0) and Pending (-1) are excluded, so a tenant whose lease is signed but not yet approved returns no leases at all. • Approved • Paid

The contact record this lease belongs to. One email can map to several contact records, so a single email lookup may return leases under different TENANT.ID values. Each lease is returned once even when several contacts share it, attributed to the most recent matching contact. • ID: Tenant (contact) ID • NAME: Tenant Name • EMAIL: Tenant Email • CELL_PHONE: Tenant cell number

Agents on the deal. Empty array when none are recorded. • ID: Agent ID • NAME: Agent Name • EMAIL: Agent Email

Co-signers (guarantors) recorded against this lease. Empty array when none. • ID: Co-signer ID • NAME: Co-signer Name • EMAIL: Co-signer Email • CELL_PHONE: Co-signer cell number

API KEY

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.

Contact ID of the tenant, or a comma-delimited list of ID numbers. Required unless email is provided.

Provide number of leases per page (max 100)

Provide page number (1 or higher)

Sort order on lease sign date (desc / asc). Default desc, so the most recent signed lease is first.

Confine results to leases signed on or after this time. Format mm/dd/yyyyThh:nn

Total lead count matching the request, across every page — not the number of leads in this response.

Lead ID number.

When the lead was captured. Filter on this with created_since.

When the lead was last changed. Filter on this with updated_since to sync incrementally. Always populated, and never earlier than DATE_CREATE.

Name given by the lead. NAME is the two joined, and is empty when neither was supplied.

Email address given by the lead. Not unique: the same address can appear on many unrelated leads, and is often an agent or placeholder address rather than the person's own.

What the lead is looking for, derived from LEAD_TYPE_CODE: • 1 → sale • 2 → rent Returned empty for any other stored code, rather than guessing. See LEAD_TYPE_CODE.

The raw stored type. Only 1 and 2 describe a lead. Listing status codes have leaked into this column over the years and also appear here: • 11 — In Contract • 19 — Sold • 21 — Ap Pending • 22 — Rented • -2 — For Rent (inactive) • -22 — Rented (inactive) These are not lead types and are not tombstones; deletion here is permanent, so a present row is a live row.

Whether the saved search still emails the client: • 0 → Inactive • 1 → Active This is not the lead pipeline stage. Rows are created active and switched off later, so the large majority of historic leads are inactive. A false IS_ACTIVE does not mean a dead or invalid lead — use PROGRESS for pipeline stage.

Where the lead came from, as ID and NAME (for example RentHop, StreetEasy, Zillow). The IDs are defined per client database and are not portable between clients — match on NAME, or re-read the IDs per client. Empty when the capturing system did not record a source, which does not mean the lead has no origin.

Free-text origin labels written by the capturing system. Convenient but inconsistent between systems, and not a reliable way to group leads by source — prefer SOURCE.

The message the lead sent, usually with the listing reference prepended. Free text, and it may also carry duplicate-lead blocks appended by the capture pipeline — do not parse it for structured data.

The pipeline stage, as ID and NAME (for example Unqualified Lead, Showing, Qualified Lead, In Contract). The stage list is defined per client. Empty means no stage has been set. This is the field to read for lead status, not IS_ACTIVE.

The agents the lead is assigned to, each with ID, NAME and EMAIL. Up to three, all co-equal — there is no primary. An empty array means the lead is unassigned; filter for those with agent_id=0.

The contact record this lead is linked to, for use with /tenants and /leases. Empty when the lead was never linked to a contact, and also when the linked contact was later deleted — the two are indistinguishable.

The listing the lead enquired about, when the lead came from one. LISTING_ID resolves against /listings only when LISTING_ID_SOURCE is empty; when it names another database the id belongs to that database and will not match this client's listings. Empty LISTING_ID means the lead was not tied to a specific listing.

The criteria attached to the lead: AREAS, STREET, CITY, STATE, ZIP, MIN_PRICE, MAX_PRICE, BEDS, BATHS, PROPERTY_TYPE. For a lead captured from a listing these are copied from that listing rather than stated by the person, and the price range is widened around the listing price — so it describes the listing enquired about, not necessarily a stated budget.

Neighbourhoods, each with ID and NAME, resolvable against /neighborhoods. An empty array means no area was recorded.

API KEY

ID number of an individual lead, or a comma-delimited list of ID numbers.

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.

Provide number of leads per page (max 100)

Provide page number (1 or higher)

Provide sorting factor (date / updated / id). date sorts on DATE_CREATE, updated on DATE_UPDATE.

Provide sorting order (desc / asc). Default desc, so the newest lead is first.

Confine results to leads changed on or after this time, compared against DATE_UPDATE. Use this to sync incrementally. Format mm/dd/yyyyThh:nn

Confine results to leads created on or after this time, compared against DATE_CREATE. Format mm/dd/yyyyThh:nn

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.

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.

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.

Filter on lead type (sale / rent). Leads whose stored type is neither are returned only when this filter is empty; see LEAD_TYPE.

Total listing count returned from API

Deal ID number

Listing address associated with deal record.

Rental • Sales

Draft • Pending • Approved • Paid • Cancelled

Date when deal is made

Date when lease singed

ID: Agent ID • NAME: Agent Name • Email: Agent Email

ID: Client ID • NAME: Client Name • Email: Client Email

ID: Gurantor ID • NAME: Gurantor Name • Email: Gurantor Email

API KEY

Provide number of properties per page (10 / 20 / 40)

Provide page number (1 or higher)

Provide sorting factor (id / date)

Provide sorting order (desc / asc)

ID number of an individual deal ,or a comma-delimited list of ID numbers.

Confine results to deals which have benn updated since this time. Format mm/dd/yyyyThh:nn