Nexus MLS RESO API v0.1

This page contains documentation for developers that would like to use Nexus MLS's RESO API services, which currently adheres to version 1.7 of the RESO Data Dictionary. The base URL for the services can be found to the right. To obtain an API key, you must log in to your Nexus MLS Developer account and request one.

BASE URL

https://api.nexusmls.io

Property

These endpoints are used for interaction with the Property resource of the Nexus MLS RESO database. Given the large size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Property
POST	/Property
GET	/Property\(\':ListingKey\'\)
PATCH	/Property\(\':ListingKey\'\)
DELETE	/Property\(\':ListingKey\'\)
GET	/Property\(\':ListingKey\'\)/Media
GET	/Property\(\':ListingKey\'\)/OpenHouse
GET	/Property\(\':ListingKey\'\)/Rooms
GET	/Property\(\':ListingKey\'\)/UnitTypes

Member

These endpoints are used for interaction with the Member resource of the Nexus MLS RESO database. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Member
POST	/Member
GET	/Member\(\':MemberKey\'\)
PATCH	/Member\(\':MemberKey\'\)
DELETE	/Member\(\':MemberKey\'\)
GET	/Member\(\':MemberKey\'\)/Office
GET	/Member\(\':MemberKey\'\)/Media

Office

These endpoints are used for interaction with the Office resource of the Nexus MLS RESO database. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Office
POST	/Office
GET	/Office\(\':OfficeKey\'\)
PATCH	/Office\(\':OfficeKey\'\)
DELETE	/Office\(\':OfficeKey\'\)
GET	/Office\(\':OfficeKey\'\)/MainOffice
GET	/Office\(\':OfficeKey\'\)/OfficeBroker
GET	/Office\(\':OfficeKey\'\)/OfficeManager
GET	/Office\(\':OfficeKey\'\)/Media

Media

These endpoints are used for interaction with the Media resource of the Nexus MLS RESO database. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Media
POST	/Media
GET	/Media\(\':MediaKey\'\)
PATCH	/Media\(\':MediaKey\'\)
DELETE	/Media\(\':MediaKey\'\)

PropertyRooms

These endpoints are used for interaction with the PropertyRooms resource of the Nexus MLS RESO database. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/PropertyRooms
POST	/PropertyRooms
GET	/PropertyRooms\(\':RoomKey\'\)
PATCH	/PropertyRooms\(\':RoomKey\'\)
DELETE	/PropertyRooms\(\':RoomKey\'\)
GET	/PropertyRooms\(\':RoomKey\'\)/Listing
GET	/PropertyRooms\(\':RoomKey\'\)/HistoryTransactional

PropertyUnitTypes

These endpoints are used for interaction with the PropertyUnitTypes resource of the Nexus MLS RESO database. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/PropertyUnitTypes
POST	/PropertyUnitTypes
GET	/PropertyUnitTypes\(\':UnitTypeKey\'\)
PATCH	/PropertyUnitTypes\(\':UnitTypeKey\'\)
DELETE	/PropertyUnitTypes\(\':UnitTypeKey\'\)
GET	/PropertyUnitTypes\(\':UnitTypeKey\'\)/Listing
GET	/PropertyUnitTypes\(\':UnitTypeKey\'\)/HistoryTransactional

Field

These endpoints are used for interaction with the Field resource of the Nexus MLS RESO database. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Field
GET	/Field\(\':FieldKey\'\)

Lookup

These endpoints are used for interaction with the Lookup resource of the Nexus MLS RESO database. This resource provides info on the various enumerations that are available for various fields in other resources. Given the size of the RESO data schema, many of the sample request bodies and responses below may not contain full data examples. For more information on the data schema, please see the RESO Data Dictionary page of this developer portal.

ENDPOINTS

GET	/Lookup
GET	/Lookup\(\':LookupKey\'\)