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.
https://api.nexusmls.ioThese 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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
AboveGradeFinishedArea
AboveGradeFinishedArea desc
AboveGradeFinishedAreaSource
AboveGradeFinishedAreaSource desc
AboveGradeFinishedAreaUnits
AboveGradeFinishedAreaUnits desc
AccessCode
$select
Select properties to be returned, see Select
AboveGradeFinishedArea
AboveGradeFinishedAreaSource
AboveGradeFinishedAreaUnits
AccessCode
AccessibilityFeatures
AdditionalParcelsDescription
AdditionalParcelsYN
$expand
Expand related entities, see Expand
*
OriginatingSystem
BuyerAgent
BuyerOffice
CoBuyerAgent
CoBuyerOffice
CoListAgent
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
AboveGradeFinishedArea
AboveGradeFinishedAreaSource
AboveGradeFinishedAreaUnits
AccessCode
AccessibilityFeatures
AdditionalParcelsDescription
AdditionalParcelsYN
$expand
Expand related entities, see Expand
*
OriginatingSystem
BuyerAgent
BuyerOffice
CoBuyerAgent
CoBuyerOffice
CoListAgent
ListingKey
key: ListingKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
ListingKey
key: ListingKey
New property values
odata_context
The requested url
AboveGradeFinishedAreaAboveGradeFinishedAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
AboveGradeFinishedAreaUnits
SquareFeet
SquareMeters
AccessCode
AccessibilityFeatures
AdditionalParcelsDescription
AdditionalParcelsYN
AnchorsCoTenants
Appliances
ArchitecturalStyle
AssociationAmenities
AssociationFeeAssociationFee2AssociationFee2Frequency
Annually
BiMonthly
BiWeekly
Daily
Monthly
OneTime
Quarterly
AssociationFeeFrequency
Annually
BiMonthly
BiWeekly
Daily
Monthly
OneTime
Quarterly
AssociationFeeIncludes
AssociationName
AssociationName2
AssociationPhone
AssociationPhone2
AssociationYN
AttachedGarageYN
AvailabilityDate
Basement
BasementYN
BathroomsFullBathroomsHalfBathroomsOneQuarterBathroomsPartialBathroomsThreeQuarterBathroomsTotalIntegerBedroomsPossibleBedroomsTotalBelowGradeFinishedAreaBelowGradeFinishedAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
BelowGradeFinishedAreaUnits
SquareFeet
SquareMeters
BodyType
BuilderModel
BuilderName
BuildingAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
BuildingAreaTotalBuildingAreaUnits
SquareFeet
SquareMeters
BuildingFeatures
BuildingName
BusinessName
BusinessType
BuyerAgencyCompensation
BuyerAgencyCompensationType
Dollars
Other
Percent
SeeRemarks
BuyerAgentAOR
SampleAOREnumValue
BuyerAgentDesignation
BuyerAgentDirectPhone
BuyerAgentEmail
BuyerAgentFax
BuyerAgentFirstName
BuyerAgentFullName
BuyerAgentHomePhone
BuyerAgentKey
BuyerAgentKeyNumericBuyerAgentLastName
BuyerAgentMiddleName
BuyerAgentMlsId
BuyerAgentMobilePhone
BuyerAgentNamePrefix
BuyerAgentNameSuffix
BuyerAgentOfficePhone
BuyerAgentOfficePhoneExt
BuyerAgentPager
BuyerAgentPreferredPhone
BuyerAgentPreferredPhoneExt
BuyerAgentStateLicense
BuyerAgentTollFreePhone
BuyerAgentURL
BuyerAgentVoiceMail
BuyerAgentVoiceMailExt
BuyerFinancing
BuyerOfficeAOR
SampleAOREnumValue
BuyerOfficeEmail
BuyerOfficeFax
BuyerOfficeKey
BuyerOfficeKeyNumericBuyerOfficeMlsId
BuyerOfficeName
BuyerOfficePhone
BuyerOfficePhoneExt
BuyerOfficeURL
BuyerTeamKey
BuyerTeamKeyNumericBuyerTeamName
CableTvExpenseCancellationDate
CapRateCarportSpacesCarportYN
CarrierRoute
City
SampleCityEnumValue
CityRegion
CloseDate
ClosePriceCoBuyerAgentAOR
SampleAOREnumValue
CoBuyerAgentDesignation
CoBuyerAgentDirectPhone
CoBuyerAgentEmail
CoBuyerAgentFax
CoBuyerAgentFirstName
CoBuyerAgentFullName
CoBuyerAgentHomePhone
CoBuyerAgentKey
CoBuyerAgentKeyNumericCoBuyerAgentLastName
CoBuyerAgentMiddleName
CoBuyerAgentMlsId
CoBuyerAgentMobilePhone
CoBuyerAgentNamePrefix
CoBuyerAgentNameSuffix
CoBuyerAgentOfficePhone
CoBuyerAgentOfficePhoneExt
CoBuyerAgentPager
CoBuyerAgentPreferredPhone
CoBuyerAgentPreferredPhoneExt
CoBuyerAgentStateLicense
CoBuyerAgentTollFreePhone
CoBuyerAgentURL
CoBuyerAgentVoiceMail
CoBuyerAgentVoiceMailExt
CoBuyerOfficeAOR
SampleAOREnumValue
CoBuyerOfficeEmail
CoBuyerOfficeFax
CoBuyerOfficeKey
CoBuyerOfficeKeyNumericCoBuyerOfficeMlsId
CoBuyerOfficeName
CoBuyerOfficePhone
CoBuyerOfficePhoneExt
CoBuyerOfficeURL
CoListAgentAOR
SampleAOREnumValue
CoListAgentDesignation
CoListAgentDirectPhone
CoListAgentEmail
CoListAgentFax
CoListAgentFirstName
CoListAgentFullName
CoListAgentHomePhone
CoListAgentKey
CoListAgentKeyNumericCoListAgentLastName
CoListAgentMiddleName
CoListAgentMlsId
CoListAgentMobilePhone
CoListAgentNamePrefix
CoListAgentNameSuffix
CoListAgentOfficePhone
CoListAgentOfficePhoneExt
CoListAgentPager
CoListAgentPreferredPhone
CoListAgentPreferredPhoneExt
CoListAgentStateLicense
CoListAgentTollFreePhone
CoListAgentURL
CoListAgentVoiceMail
CoListAgentVoiceMailExt
CoListOfficeAOR
SampleAOREnumValue
CoListOfficeEmail
CoListOfficeFax
CoListOfficeKey
CoListOfficeKeyNumericCoListOfficeMlsId
CoListOfficeName
CoListOfficePhone
CoListOfficePhoneExt
CoListOfficeURL
CommonInterest
CommunityApartment
Condominium
None
PlannedDevelopment
StockCooperative
Timeshare
CommonWalls
CommunityFeatures
Concessions
CallListingAgent
No
Yes
ConcessionsAmountConcessionsComments
ConstructionMaterials
ContinentRegion
Contingency
ContingentDate
ContractStatusChangeDate
Cooling
CoolingYN
CopyrightNotice
Country
AD
AE
AF
AG
AI
AL
AM
CountryRegion
CountyOrParish
SampleCountyOrParishEnumValue
CoveredSpacesCropsIncludedYN
CrossStreet
CultivatedAreaCumulativeDaysOnMarketCurrentFinancing
CurrentUse
DOH1
DOH2
DOH3
DaysOnMarketDevelopmentStatus
DirectionFaces
East
North
Northeast
Northwest
South
Southeast
Southwest
Directions
Disclaimer
Disclosures
DistanceToBusComments
DistanceToBusNumericDistanceToBusUnits
Feet
Meters
DistanceToElectricComments
DistanceToElectricNumericDistanceToElectricUnits
Feet
Meters
DistanceToFreewayComments
DistanceToFreewayNumericDistanceToFreewayUnits
Feet
Meters
DistanceToGasComments
DistanceToGasNumericDistanceToGasUnits
Feet
Meters
DistanceToPhoneServiceComments
DistanceToPhoneServiceNumericDistanceToPhoneServiceUnits
Feet
Meters
DistanceToPlaceofWorshipComments
DistanceToPlaceofWorshipNumericDistanceToPlaceofWorshipUnits
Feet
Meters
DistanceToSchoolBusComments
DistanceToSchoolBusNumericDistanceToSchoolBusUnits
Feet
Meters
DistanceToSchoolsComments
DistanceToSchoolsNumericDistanceToSchoolsUnits
Feet
Meters
DistanceToSewerComments
DistanceToSewerNumericDistanceToSewerUnits
Feet
Meters
DistanceToShoppingComments
DistanceToShoppingNumericDistanceToShoppingUnits
Feet
Meters
DistanceToStreetComments
DistanceToStreetNumericDistanceToStreetUnits
Feet
Meters
DistanceToWaterComments
DistanceToWaterNumericDistanceToWaterUnits
Feet
Meters
DocumentsAvailable
DocumentsChangeTimestamp
DocumentsCountDoorFeatures
DualVariableCompensationYN
Electric
ElectricExpenseElectricOnPropertyYN
ElementarySchool
SampleElementarySchoolEnumValue
ElementarySchoolDistrict
SampleElementarySchoolDistrictEnumValue
ElevationElevationUnits
Feet
Meters
EntryLevelEntryLocation
Exclusions
ExistingLeaseType
ExpirationDate
ExteriorFeatures
FarmCreditServiceInclYN
FarmLandAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
FarmLandAreaUnits
SquareFeet
SquareMeters
Fencing
FinancialDataSource
FireplaceFeatures
FireplaceYN
FireplacesTotalFlooring
FoundationAreaFoundationDetails
FrontageLength
FrontageType
FuelExpenseFurnished
Furnished
Negotiable
Partially
Unfurnished
FurnitureReplacementExpenseGarageSpacesGarageYN
GardenerExpenseGrazingPermitsBlmYN
GrazingPermitsForestServiceYN
GrazingPermitsPrivateYN
GreenBuildingVerificationType
GreenEnergyEfficient
GreenEnergyGeneration
GreenIndoorAirQuality
GreenLocation
GreenSustainability
GreenWaterConservation
GrossIncomeGrossScheduledIncomeHabitableResidenceYN
Heating
HeatingYN
HighSchool
SampleHighSchoolEnumValue
HighSchoolDistrict
SampleHighSchoolDistrictEnumValue
HomeWarrantyYN
HorseAmenities
HorseYN
HoursDaysOfOperation
HoursDaysOfOperationDescription
Inclusions
IncomeIncludes
InsuranceExpenseInteriorFeatures
InternetAddressDisplayYN
InternetAutomatedValuationDisplayYN
InternetConsumerCommentYN
InternetEntireListingDisplayYN
IrrigationSource
IrrigationWaterRightsAcresIrrigationWaterRightsYN
LaborInformation
LandLeaseAmountLandLeaseAmountFrequency
Annually
BiMonthly
BiWeekly
Daily
Monthly
OneTime
Quarterly
LandLeaseExpirationDate
LandLeaseYN
LatitudeLaundryFeatures
LeasableAreaLeasableAreaUnits
SquareFeet
SquareMeters
LeaseAmountLeaseAmountFrequency
Annually
BiMonthly
BiWeekly
Daily
Monthly
OneTime
Quarterly
LeaseAssignableYN
LeaseConsideredYN
LeaseExpiration
LeaseRenewalCompensation
LeaseRenewalOptionYN
LeaseTerm
MonthToMonth
Negotiable
None
Other
RenewalOption
ShortTermLease
SixMonths
Levels
License1
License2
License3
LicensesExpenseListAOR
SampleAOREnumValue
ListAgentAOR
SampleAOREnumValue
ListAgentDesignation
ListAgentDirectPhone
ListAgentEmail
ListAgentFax
ListAgentFirstName
ListAgentFullName
ListAgentHomePhone
ListAgentKey
ListAgentKeyNumericListAgentLastName
ListAgentMiddleName
ListAgentMlsId
ListAgentMobilePhone
ListAgentNamePrefix
ListAgentNameSuffix
ListAgentOfficePhone
ListAgentOfficePhoneExt
ListAgentPager
ListAgentPreferredPhone
ListAgentPreferredPhoneExt
ListAgentStateLicense
ListAgentTollFreePhone
ListAgentURL
ListAgentVoiceMail
ListAgentVoiceMailExt
ListOfficeAOR
SampleAOREnumValue
ListOfficeEmail
ListOfficeFax
ListOfficeKey
ListOfficeKeyNumericListOfficeMlsId
ListOfficeName
ListOfficePhone
ListOfficePhoneExt
ListOfficeURL
ListPriceListPriceLowListTeamKey
ListTeamKeyNumericListTeamName
ListingAgreement
ExclusiveAgency
ExclusiveRightToLease
ExclusiveRightToSell
ExclusiveRightWithException
Net
Open
Probate
ListingContractDate
ListingId
ListingKeyNumericListingService
EntryOnly
FullService
LimitedService
ListingTerms
LivingAreaLivingAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
LivingAreaUnits
SquareFeet
SquareMeters
LockBoxLocation
LockBoxSerialNumber
LockBoxType
LongitudeLotDimensionsSource
Appraiser
Assessor
Builder
Estimated
GisCalculated
Measured
Other
LotFeatures
LotSizeAcresLotSizeAreaLotSizeDimensions
LotSizeSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
LotSizeSquareFeetLotSizeUnits
Acres
SquareFeet
SquareMeters
MLSAreaMajor
SampleMLSAreaMajorEnumValue
MLSAreaMinor
SampleMLSAreaMinorEnumValue
MainLevelBathroomsMainLevelBedroomsMaintenanceExpenseMajorChangeTimestamp
MajorChangeType
Active
ActiveUnderContract
BackOnMarket
Canceled
Closed
Deleted
Expired
Make
ManagerExpenseMapCoordinate
MapCoordinateSource
MapURL
MiddleOrJuniorSchool
SampleMiddleOrJuniorSchoolEnumValue
MiddleOrJuniorSchoolDistrict
SampleMiddleOrJuniorSchoolDistrictEnumValue
MlsStatus
SampleMlsStatusEnumValue
MobileDimUnits
Feet
Meters
MobileHomeRemainsYN
MobileLengthMobileWidthModel
ModificationTimestamp
NetOperatingIncomeNewConstructionYN
NewTaxesExpenseNumberOfBuildingsNumberOfFullTimeEmployeesNumberOfLotsNumberOfPadsNumberOfPartTimeEmployeesNumberOfSeparateElectricMetersNumberOfSeparateGasMetersNumberOfSeparateWaterMetersNumberOfUnitsInCommunityNumberOfUnitsLeasedNumberOfUnitsMoMoNumberOfUnitsTotalNumberOfUnitsVacantOccupantName
OccupantPhone
OccupantType
Owner
Tenant
Vacant
OffMarketDate
OffMarketTimestamp
OnMarketDate
OnMarketTimestamp
OpenParkingSpacesOpenParkingYN
OperatingExpenseOperatingExpenseIncludes
OriginalEntryTimestamp
OriginalListPriceOriginatingSystemID
OriginatingSystemKey
OriginatingSystemName
OtherEquipment
OtherExpenseOtherParking
OtherStructures
OwnerName
OwnerPays
OwnerPhone
Ownership
OwnershipType
Corporation
Llc
Partnership
SoleProprietor
ParcelNumber
ParkManagerName
ParkManagerPhone
ParkName
ParkingFeatures
ParkingTotalPastureAreaPatioAndPorchFeatures
PendingTimestamp
PestControlExpensePetsAllowed
PhotosChangeTimestamp
PhotosCountPoolExpensePoolFeatures
PoolPrivateYN
Possession
PossibleUse
PostalCity
SamplePostalCityEnumValue
PostalCode
PostalCodePlus4
PowerProductionType
PreviousListPricePriceChangeTimestamp
PrivateOfficeRemarks
PrivateRemarks
ProfessionalManagementExpensePropertyAttachedYN
PropertyCondition
PropertySubType
Agriculture
Apartment
BoatSlip
Business
Cabin
Condominium
DeededParking
PropertyType
BusinessOpportunity
CommercialLease
CommercialSale
Farm
Land
ManufacturedInPark
Residential
PublicRemarks
PublicSurveyRange
PublicSurveySection
PublicSurveyTownship
PurchaseContractDate
RVParkingDimensions
RangeAreaRentControlYN
RentIncludes
RoadFrontageType
RoadResponsibility
RoadSurfaceType
Roof
RoomType
RoomsTotalSeatingCapacitySecurityFeatures
SeniorCommunityYN
SerialU
SerialX
SerialXX
Sewer
ShowingAdvanceNoticeShowingAttendedYN
ShowingContactName
ShowingContactPhone
ShowingContactPhoneExt
ShowingContactType
ShowingDays
ShowingEndTime
ShowingInstructions
ShowingRequirements
ShowingStartTime
SignOnPropertyYN
Skirt
SourceSystemID
SourceSystemKey
SourceSystemName
SpaFeatures
SpaYN
SpecialLicenses
SpecialListingConditions
StandardStatus
Active
ActiveUnderContract
Canceled
Closed
ComingSoon
Delete
Expired
StateOrProvince
AB
AK
AL
AR
AZ
BC
CA
StateRegion
StatusChangeTimestamp
StoriesStoriesTotalStreetAdditionalInfo
StreetDirPrefix
E
N
NE
NW
S
SE
SW
StreetDirSuffix
E
N
NE
NW
S
SE
SW
StreetName
StreetNumber
StreetNumberNumericStreetSuffix
SampleStreetSuffixEnumValue
StreetSuffixModifier
StructureType
SubAgencyCompensation
SubAgencyCompensationType
Dollars
Other
Percent
SeeRemarks
SubdivisionName
SuppliesExpenseSyndicateTo
SyndicationRemarks
TaxAnnualAmountTaxAssessedValueTaxBlock
TaxBookNumber
TaxLegalDescription
TaxLot
TaxMapNumber
TaxOtherAnnualAssessmentAmountTaxParcelLetter
TaxStatusCurrent
TaxTract
TaxYearTenantPays
Topography
TotalActualRentTownship
TransactionBrokerCompensation
TransactionBrokerCompensationType
Dollars
Other
Percent
SeeRemarks
TrashExpenseUnitNumber
UnitTypeType
UnitsFurnished
AllUnits
None
VariesByUnit
UniversalPropertyId
UniversalPropertySubId
UnparsedAddress
Utilities
VacancyAllowanceVacancyAllowanceRateVegetation
VideosChangeTimestamp
VideosCountView
ViewYN
VirtualTourURLBranded
VirtualTourURLUnbranded
WalkScoreWaterBodyName
WaterSewerExpenseWaterSource
WaterfrontFeatures
WaterfrontYN
WindowFeatures
WithdrawnDate
WoodedAreaWorkmansCompensationExpenseYearBuiltYearBuiltDetails
YearBuiltEffectiveYearBuiltSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
PublicRecords
YearEstablishedYearsCurrentOwnerZoning
ZoningDescription
1
{
"odata_context": "in",
"AboveGradeFinishedArea": 0,
"AboveGradeFinishedAreaSource": "Other",
"AccessibilityFeatures": [
"SmartTechnology",
"AccessibleDoors"
],
"AdditionalParcelsDescription": "commodo",
"AdditionalParcelsYN": true,
"AnchorsCoTenants": "ex",
"Appliances": [
"BuiltInFreezer",
"ElectricWaterHeater",
"EnergyStarQualifiedAppliances",
"WaterSoftenerOwned",
"WasherDryer"
],
"ArchitecturalStyle": [
"SampleArchitecturalStyleEnumValue",
"SampleArchitecturalStyleEnumValue",
"SampleArchitecturalStyleEnumValue",
"SampleArchitecturalStyleEnumValue",
"SampleArchitecturalStyleEnumValue"
],
"AssociationAmenities": [
"BilliardRoom",
"MaidService",
"PartyRoom",
"BoatDock"
],
"AssociationFee": 0,
"AssociationFee2": 0,
"AssociationFee2Frequency": "SemiAnnually",
"AssociationFeeFrequency": "SemiMonthly",
"AssociationFeeIncludes": [
"Trash",
"Trash",
"Internet",
"Internet",
"Gas"
],
"AssociationName": "in aliqua velit",
"AssociationName2": "veniam non dolor",
"AssociationPhone": "a",
"AssociationPhone2": "e",
"AssociationYN": false,
"AttachedGarageYN": true,
"AvailabilityDate": "2017-04-13",
"BasementYN": true,
"BathroomsFull": 42,
"BathroomsHalf": "42",
"BathroomsOneQuarter": 42,
"BathroomsPartial": "42",
"BathroomsThreeQuarter": 42,
"BedroomsPossible": "42",
"BedroomsTotal": "42",
"BelowGradeFinishedArea": 0,
"BelowGradeFinishedAreaSource": "Appraiser",
"BodyType": [
"SeeRemarks",
"SeeRemarks",
"TripleWide",
"DoubleWide"
],
"BuilderModel": "labor",
"BuilderName": "laborum mollit",
"BuildingAreaSource": "Assessor",
"BuildingAreaTotal": 0,
"BuildingAreaUnits": "SquareMeters",
"BuildingFeatures": [
"SampleBuildingFeaturesEnumValue",
"SampleBuildingFeaturesEnumValue",
"SampleBuildingFeaturesEnumValue",
"SampleBuildingFeaturesEnumValue",
"SampleBuildingFeaturesEnumValue"
],
"BuildingName": "in quis ullam",
"BusinessType": [
"AutoDealer",
"DanceStudio",
"Hobby",
"SaddleryHarness",
"Bakery"
],
"BuyerAgencyCompensation": "in magna eni",
"BuyerAgencyCompensationType": "Percent",
"BuyerAgentAOR": "SampleAOREnumValue",
"BuyerAgentDesignation": [
"CertifiedResidentialSpecialist",
"GeneralAccreditedAppraiser",
"CertifiedCommercialInvestmentMember",
"ePRO"
],
"BuyerAgentDirectPhone": "qui irure",
"BuyerAgentEmail": "dolore ",
"BuyerAgentFax": "officia d",
"BuyerAgentFirstName": "",
"BuyerAgentFullName": "fugia",
"BuyerAgentKey": "enim consectetur Lorem Duis",
"BuyerAgentKeyNumeric": 42,
"BuyerAgentLastName": "commodo ut velit",
"BuyerAgentMiddleName": "in aliqua",
"BuyerAgentMlsId": "in nostrud quis",
"BuyerAgentMobilePhone": "Lorem",
"BuyerAgentNameSuffix": "n",
"BuyerAgentOfficePhone": "conse",
"BuyerAgentPager": "est Exc",
"BuyerAgentPreferredPhone": "Ut irure ",
"BuyerAgentPreferredPhoneExt": "i",
"BuyerAgentStateLicense": "voluptate culpa lab",
"BuyerAgentURL": "dolore ut",
"BuyerAgentVoiceMailExt": "dolor adi",
"BuyerFinancing": [
"Assumed",
"Assumed",
"Other",
"FHA203b",
"Other"
],
"BuyerOfficeAOR": "SampleAOREnumValue",
"BuyerOfficeEmail": "d",
"BuyerOfficeFax": "do",
"BuyerOfficeKey": "velit exercitation id",
"BuyerOfficeMlsId": "Lorem officia anim",
"BuyerOfficeName": "ex",
"BuyerOfficePhone": "volup",
"BuyerOfficePhoneExt": "ea Ut",
"BuyerOfficeURL": "ipsum",
"BuyerTeamKey": "do ut elit exercitation",
"BuyerTeamKeyNumeric": "42",
"BuyerTeamName": "Excepteur do",
"CableTvExpense": 0,
"CancellationDate": "2017-04-13",
"CapRate": 0,
"CarportYN": false,
"CarrierRoute": "s",
"City": "SampleCityEnumValue",
"CityRegion": "tempor pariatur reprehenderit cupidatat",
"ClosePrice": 0,
"CoBuyerAgentDesignation": [
"AtHomeWithDiversity",
"AccreditedLandConsultant",
"RealEstateNegotiationExpert"
],
"CoBuyerAgentDirectPhone": "sed id ",
"CoBuyerAgentEmail": "sunt in sed nisi mollit",
"CoBuyerAgentFax": "",
"CoBuyerAgentFirstName": "Ut Duis mollit cill",
"CoBuyerAgentFullName": "consectetur labore",
"CoBuyerAgentHomePhone": "elit veniam",
"CoBuyerAgentKey": "mollit ex Lorem ali",
"CoBuyerAgentKeyNumeric": "42",
"CoBuyerAgentLastName": "labore do",
"CoBuyerAgentMiddleName": "eu",
"CoBuyerAgentMlsId": "eius",
"CoBuyerAgentNamePrefix": "ut",
"CoBuyerAgentNameSuffix": "in id L",
"CoBuyerAgentOfficePhone": "est",
"CoBuyerAgentOfficePhoneExt": "e",
"CoBuyerAgentPager": "eu do a",
"CoBuyerAgentPreferredPhone": "occaecat al",
"CoBuyerAgentPreferredPhoneExt": "exercitati",
"CoBuyerAgentStateLicense": "ut sit",
"CoBuyerAgentTollFreePhone": "incididunt conse",
"CoBuyerAgentVoiceMail": "ad aute repre",
"CoBuyerAgentVoiceMailExt": "",
"CoBuyerOfficeAOR": "SampleAOREnumValue",
"CoBuyerOfficeEmail": "fugiat ullamco pariatur",
"CoBuyerOfficeKey": "eu",
"CoBuyerOfficeKeyNumeric": 42,
"CoBuyerOfficeMlsId": "ex nostr",
"CoBuyerOfficeName": "nulla",
"CoBuyerOfficePhone": "Excepte",
"CoBuyerOfficePhoneExt": "",
"CoBuyerOfficeURL": "commodo",
"CoListAgentAOR": "SampleAOREnumValue",
"CoListAgentDesignation": [
"RealEstateNegotiationExpert",
"CertifiedRealEstateTeamSpecialist"
],
"CoListAgentDirectPhone": "labore cu",
"CoListAgentFax": "i",
"CoListAgentFullName": "enim et proident Lorem dolor",
"CoListAgentHomePhone": "culpa minim in a",
"CoListAgentKey": "dolore nulla",
"CoListAgentKeyNumeric": 42,
"CoListAgentLastName": "Duis Lorem",
"CoListAgentMobilePhone": "adipisi",
"CoListAgentNameSuffix": "c",
"CoListAgentOfficePhone": "i",
"CoListAgentOfficePhoneExt": "exercit",
"CoListAgentPager": "sit eiusm",
"CoListAgentPreferredPhone": "adipisicing ",
"CoListAgentPreferredPhoneExt": "aliqua",
"CoListAgentStateLicense": "aliqua aliquip minim tempor Ex",
"CoListAgentTollFreePhone": "elit",
"CoListAgentVoiceMail": "et si",
"CoListOfficeEmail": "cupidatat incididunt",
"CoListOfficeFax": "adipisic",
"CoListOfficeKey": "nostrud sunt amet tempor culp",
"CoListOfficeMlsId": "quis proident aliqua",
"CoListOfficeName": "sed",
"CoListOfficePhone": "ea",
"CoListOfficePhoneExt": "lab",
"CoListOfficeURL": "non aute Excepteur Ut",
"CommonInterest": "StockCooperative",
"CommonWalls": [
"NoOneBelow",
"NoCommonWalls",
"NoCommonWalls"
],
"CommunityFeatures": [
"Golf",
"FitnessCenter",
"Racquetball",
"Clubhouse",
"Park"
],
"Concessions": "CallListingAgent",
"ConcessionsAmount": 42,
"ConcessionsComments": "ut dolor irure fugiat",
"ConstructionMaterials": [
"MetalSiding",
"VinylSiding",
"Cedar",
"SprayFoamInsulation",
"SteelSiding"
],
"ContinentRegion": "nisi ex deserunt tempor",
"Contingency": "dolor quis adipisicing ad",
"ContingentDate": "2017-04-13",
"ContractStatusChangeDate": "2017-04-13",
"CopyrightNotice": "pariatur dolore",
"CountryRegion": "in",
"CountyOrParish": "SampleCountyOrParishEnumValue",
"CoveredSpaces": 0,
"CropsIncludedYN": false,
"CrossStreet": "labore aliquip voluptate",
"CultivatedArea": 0,
"CumulativeDaysOnMarket": "42",
"CurrentFinancing": [
"None",
"PowerPurchaseAgreement"
],
"CurrentUse": [
"Unimproved"
],
"DOH2": "incididunt la",
"DOH3": "dol",
"DaysOnMarket": 42,
"DevelopmentStatus": [
"SitePlanApproved",
"Proposed",
"RawLand",
"Completed",
"SeeRemarks"
],
"DirectionFaces": "Northeast",
"Directions": "elit incididunt eiusmod est culpa",
"Disclaimer": "esse quis aliqua",
"DistanceToBusComments": "sed dolore consequat proident",
"DistanceToBusNumeric": 42,
"DistanceToBusUnits": "Meters",
"DistanceToElectricNumeric": 42,
"DistanceToElectricUnits": "Feet",
"DistanceToFreewayComments": "officia in",
"DistanceToFreewayNumeric": 42,
"DistanceToGasComments": "mollit esse dolore nisi cul",
"DistanceToGasNumeric": 42,
"DistanceToGasUnits": "Meters",
"DistanceToPhoneServiceComments": "ve",
"DistanceToPhoneServiceNumeric": "42",
"DistanceToPhoneServiceUnits": "Feet",
"DistanceToPlaceofWorshipComments": "dolore amet culpa sunt o",
"DistanceToPlaceofWorshipUnits": "Feet",
"DistanceToSchoolBusComments": "quis cillum Lorem dolore",
"DistanceToSchoolBusNumeric": 42,
"DistanceToSchoolsComments": "Duis sit ipsum",
"DistanceToSchoolsNumeric": 42,
"DistanceToSewerComments": "sint sed velit consectetur",
"DistanceToSewerNumeric": "42",
"DistanceToSewerUnits": "Meters",
"DistanceToShoppingComments": "consequat eu anim ad ",
"DistanceToShoppingNumeric": 42,
"DistanceToShoppingUnits": "Meters",
"DistanceToStreetComments": "nulla",
"DistanceToStreetNumeric": "42",
"DistanceToStreetUnits": "Feet",
"DistanceToWaterComments": "cillum minim",
"DistanceToWaterNumeric": 42,
"DistanceToWaterUnits": "Meters",
"DocumentsAvailable": [
"SampleDocumentsAvailableEnumValue"
],
"DocumentsChangeTimestamp": "1898-05-03T07:48:01.0Z",
"DocumentsCount": 42,
"DualVariableCompensationYN": false,
"Electric": [
"Fuses",
"Volts220ForSpa",
"Underground"
],
"ElectricExpense": 0,
"ElectricOnPropertyYN": true,
"ElementarySchoolDistrict": "SampleElementarySchoolDistrictEnumValue",
"Elevation": 42,
"ElevationUnits": "Meters",
"EntryLevel": 42,
"EntryLocation": "deserunt ullamco eu",
"Exclusions": "tempor",
"ExistingLeaseType": [
"Nn",
"CpiAdjustment"
],
"ExpirationDate": "2017-04-13",
"ExteriorFeatures": [
"BoatSlip",
"PermeablePaving",
"RainGutters",
"Dock",
"PrivateYard"
],
"FarmCreditServiceInclYN": false,
"FarmLandAreaUnits": "SquareFeet",
"Fencing": [
"Brick",
"Brick",
"SplitRail",
"SlumpStone"
],
"FinancialDataSource": [
"Owner",
"PropertyManager",
"PropertyManager"
],
"FireplaceYN": true,
"FireplacesTotal": 42,
"FoundationArea": 0,
"FoundationDetails": [
"Block",
"Other",
"Slab",
"Raised"
],
"FrontageType": [
"Lakefront",
"LagoonEstuary",
"BayHarbor",
"Other"
],
"FuelExpense": 0,
"Furnished": "Negotiable",
"FurnitureReplacementExpense": 0,
"GarageSpaces": 0,
"GarageYN": false,
"GrazingPermitsBlmYN": false,
"GrazingPermitsForestServiceYN": true,
"GrazingPermitsPrivateYN": true,
"GreenBuildingVerificationType": [
"IndoorAirplus",
"HomeEnergyUpgradeCertificateOfEnergyEfficiencyPerformance"
],
"GreenEnergyEfficient": [
"Windows"
],
"GreenEnergyGeneration": [
"Wind",
"Wind",
"Wind"
],
"GreenSustainability": [
"RecycledMaterials"
],
"GreenWaterConservation": [
"GrayWaterSystem",
"EfficientHotWaterDistribution",
"WaterSmartLandscaping",
"WaterRecycling"
],
"GrossScheduledIncome": 0,
"HabitableResidenceYN": false,
"Heating": [
"ActiveSolar",
"FireplaceInsert",
"Radiant"
],
"HeatingYN": true,
"HighSchool": "SampleHighSchoolEnumValue",
"HighSchoolDistrict": "SampleHighSchoolDistrictEnumValue",
"HomeWarrantyYN": false,
"HorseYN": false,
"HoursDaysOfOperation": [
"OpenOver8HoursDay",
"Open24Hours",
"Open7Days",
"OpenMondayFriday",
"OpenSunday"
],
"HoursDaysOfOperationDescription": "amet quis sit",
"Inclusions": "sunt",
"IncomeIncludes": [
"Recreation",
"Parking",
"Recreation"
],
"InsuranceExpense": 0,
"InteriorFeatures": [
"CrownMolding",
"WalkInClosets",
"EntranceFoyer"
],
"InternetAddressDisplayYN": true,
"InternetAutomatedValuationDisplayYN": false,
"InternetConsumerCommentYN": false,
"InternetEntireListingDisplayYN": false,
"IrrigationSource": [
"SampleIrrigationSourceEnumValue",
"SampleIrrigationSourceEnumValue"
],
"IrrigationWaterRightsAcres": 0,
"LaborInformation": [
"EmployeeLicenseRequired",
"EmployeeLicenseRequired",
"NonUnion"
],
"LandLeaseAmount": 0,
"LandLeaseAmountFrequency": "BiMonthly",
"LandLeaseExpirationDate": "2017-04-13",
"LandLeaseYN": false,
"Latitude": 0,
"LeasableArea": 0,
"LeaseAmount": 0,
"LeaseAmountFrequency": "SemiMonthly",
"LeaseAssignableYN": true,
"LeaseConsideredYN": false,
"LeaseExpiration": "2017-04-13",
"LeaseRenewalCompensation": [
"NoRenewalCommission",
"NoRenewalCommission",
"CallListingOffice"
],
"LeaseRenewalOptionYN": true,
"LeaseTerm": "Other",
"Levels": [
"OneAndOneHalf",
"OneAndOneHalf",
"OneAndOneHalf"
],
"License1": "in exercita",
"License2": "ut ex do ullamco",
"License3": "ipsum est",
"ListAOR": "SampleAOREnumValue",
"ListAgentAOR": "SampleAOREnumValue",
"ListAgentDirectPhone": "dolore culpa",
"ListAgentEmail": "nostrud veniam",
"ListAgentFax": "non",
"ListAgentFullName": "ut in magna Duis incididunt",
"ListAgentHomePhone": "Du",
"ListAgentKey": "pariatur elit consectetur dolore aliquip",
"ListAgentKeyNumeric": "42",
"ListAgentLastName": "consectetur in",
"ListAgentMlsId": "mollit consectetur",
"ListAgentMobilePhone": "voluptat",
"ListAgentNamePrefix": "cup",
"ListAgentOfficePhoneExt": "ut exer",
"ListAgentPager": "est elit qui in ",
"ListAgentPreferredPhone": "culpa",
"ListAgentPreferredPhoneExt": "la",
"ListAgentStateLicense": "dolor",
"ListAgentTollFreePhone": "ut",
"ListAgentURL": "enim",
"ListAgentVoiceMail": "adipisicing Lore",
"ListAgentVoiceMailExt": "",
"ListOfficeAOR": "SampleAOREnumValue",
"ListOfficeEmail": "nostrud exercitation",
"ListOfficeKeyNumeric": "42",
"ListOfficeMlsId": "anim ",
"ListOfficeName": "cillum",
"ListOfficePhone": "ipsum quis co",
"ListOfficePhoneExt": "ei",
"ListOfficeURL": "magna anim consectetur Duis",
"ListPrice": 0,
"ListPriceLow": 0,
"ListTeamKey": "consequat",
"ListTeamKeyNumeric": 42,
"ListTeamName": "consectetur minim reprehenderit laboris",
"ListingContractDate": "2017-04-13",
"ListingId": "culpa Ut Duis",
"ListingKeyNumeric": "42",
"ListingService": "LimitedService",
"ListingTerms": [
"PrivateFinancingAvailable",
"Exchange1031"
],
"LivingArea": 0,
"LivingAreaUnits": "SquareMeters",
"LockBoxLocation": "proident",
"LockBoxType": [
"SeeRemarks"
],
"Longitude": 0,
"LotFeatures": [
"Waterfront"
],
"LotSizeAcres": 0,
"LotSizeArea": 0,
"LotSizeDimensions": "Duis sint sunt",
"LotSizeSource": "Other",
"LotSizeSquareFeet": 0,
"MLSAreaMajor": "SampleMLSAreaMajorEnumValue",
"MLSAreaMinor": "SampleMLSAreaMinorEnumValue",
"MainLevelBathrooms": 42,
"MainLevelBedrooms": 42,
"MaintenanceExpense": 0,
"MajorChangeTimestamp": "1895-07-17T09:55:29.0Z",
"MajorChangeType": "Withdrawn",
"Make": "anim occaecat tempor",
"ManagerExpense": 0,
"MapCoordinate": "quis laborum dolor cons",
"MapCoordinateSource": "officia Exce",
"MiddleOrJuniorSchoolDistrict": "SampleMiddleOrJuniorSchoolDistrictEnumValue",
"MlsStatus": "SampleMlsStatusEnumValue",
"MobileDimUnits": "Feet",
"MobileHomeRemainsYN": false,
"MobileLength": "42",
"MobileWidth": "42",
"Model": "ea in",
"NetOperatingIncome": 0,
"NewConstructionYN": false,
"NewTaxesExpense": 0,
"NumberOfBuildings": 42,
"NumberOfFullTimeEmployees": 42,
"NumberOfLots": "42",
"NumberOfPads": 42,
"NumberOfPartTimeEmployees": 42,
"NumberOfSeparateElectricMeters": 42,
"NumberOfSeparateGasMeters": 42,
"NumberOfSeparateWaterMeters": "42",
"NumberOfUnitsInCommunity": "42",
"NumberOfUnitsLeased": "42",
"NumberOfUnitsMoMo": 42,
"NumberOfUnitsTotal": "42",
"NumberOfUnitsVacant": 42,
"OccupantName": "amet Duis et",
"OccupantPhone": "vol",
"OccupantType": "Vacant",
"OffMarketDate": "2017-04-13",
"OffMarketTimestamp": "1966-07-02T15:25:25.0Z",
"OnMarketDate": "2017-04-13",
"OpenParkingYN": true,
"OperatingExpenseIncludes": [
"WaterSewer",
"Utilities",
"Maintenance",
"VacancyAllowance",
"SnowRemoval"
],
"OriginalEntryTimestamp": "1954-01-04T10:23:09.0Z",
"OriginalListPrice": 0,
"OriginatingSystemID": "elit esse",
"OriginatingSystemKey": "nisi sed pariatur Ut aute",
"OriginatingSystemName": "qui dolor velit magna",
"OtherEquipment": [
"Dehumidifier",
"DcWellPump",
"Compressor"
],
"OtherExpense": 0,
"OtherParking": "ut eu",
"OtherStructures": [
"Other",
"GrainStorage",
"CoveredArena",
"None"
],
"OwnerName": "consequat esse do",
"OwnerPays": [
"GroundsCare",
"Other",
"None"
],
"OwnerPhone": "cup",
"OwnershipType": "Llc",
"ParcelNumber": "sit Lorem Excepteur dolore co",
"ParkManagerName": "qui",
"ParkName": "dolore",
"ParkingFeatures": [
"ElectricVehicleChargingStations",
"GarageFacesFront",
"Enclosed"
],
"PastureArea": 0,
"PatioAndPorchFeatures": [
"SidePorch",
"RearPorch",
"Other"
],
"PendingTimestamp": "1927-09-20T12:37:58.0Z",
"PestControlExpense": 0,
"PetsAllowed": [
"DogsOk",
"Call",
"Yes"
],
"PhotosCount": "42",
"PoolExpense": 0,
"PoolFeatures": [
"Liner"
],
"Possession": [
"ClosePlus30Days",
"ClosePlus30Days",
"Negotiable",
"SubjectToTenantRights"
],
"PossibleUse": [
"Timber",
"Unimproved"
],
"PostalCity": "SamplePostalCityEnumValue",
"PostalCodePlus4": "i",
"PriceChangeTimestamp": "1930-09-17T11:01:51.0Z",
"PrivateOfficeRemarks": "nisi laborum",
"ProfessionalManagementExpense": 0,
"PropertyAttachedYN": false,
"PropertyCondition": [
"NewConstruction"
],
"PropertySubType": "Quadruplex",
"PropertyType": "Land",
"PublicRemarks": "velit adipisicing dolore ut",
"PublicSurveyRange": "tempor mol",
"PublicSurveySection": "adipisi",
"PurchaseContractDate": "2017-04-13",
"RVParkingDimensions": "eiusmod irure",
"RangeArea": 0,
"RentIncludes": [
"Other",
"Water",
"Internet"
],
"RoadFrontageType": [
"Unimproved",
"Other"
],
"RoadSurfaceType": [
"Asphalt",
"Asphalt",
"Paved"
],
"Roof": [
"BuiltUp",
"Mixed",
"Shingle",
"Foam",
"AsbestosShingle"
],
"RoomType": [
"MasterBathroom",
"MasterBedroom",
"LivingRoom"
],
"RoomsTotal": 42,
"SeatingCapacity": 42,
"SecurityFeatures": [
"SmokeDetectors",
"FireSprinklerSystem",
"SecuritySystemLeased",
"FireSprinklerSystem",
"CarbonMonoxideDetectors"
],
"SerialU": "nostrud",
"SerialX": "non quis ",
"SerialXX": "enim et tempor dolor",
"Sewer": [
"PrivateSewer",
"SepticNeeded",
"AerobicSeptic",
"PublicSewer"
],
"ShowingAdvanceNotice": 42,
"ShowingContactName": "commodo",
"ShowingContactPhone": "pari",
"ShowingContactType": [
"Owner",
"Agent"
],
"ShowingDays": [
"SampleShowingDaysEnumValue",
"SampleShowingDaysEnumValue"
],
"ShowingInstructions": "voluptate",
"ShowingRequirements": [
"SeeRemarks",
"TextListingAgent"
],
"ShowingStartTime": "1902-01-14T04:50:38.0Z",
"SignOnPropertyYN": true,
"SourceSystemID": "sed",
"SourceSystemKey": "tempor dolore sint ",
"SourceSystemName": "exercitation",
"SpaYN": false,
"SpecialLicenses": [
"Liquor5YearsOrLess",
"Entertainment",
"Other"
],
"SpecialListingConditions": [
"NoticeOfDefault",
"BankruptcyProperty",
"ThirdPartyApproval",
"Auction"
],
"StandardStatus": "Delete",
"StateOrProvince": "MB",
"StateRegion": "nisi",
"StatusChangeTimestamp": "1902-03-20T16:42:53.0Z",
"StreetDirPrefix": "S",
"StreetName": "m",
"StreetNumberNumeric": "42",
"StreetSuffix": "SampleStreetSuffixEnumValue",
"StreetSuffixModifier": "et labor",
"StructureType": [
"Duplex",
"House",
"Cabin",
"Office"
],
"SubAgencyCompensation": "sed mini",
"SubAgencyCompensationType": "Dollars",
"SuppliesExpense": 0,
"SyndicateTo": [
"ZillowTrulia"
],
"SyndicationRemarks": "labore in cupidatat sit veniam",
"TaxAnnualAmount": 0,
"TaxAssessedValue": 42,
"TaxBlock": "non",
"TaxBookNumber": "eiusmod ut dol",
"TaxLegalDescription": "consequat aliqua tempor",
"TaxLot": "ut exer",
"TaxMapNumber": "aute",
"TaxOtherAnnualAssessmentAmount": 0,
"TaxParcelLetter": "eu",
"TaxStatusCurrent": [
"Real",
"PersonalAndReal",
"PersonalAndReal",
"Personal"
],
"TaxTract": "do",
"TaxYear": "42",
"Topography": "Lorem eiusmod",
"TotalActualRent": 0,
"Township": "dolore magna amet",
"TransactionBrokerCompensationType": "Percent",
"TrashExpense": 0,
"UnitNumber": "occa",
"UnitTypeType": [
"ThreeBedroom",
"ManagersUnit",
"Efficiency"
],
"UnitsFurnished": "None",
"UniversalPropertyId": "ut sit",
"UniversalPropertySubId": "nulla i",
"UnparsedAddress": "laboris velit sunt voluptate",
"Utilities": [
"Propane",
"NaturalGasConnected"
],
"VacancyAllowance": "42",
"VacancyAllowanceRate": 0,
"Vegetation": [
"PartiallyWooded",
"Cleared",
"Brush"
],
"VideosChangeTimestamp": "1908-07-16T08:12:40.0Z",
"VideosCount": 42,
"ViewYN": false,
"VirtualTourURLBranded": "eu exercitation",
"VirtualTourURLUnbranded": "Lorem deserunt id elit ipsum",
"WalkScore": 42,
"WaterBodyName": "enim officia consequat elit",
"WaterSewerExpense": 0,
"WaterSource": [
"Private",
"Well"
],
"WaterfrontFeatures": [
"Pond",
"CanalAccess",
"OceanFront",
"OceanFront"
],
"WaterfrontYN": true,
"WindowFeatures": [
"AluminumFrames",
"DoublePaneWindows"
],
"WithdrawnDate": "2017-04-13",
"WorkmansCompensationExpense": 0,
"YearBuilt": "42",
"YearBuiltDetails": "aliquip exercitation veniam commodo dolore",
"YearBuiltSource": "Builder",
"YearEstablished": 42,
"YearsCurrentOwner": 42,
"Zoning": "deserunt id",
"ZoningDescription": "amet reprehenderit"
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
ListingKey
key: ListingKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
JobTitle
JobTitle desc
LastLoginTimestamp
LastLoginTimestamp desc
MemberAOR
MemberAOR desc
MemberAORMlsId
$select
Select properties to be returned, see Select
JobTitle
LastLoginTimestamp
MemberAOR
MemberAORMlsId
MemberAORkey
MemberAORkeyNumeric
MemberAddress1
$expand
Expand related entities, see Expand
*
Office
OriginatingSystem
SourceSystem
MemberSocialMedia
MemberOtherPhone
HistoryTransactional
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
JobTitle
LastLoginTimestamp
MemberAOR
MemberAORMlsId
MemberAORkey
MemberAORkeyNumeric
MemberAddress1
$expand
Expand related entities, see Expand
*
Office
OriginatingSystem
SourceSystem
MemberSocialMedia
MemberOtherPhone
HistoryTransactional
MemberKey
key: MemberKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
MemberKey
key: MemberKey
New property values
odata_context
The requested url
JobTitle
LastLoginTimestamp
MemberAOR
SampleAOREnumValue
MemberAORMlsId
MemberAORkey
MemberAORkeyNumericMemberAddress1
MemberAddress2
MemberAssociationComments
MemberCarrierRoute
MemberCity
MemberCountry
AD
AE
AF
AG
AI
AL
AM
MemberCountyOrParish
SampleCountyOrParishEnumValue
MemberDesignation
MemberDirectPhone
MemberEmail
MemberFax
MemberFirstName
MemberFullName
MemberHomePhone
MemberIsAssistantTo
MemberKeyNumericMemberLanguages
MemberLastName
MemberLoginId
MemberMiddleName
MemberMlsAccessYN
MemberMlsId
MemberMlsSecurityClass
SampleMemberMlsSecurityClassEnumValue
MemberMobilePhone
MemberNamePrefix
MemberNameSuffix
MemberNationalAssociationId
MemberNickname
MemberOfficePhone
MemberOfficePhoneExt
MemberOtherPhoneType
Direct
Fax
First
Home
Mobile
Modem
Office
MemberPager
MemberPassword
MemberPhoneTTYTDD
MemberPostalCode
MemberPostalCodePlus4
MemberPreferredPhone
MemberPreferredPhoneExt
MemberStateLicense
MemberStateLicenseState
AB
AK
AL
AR
AZ
BC
CA
MemberStateOrProvince
AB
AK
AL
AR
AZ
BC
CA
MemberStatus
Active
Inactive
MemberTollFreePhone
MemberType
Assistant
AssociationStaff
DesignatedRealtorAppraiser
DesignatedRealtorParticipant
LicensedAssistant
MlsOnlyAppraiser
MlsOnlyBroker
MemberVoiceMail
MemberVoiceMailExt
ModificationTimestamp
OfficeKey
OfficeKeyNumericOfficeMlsId
OfficeName
OriginalEntryTimestamp
OriginatingSystemID
OriginatingSystemMemberKey
OriginatingSystemName
SocialMediaType
Blog
Digg
Facebook
FacebookMessenger
Googleplus
iMessage
Instagram
SourceSystemID
SourceSystemMemberKey
SourceSystemName
SyndicateTo
1
{
"odata_context": "ea aute occaecat minim reprehenderit",
"JobTitle": "e",
"LastLoginTimestamp": "1951-03-15T12:33:14.0Z",
"MemberAOR": "SampleAOREnumValue",
"MemberAORMlsId": "ex culp",
"MemberAORkey": "mollit fugiat id",
"MemberAORkeyNumeric": 42,
"MemberAddress1": "l",
"MemberAddress2": "dolor eu fugiat",
"MemberAssociationComments": "mollit non aliquip tempor",
"MemberCarrierRoute": "reprehend",
"MemberCity": "ipsum",
"MemberCountry": "IE",
"MemberCountyOrParish": "SampleCountyOrParishEnumValue",
"MemberDesignation": [
"SocietyOfIndustrialAndOfficeRealtors",
"SellerRepresentativeSpecialist",
"CounselorOfRealEstate"
],
"MemberDirectPhone": "in velit occ",
"MemberEmail": "amet minim ea",
"MemberFax": "magna eu in ven",
"MemberFirstName": "laborum amet",
"MemberFullName": "ullamco dolor ex eiusmod dolore",
"MemberHomePhone": "ad consequat",
"MemberIsAssistantTo": "",
"MemberKeyNumeric": 42,
"MemberLanguages": [
"Frisian",
"Greek"
],
"MemberLastName": "dolor incididunt",
"MemberLoginId": "ipsum ut cillum cupidatat",
"MemberMiddleName": "anim culpa",
"MemberMlsAccessYN": true,
"MemberMlsId": "Excepteur",
"MemberMlsSecurityClass": "SampleMemberMlsSecurityClassEnumValue",
"MemberMobilePhone": "cillum sit",
"MemberNamePrefix": "vel",
"MemberNameSuffix": "dolor",
"MemberNationalAssociationId": "in ut sint",
"MemberNickname": "quis",
"MemberOfficePhone": "e",
"MemberOfficePhoneExt": "i",
"MemberOtherPhoneType": "Modem",
"MemberPager": "",
"MemberPassword": "mollit cillu",
"MemberPhoneTTYTDD": "magna",
"MemberPostalCode": "sit labor",
"MemberPostalCodePlus4": "cons",
"MemberPreferredPhone": "magna qui",
"MemberPreferredPhoneExt": "dolor",
"MemberStateLicense": "velit",
"MemberStateLicenseState": "IA",
"MemberStateOrProvince": "FL",
"MemberStatus": "Inactive",
"MemberTollFreePhone": "in sed ex n",
"MemberType": "MlsOnlySalesperson",
"MemberVoiceMail": "",
"MemberVoiceMailExt": "no",
"ModificationTimestamp": "1892-12-04T16:04:50.0Z",
"OfficeKey": "irure nostrud velit pariatur aliqua",
"OfficeKeyNumeric": "42",
"OfficeMlsId": "consectet",
"OfficeName": "aliqua anim ad sed",
"OriginalEntryTimestamp": "1934-07-26T11:30:05.0Z",
"OriginatingSystemID": "dolore dolo",
"OriginatingSystemMemberKey": "eu",
"OriginatingSystemName": "sit dolor consequat ut laboris",
"SocialMediaType": "Youtube",
"SourceSystemID": "ex tempor conseq",
"SourceSystemMemberKey": "enim in esse incididunt",
"SourceSystemName": "aliquip occaecat non",
"SyndicateTo": [
"HomesDotCom",
"HomesDotCom",
"ZillowTrulia"
]
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
MemberKey
key: MemberKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
FranchiseAffiliation
FranchiseAffiliation desc
IDXOfficeParticipationYN
IDXOfficeParticipationYN desc
MainOfficeKey
MainOfficeKey desc
MainOfficeKeyNumeric
$select
Select properties to be returned, see Select
FranchiseAffiliation
IDXOfficeParticipationYN
MainOfficeKey
MainOfficeKeyNumeric
MainOfficeMlsId
ModificationTimestamp
OfficeAOR
$expand
Expand related entities, see Expand
*
MainOffice
OfficeBroker
OfficeManager
OriginatingSystem
SourceSystem
HistoryTransactional
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
FranchiseAffiliation
IDXOfficeParticipationYN
MainOfficeKey
MainOfficeKeyNumeric
MainOfficeMlsId
ModificationTimestamp
OfficeAOR
$expand
Expand related entities, see Expand
*
MainOffice
OfficeBroker
OfficeManager
OriginatingSystem
SourceSystem
HistoryTransactional
OfficeKey
key: OfficeKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
OfficeKey
key: OfficeKey
New property values
FranchiseAffiliation
IDXOfficeParticipationYN
MainOfficeKey
MainOfficeKeyNumericMainOfficeMlsId
ModificationTimestamp
OfficeAOR
SampleAOREnumValue
OfficeAORMlsId
OfficeAORkey
OfficeAORkeyNumericOfficeAddress1
OfficeAddress2
OfficeAssociationComments
OfficeBranchType
Branch
Main
StandAlone
OfficeBrokerKey
OfficeBrokerKeyNumericOfficeBrokerMlsId
OfficeCity
OfficeCorporateLicense
OfficeCountyOrParish
SampleCountyOrParishEnumValue
OfficeEmail
OfficeFax
OfficeKeyNumericOfficeManagerKey
OfficeManagerKeyNumericOfficeManagerMlsId
OfficeMlsId
OfficeName
OfficeNationalAssociationId
OfficePhone
OfficePhoneExt
OfficePostalCode
OfficePostalCodePlus4
OfficeStateOrProvince
AB
AK
AL
AR
AZ
BC
CA
OfficeStatus
Active
Inactive
OfficeType
Affiliate
Appraiser
Association
Mls
MlsOnlyBranch
MlsOnlyFirm
MlsOnlyOffice
OriginalEntryTimestamp
OriginatingSystemID
OriginatingSystemName
OriginatingSystemOfficeKey
SocialMediaType
Blog
Digg
Facebook
FacebookMessenger
Googleplus
iMessage
Instagram
SourceSystemID
SourceSystemName
SourceSystemOfficeKey
SyndicateAgentOption
SampleSyndicateAgentOptionEnumValue
SyndicateTo
1
{}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
OfficeKey
key: OfficeKey
1
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.
| GET | /Media |
| POST | /Media |
| GET | /Media\(\':MediaKey\'\) |
| PATCH | /Media\(\':MediaKey\'\) |
| DELETE | /Media\(\':MediaKey\'\) |
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
ChangedByMemberID
ChangedByMemberID desc
ChangedByMemberKey
ChangedByMemberKey desc
ChangedByMemberKeyNumeric
ChangedByMemberKeyNumeric desc
ClassName
$select
Select properties to be returned, see Select
ChangedByMemberID
ChangedByMemberKey
ChangedByMemberKeyNumeric
ClassName
ImageHeight
ImageOf
ImageSizeDescription
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
New entity
ChangedByMemberID
ChangedByMemberKey
ChangedByMemberKeyNumericClassName
BusinessOpportunity
CommercialLease
CommercialSale
Contacts
CrossProperty
Farm
HistoryTransactional
ImageHeightImageOf
AerialView
Atrium
Attic
BackOfStructure
Balcony
Bar
Barn
ImageSizeDescription
SampleImageSizeDescriptionEnumValue
ImageWidthLongDescription
MediaCategory
AgentPhoto
BrandedVirtualTour
Document
FloorPlan
OfficeLogo
OfficePhoto
Photo
MediaHTML
MediaKey
MediaKeyNumericMediaModificationTimestamp
MediaObjectID
MediaStatus
SampleMediaStatusEnumValue
MediaType
Doc
Docx
Gif
Jpeg
Mov
Mp4
Mpeg
MediaURL
ModificationTimestamp
OrderOriginatingSystemID
OriginatingSystemMediaKey
OriginatingSystemName
Permission
PreferredPhotoYN
ResourceName
Contacts
Member
Office
Property
ResourceRecordID
ResourceRecordKey
ResourceRecordKeyNumericShortDescription
SourceSystemID
SourceSystemMediaKey
SourceSystemName
1
{
"ChangedByMemberID": "mollit",
"ChangedByMemberKey": "cillum ut id aute ex",
"ChangedByMemberKeyNumeric": 42,
"ClassName": "Land",
"ImageHeight": "42",
"ImageOf": "Lobby",
"ImageWidth": "42",
"LongDescription": "velit Duis magna",
"MediaCategory": "FloorPlan",
"MediaHTML": "sed",
"MediaKey": "amet officia anim dolore",
"MediaKeyNumeric": 42,
"MediaObjectID": "qui Excepteur anim",
"MediaStatus": "SampleMediaStatusEnumValue",
"MediaType": "Mpeg",
"MediaURL": "Ut esse incididunt",
"ModificationTimestamp": "1956-09-25T21:39:21.0Z",
"Permission": [
"Public",
"Vow",
"Private"
],
"SourceSystemID": "amet nostrud dolore",
"SourceSystemMediaKey": "anim Excepteur"
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
ChangedByMemberID
ChangedByMemberKey
ChangedByMemberKeyNumeric
ClassName
ImageHeight
ImageOf
ImageSizeDescription
MediaKey
key: MediaKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
MediaKey
key: MediaKey
New property values
ChangedByMemberID
ChangedByMemberKey
ChangedByMemberKeyNumericClassName
BusinessOpportunity
CommercialLease
CommercialSale
Contacts
CrossProperty
Farm
HistoryTransactional
ImageHeightImageOf
AerialView
Atrium
Attic
BackOfStructure
Balcony
Bar
Barn
ImageSizeDescription
SampleImageSizeDescriptionEnumValue
ImageWidthLongDescription
MediaCategory
AgentPhoto
BrandedVirtualTour
Document
FloorPlan
OfficeLogo
OfficePhoto
Photo
MediaHTML
MediaKeyNumericMediaModificationTimestamp
MediaObjectID
MediaStatus
SampleMediaStatusEnumValue
MediaType
Doc
Docx
Gif
Jpeg
Mov
Mp4
Mpeg
MediaURL
ModificationTimestamp
OrderOriginatingSystemID
OriginatingSystemMediaKey
OriginatingSystemName
Permission
PreferredPhotoYN
ResourceName
Contacts
Member
Office
Property
ResourceRecordID
ResourceRecordKey
ResourceRecordKeyNumericShortDescription
SourceSystemID
SourceSystemMediaKey
SourceSystemName
1
{
"SourceSystemMediaKey": "exercitation et ut officia"
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
MediaKey
key: MediaKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
ListingId
ListingId desc
ListingKey
ListingKey desc
ListingKeyNumeric
ListingKeyNumeric desc
ModificationTimestamp
$select
Select properties to be returned, see Select
ListingId
ListingKey
ListingKeyNumeric
ModificationTimestamp
RoomArea
RoomAreaSource
RoomAreaUnits
$expand
Expand related entities, see Expand
*
Listing
HistoryTransactional
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
ListingId
ListingKey
ListingKeyNumeric
ModificationTimestamp
RoomArea
RoomAreaSource
RoomAreaUnits
$expand
Expand related entities, see Expand
*
Listing
HistoryTransactional
RoomKey
key: RoomKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
RoomKey
key: RoomKey
New property values
ListingId
ListingKey
ListingKeyNumericModificationTimestamp
RoomAreaRoomAreaSource
Appraiser
Assessor
Builder
Estimated
Other
Owner
Plans
RoomAreaUnits
SquareFeet
SquareMeters
RoomDescription
RoomDimensions
RoomFeatures
RoomKeyNumericRoomLengthRoomLengthWidthUnits
Feet
Meters
RoomType
Basement
Bathroom
Bathroom1
Bathroom2
Bathroom3
Bathroom4
Bathroom5
RoomWidth1
{
"ListingKey": "anim mollit occaecat dolore aliqua",
"ModificationTimestamp": "1896-09-20T03:13:46.0Z",
"RoomAreaSource": "Estimated",
"RoomKeyNumeric": "42",
"RoomLength": 0,
"RoomLengthWidthUnits": "Feet",
"RoomWidth": 0
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
RoomKey
key: RoomKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
ListingId
ListingId desc
ListingKey
ListingKey desc
ListingKeyNumeric
ListingKeyNumeric desc
ModificationTimestamp
$select
Select properties to be returned, see Select
ListingId
ListingKey
ListingKeyNumeric
ModificationTimestamp
UnitTypeActualRent
UnitTypeBathsTotal
UnitTypeBedsTotal
$expand
Expand related entities, see Expand
*
Listing
HistoryTransactional
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
ListingId
ListingKey
ListingKeyNumeric
ModificationTimestamp
UnitTypeActualRent
UnitTypeBathsTotal
UnitTypeBedsTotal
$expand
Expand related entities, see Expand
*
Listing
HistoryTransactional
UnitTypeKey
key: UnitTypeKey
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
UnitTypeKey
key: UnitTypeKey
New property values
ListingId
ListingKey
ListingKeyNumericModificationTimestamp
UnitTypeActualRentUnitTypeBathsTotalUnitTypeBedsTotalUnitTypeDescription
UnitTypeFurnished
SampleUnitTypeFurnishedEnumValue
UnitTypeGarageAttachedYN
UnitTypeGarageSpacesUnitTypeKeyNumericUnitTypeProFormaUnitTypeTotalRentUnitTypeType
Apartments
Efficiency
FourBedroomOrMore
Loft
ManagersUnit
OneBedroom
Penthouse
UnitTypeUnitsTotal1
{
"ListingId": "esse fugiat",
"ListingKey": "dolor ullamco",
"ListingKeyNumeric": "42",
"ModificationTimestamp": "1927-07-20T16:07:18.0Z",
"UnitTypeActualRent": 0,
"UnitTypeBathsTotal": "42",
"UnitTypeBedsTotal": 42,
"UnitTypeDescription": "amet adipisicing velit quis laborum",
"UnitTypeFurnished": "SampleUnitTypeFurnishedEnumValue",
"UnitTypeGarageAttachedYN": true,
"UnitTypeGarageSpaces": 0,
"UnitTypeKeyNumeric": 42,
"UnitTypeProForma": 42,
"UnitTypeTotalRent": 0,
"UnitTypeType": "Studio",
"UnitTypeUnitsTotal": 42
}Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
UnitTypeKey
key: UnitTypeKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
FieldKey
FieldKey desc
ResourceName
ResourceName desc
FieldName
FieldName desc
DisplayName
$select
Select properties to be returned, see Select
FieldKey
ResourceName
FieldName
DisplayName
ModificationTimestamp
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
FieldKey
ResourceName
FieldName
DisplayName
ModificationTimestamp
FieldKey
key: FieldKey
1
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.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$top
Show only the first n items, see Paging - Top
$skip
Skip the first n items, see Paging - Skip
$search
Search items by search phrases, see Searching
$filter
Filter items by property values, see Filtering
$count
Include count of items, see Count
$orderby
Order items by property values, see Sorting
LookupKey
LookupKey desc
LookupName
LookupName desc
LookupValue
LookupValue desc
StandardLookupValue
$select
Select properties to be returned, see Select
LookupKey
LookupName
LookupValue
StandardLookupValue
LegacyODataValue
ModificationTimestamp
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
$select
Select properties to be returned, see Select
LookupKey
LookupName
LookupValue
StandardLookupValue
LegacyODataValue
ModificationTimestamp
LookupKey
key: LookupKey
1