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.

Get entities from Property

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

AboveGradeFinishedArea

AboveGradeFinishedArea desc

AboveGradeFinishedAreaSource

AboveGradeFinishedAreaSource desc

AboveGradeFinishedAreaUnits

AboveGradeFinishedAreaUnits desc

AccessCode

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

AboveGradeFinishedArea

AboveGradeFinishedAreaSource

AboveGradeFinishedAreaUnits

AccessCode

AccessibilityFeatures

AdditionalParcelsDescription

AdditionalParcelsYN

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

OriginatingSystem

BuyerAgent

BuyerOffice

CoBuyerAgent

CoBuyerOffice

CoListAgent

GET
/Property
1

Add new entity to Property

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/Property
1

Get entity from Property by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

AboveGradeFinishedArea

AboveGradeFinishedAreaSource

AboveGradeFinishedAreaUnits

AccessCode

AccessibilityFeatures

AdditionalParcelsDescription

AdditionalParcelsYN

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

OriginatingSystem

BuyerAgent

BuyerOffice

CoBuyerAgent

CoBuyerOffice

CoListAgent

Path Parameters

ListingKey

required, string, nullable, maximum length of 255

key: ListingKey

GET
/Property(':ListingKey')
1

Update entity in Property

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

ListingKey

required, string, nullable, maximum length of 255

key: ListingKey

Request Body

New property values

odata_context

optional, string

The requested url

AboveGradeFinishedArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

AboveGradeFinishedAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

AboveGradeFinishedAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

AccessCode

optional, string, nullable, maximum length of 25

AccessibilityFeatures

optional, array of strings

AdditionalParcelsDescription

optional, string, nullable, maximum length of 255

AdditionalParcelsYN

optional, boolean, nullable

AnchorsCoTenants

optional, string, nullable, maximum length of 1024

Appliances

optional, array of strings

ArchitecturalStyle

optional, array of strings

AssociationAmenities

optional, array of strings
AssociationFee
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
AssociationFee2
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

AssociationFee2Frequency

optional, string enum, nullable

Possible Enum Values

Annually

BiMonthly

BiWeekly

Daily

Monthly

OneTime

Quarterly

AssociationFeeFrequency

optional, string enum, nullable

Possible Enum Values

Annually

BiMonthly

BiWeekly

Daily

Monthly

OneTime

Quarterly

AssociationFeeIncludes

optional, array of strings

AssociationName

optional, string, nullable, maximum length of 50

AssociationName2

optional, string, nullable, maximum length of 50

AssociationPhone

optional, string, nullable, maximum length of 16

AssociationPhone2

optional, string, nullable, maximum length of 16

AssociationYN

optional, boolean, nullable

AttachedGarageYN

optional, boolean, nullable

AvailabilityDate

optional, string, nullable

Basement

optional, array of strings

BasementYN

optional, boolean, nullable
BathroomsFull
optional, nullable
BathroomsHalf
optional, nullable
BathroomsOneQuarter
optional, nullable
BathroomsPartial
optional, nullable
BathroomsThreeQuarter
optional, nullable
BathroomsTotalInteger
optional, nullable
BedroomsPossible
optional, nullable
BedroomsTotal
optional, nullable
BelowGradeFinishedArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

BelowGradeFinishedAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

BelowGradeFinishedAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

BodyType

optional, array of strings

BuilderModel

optional, string, nullable, maximum length of 50

BuilderName

optional, string, nullable, maximum length of 50

BuildingAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

BuildingAreaTotal
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

BuildingAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

BuildingFeatures

optional, array of strings

BuildingName

optional, string, nullable, maximum length of 50

BusinessName

optional, string, nullable, maximum length of 255

BusinessType

optional, array of strings

BuyerAgencyCompensation

optional, string, nullable, maximum length of 25

BuyerAgencyCompensationType

optional, string enum, nullable

Possible Enum Values

Dollars

Other

Percent

SeeRemarks

BuyerAgentAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

BuyerAgentDesignation

optional, array of strings

BuyerAgentDirectPhone

optional, string, nullable, maximum length of 16

BuyerAgentEmail

optional, string, nullable, maximum length of 80

BuyerAgentFax

optional, string, nullable, maximum length of 16

BuyerAgentFirstName

optional, string, nullable, maximum length of 50

BuyerAgentFullName

optional, string, nullable, maximum length of 150

BuyerAgentHomePhone

optional, string, nullable, maximum length of 16

BuyerAgentKey

optional, string, nullable, maximum length of 255
BuyerAgentKeyNumeric
optional, nullable

BuyerAgentLastName

optional, string, nullable, maximum length of 50

BuyerAgentMiddleName

optional, string, nullable, maximum length of 50

BuyerAgentMlsId

optional, string, nullable, maximum length of 25

BuyerAgentMobilePhone

optional, string, nullable, maximum length of 16

BuyerAgentNamePrefix

optional, string, nullable, maximum length of 10

BuyerAgentNameSuffix

optional, string, nullable, maximum length of 10

BuyerAgentOfficePhone

optional, string, nullable, maximum length of 16

BuyerAgentOfficePhoneExt

optional, string, nullable, maximum length of 10

BuyerAgentPager

optional, string, nullable, maximum length of 16

BuyerAgentPreferredPhone

optional, string, nullable, maximum length of 16

BuyerAgentPreferredPhoneExt

optional, string, nullable, maximum length of 10

BuyerAgentStateLicense

optional, string, nullable, maximum length of 50

BuyerAgentTollFreePhone

optional, string, nullable, maximum length of 16

BuyerAgentURL

optional, string, nullable, maximum length of 8000

BuyerAgentVoiceMail

optional, string, nullable, maximum length of 16

BuyerAgentVoiceMailExt

optional, string, nullable, maximum length of 10

BuyerFinancing

optional, array of strings

BuyerOfficeAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

BuyerOfficeEmail

optional, string, nullable, maximum length of 80

BuyerOfficeFax

optional, string, nullable, maximum length of 16

BuyerOfficeKey

optional, string, nullable, maximum length of 255
BuyerOfficeKeyNumeric
optional, nullable

BuyerOfficeMlsId

optional, string, nullable, maximum length of 25

BuyerOfficeName

optional, string, nullable, maximum length of 255

BuyerOfficePhone

optional, string, nullable, maximum length of 16

BuyerOfficePhoneExt

optional, string, nullable, maximum length of 10

BuyerOfficeURL

optional, string, nullable, maximum length of 8000

BuyerTeamKey

optional, string, nullable, maximum length of 255
BuyerTeamKeyNumeric
optional, nullable

BuyerTeamName

optional, string, nullable, maximum length of 50
CableTvExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

CancellationDate

optional, string, nullable
CapRate
optional, nullable, maximum value of 999.99, minimum value of -999.99
CarportSpaces
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

CarportYN

optional, boolean, nullable

CarrierRoute

optional, string, nullable, maximum length of 9

City

optional, string enum, nullable

Possible Enum Values

SampleCityEnumValue

CityRegion

optional, string, nullable, maximum length of 150

CloseDate

optional, string, nullable
ClosePrice
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

CoBuyerAgentAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

CoBuyerAgentDesignation

optional, array of strings

CoBuyerAgentDirectPhone

optional, string, nullable, maximum length of 16

CoBuyerAgentEmail

optional, string, nullable, maximum length of 80

CoBuyerAgentFax

optional, string, nullable, maximum length of 16

CoBuyerAgentFirstName

optional, string, nullable, maximum length of 50

CoBuyerAgentFullName

optional, string, nullable, maximum length of 150

CoBuyerAgentHomePhone

optional, string, nullable, maximum length of 16

CoBuyerAgentKey

optional, string, nullable, maximum length of 255
CoBuyerAgentKeyNumeric
optional, nullable

CoBuyerAgentLastName

optional, string, nullable, maximum length of 50

CoBuyerAgentMiddleName

optional, string, nullable, maximum length of 50

CoBuyerAgentMlsId

optional, string, nullable, maximum length of 25

CoBuyerAgentMobilePhone

optional, string, nullable, maximum length of 16

CoBuyerAgentNamePrefix

optional, string, nullable, maximum length of 10

CoBuyerAgentNameSuffix

optional, string, nullable, maximum length of 10

CoBuyerAgentOfficePhone

optional, string, nullable, maximum length of 16

CoBuyerAgentOfficePhoneExt

optional, string, nullable, maximum length of 10

CoBuyerAgentPager

optional, string, nullable, maximum length of 16

CoBuyerAgentPreferredPhone

optional, string, nullable, maximum length of 16

CoBuyerAgentPreferredPhoneExt

optional, string, nullable, maximum length of 10

CoBuyerAgentStateLicense

optional, string, nullable, maximum length of 50

CoBuyerAgentTollFreePhone

optional, string, nullable, maximum length of 16

CoBuyerAgentURL

optional, string, nullable, maximum length of 8000

CoBuyerAgentVoiceMail

optional, string, nullable, maximum length of 16

CoBuyerAgentVoiceMailExt

optional, string, nullable, maximum length of 10

CoBuyerOfficeAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

CoBuyerOfficeEmail

optional, string, nullable, maximum length of 80

CoBuyerOfficeFax

optional, string, nullable, maximum length of 16

CoBuyerOfficeKey

optional, string, nullable, maximum length of 255
CoBuyerOfficeKeyNumeric
optional, nullable

CoBuyerOfficeMlsId

optional, string, nullable, maximum length of 25

CoBuyerOfficeName

optional, string, nullable, maximum length of 255

CoBuyerOfficePhone

optional, string, nullable, maximum length of 16

CoBuyerOfficePhoneExt

optional, string, nullable, maximum length of 10

CoBuyerOfficeURL

optional, string, nullable, maximum length of 8000

CoListAgentAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

CoListAgentDesignation

optional, array of strings

CoListAgentDirectPhone

optional, string, nullable, maximum length of 16

CoListAgentEmail

optional, string, nullable, maximum length of 80

CoListAgentFax

optional, string, nullable, maximum length of 16

CoListAgentFirstName

optional, string, nullable, maximum length of 50

CoListAgentFullName

optional, string, nullable, maximum length of 150

CoListAgentHomePhone

optional, string, nullable, maximum length of 16

CoListAgentKey

optional, string, nullable, maximum length of 255
CoListAgentKeyNumeric
optional, nullable

CoListAgentLastName

optional, string, nullable, maximum length of 50

CoListAgentMiddleName

optional, string, nullable, maximum length of 50

CoListAgentMlsId

optional, string, nullable, maximum length of 25

CoListAgentMobilePhone

optional, string, nullable, maximum length of 16

CoListAgentNamePrefix

optional, string, nullable, maximum length of 10

CoListAgentNameSuffix

optional, string, nullable, maximum length of 10

CoListAgentOfficePhone

optional, string, nullable, maximum length of 16

CoListAgentOfficePhoneExt

optional, string, nullable, maximum length of 10

CoListAgentPager

optional, string, nullable, maximum length of 16

CoListAgentPreferredPhone

optional, string, nullable, maximum length of 16

CoListAgentPreferredPhoneExt

optional, string, nullable, maximum length of 10

CoListAgentStateLicense

optional, string, nullable, maximum length of 50

CoListAgentTollFreePhone

optional, string, nullable, maximum length of 16

CoListAgentURL

optional, string, nullable, maximum length of 8000

CoListAgentVoiceMail

optional, string, nullable, maximum length of 16

CoListAgentVoiceMailExt

optional, string, nullable, maximum length of 10

CoListOfficeAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

CoListOfficeEmail

optional, string, nullable, maximum length of 80

CoListOfficeFax

optional, string, nullable, maximum length of 16

CoListOfficeKey

optional, string, nullable, maximum length of 255
CoListOfficeKeyNumeric
optional, nullable

CoListOfficeMlsId

optional, string, nullable, maximum length of 25

CoListOfficeName

optional, string, nullable, maximum length of 255

CoListOfficePhone

optional, string, nullable, maximum length of 16

CoListOfficePhoneExt

optional, string, nullable, maximum length of 10

CoListOfficeURL

optional, string, nullable, maximum length of 8000

CommonInterest

optional, string enum, nullable

Possible Enum Values

CommunityApartment

Condominium

None

PlannedDevelopment

StockCooperative

Timeshare

CommonWalls

optional, array of strings

CommunityFeatures

optional, array of strings

Concessions

optional, string enum, nullable

Possible Enum Values

CallListingAgent

No

Yes

ConcessionsAmount
optional, nullable

ConcessionsComments

optional, string, nullable, maximum length of 200

ConstructionMaterials

optional, array of strings

ContinentRegion

optional, string, nullable, maximum length of 150

Contingency

optional, string, nullable, maximum length of 1024

ContingentDate

optional, string, nullable

ContractStatusChangeDate

optional, string, nullable

Cooling

optional, array of strings

CoolingYN

optional, boolean, nullable

CopyrightNotice

optional, string, nullable, maximum length of 500

Country

optional, string enum, nullable

Possible Enum Values

AD

AE

AF

AG

AI

AL

AM

CountryRegion

optional, string, nullable, maximum length of 150

CountyOrParish

optional, string enum, nullable

Possible Enum Values

SampleCountyOrParishEnumValue

CoveredSpaces
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

CropsIncludedYN

optional, boolean, nullable

CrossStreet

optional, string, nullable, maximum length of 50
CultivatedArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
CumulativeDaysOnMarket
optional, nullable

CurrentFinancing

optional, array of strings

CurrentUse

optional, array of strings

DOH1

optional, string, nullable, maximum length of 25

DOH2

optional, string, nullable, maximum length of 25

DOH3

optional, string, nullable, maximum length of 25
DaysOnMarket
optional, nullable

DevelopmentStatus

optional, array of strings

DirectionFaces

optional, string enum, nullable

Possible Enum Values

East

North

Northeast

Northwest

South

Southeast

Southwest

Directions

optional, string, nullable, maximum length of 1024

Disclaimer

optional, string, nullable, maximum length of 500

Disclosures

optional, array of strings

DistanceToBusComments

optional, string, nullable, maximum length of 255
DistanceToBusNumeric
optional, nullable

DistanceToBusUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToElectricComments

optional, string, nullable, maximum length of 255
DistanceToElectricNumeric
optional, nullable

DistanceToElectricUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToFreewayComments

optional, string, nullable, maximum length of 255
DistanceToFreewayNumeric
optional, nullable

DistanceToFreewayUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToGasComments

optional, string, nullable, maximum length of 255
DistanceToGasNumeric
optional, nullable

DistanceToGasUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToPhoneServiceComments

optional, string, nullable, maximum length of 255
DistanceToPhoneServiceNumeric
optional, nullable

DistanceToPhoneServiceUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToPlaceofWorshipComments

optional, string, nullable, maximum length of 255
DistanceToPlaceofWorshipNumeric
optional, nullable

DistanceToPlaceofWorshipUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToSchoolBusComments

optional, string, nullable, maximum length of 255
DistanceToSchoolBusNumeric
optional, nullable

DistanceToSchoolBusUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToSchoolsComments

optional, string, nullable, maximum length of 255
DistanceToSchoolsNumeric
optional, nullable

DistanceToSchoolsUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToSewerComments

optional, string, nullable, maximum length of 255
DistanceToSewerNumeric
optional, nullable

DistanceToSewerUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToShoppingComments

optional, string, nullable, maximum length of 255
DistanceToShoppingNumeric
optional, nullable

DistanceToShoppingUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToStreetComments

optional, string, nullable, maximum length of 255
DistanceToStreetNumeric
optional, nullable

DistanceToStreetUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DistanceToWaterComments

optional, string, nullable, maximum length of 255
DistanceToWaterNumeric
optional, nullable

DistanceToWaterUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

DocumentsAvailable

optional, array of strings

DocumentsChangeTimestamp

optional, string, nullable
DocumentsCount
optional, nullable

DoorFeatures

optional, array of strings

DualVariableCompensationYN

optional, boolean, nullable

Electric

optional, array of strings
ElectricExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

ElectricOnPropertyYN

optional, boolean, nullable

ElementarySchool

optional, string enum, nullable

Possible Enum Values

SampleElementarySchoolEnumValue

ElementarySchoolDistrict

optional, string enum, nullable

Possible Enum Values

SampleElementarySchoolDistrictEnumValue

Elevation
optional, nullable

ElevationUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

EntryLevel
optional, nullable

EntryLocation

optional, string, nullable, maximum length of 50

Exclusions

optional, string, nullable, maximum length of 1024

ExistingLeaseType

optional, array of strings

ExpirationDate

optional, string, nullable

ExteriorFeatures

optional, array of strings

FarmCreditServiceInclYN

optional, boolean, nullable

FarmLandAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

FarmLandAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

Fencing

optional, array of strings

FinancialDataSource

optional, array of strings

FireplaceFeatures

optional, array of strings

FireplaceYN

optional, boolean, nullable
FireplacesTotal
optional, nullable

Flooring

optional, array of strings
FoundationArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

FoundationDetails

optional, array of strings

FrontageLength

optional, string, nullable, maximum length of 255

FrontageType

optional, array of strings
FuelExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

Furnished

optional, string enum, nullable

Possible Enum Values

Furnished

Negotiable

Partially

Unfurnished

FurnitureReplacementExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
GarageSpaces
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

GarageYN

optional, boolean, nullable
GardenerExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

GrazingPermitsBlmYN

optional, boolean, nullable

GrazingPermitsForestServiceYN

optional, boolean, nullable

GrazingPermitsPrivateYN

optional, boolean, nullable

GreenBuildingVerificationType

optional, array of strings

GreenEnergyEfficient

optional, array of strings

GreenEnergyGeneration

optional, array of strings

GreenIndoorAirQuality

optional, array of strings

GreenLocation

optional, array of strings

GreenSustainability

optional, array of strings

GreenWaterConservation

optional, array of strings
GrossIncome
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
GrossScheduledIncome
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

HabitableResidenceYN

optional, boolean, nullable

Heating

optional, array of strings

HeatingYN

optional, boolean, nullable

HighSchool

optional, string enum, nullable

Possible Enum Values

SampleHighSchoolEnumValue

HighSchoolDistrict

optional, string enum, nullable

Possible Enum Values

SampleHighSchoolDistrictEnumValue

HomeWarrantyYN

optional, boolean, nullable

HorseAmenities

optional, array of strings

HorseYN

optional, boolean, nullable

HoursDaysOfOperation

optional, array of strings

HoursDaysOfOperationDescription

optional, string, nullable, maximum length of 255

Inclusions

optional, string, nullable, maximum length of 1024

IncomeIncludes

optional, array of strings
InsuranceExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

InteriorFeatures

optional, array of strings

InternetAddressDisplayYN

optional, boolean, nullable

InternetAutomatedValuationDisplayYN

optional, boolean, nullable

InternetConsumerCommentYN

optional, boolean, nullable

InternetEntireListingDisplayYN

optional, boolean, nullable

IrrigationSource

optional, array of strings
IrrigationWaterRightsAcres
optional, nullable

IrrigationWaterRightsYN

optional, boolean, nullable

LaborInformation

optional, array of strings
LandLeaseAmount
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

LandLeaseAmountFrequency

optional, string enum, nullable

Possible Enum Values

Annually

BiMonthly

BiWeekly

Daily

Monthly

OneTime

Quarterly

LandLeaseExpirationDate

optional, string, nullable

LandLeaseYN

optional, boolean, nullable
Latitude
optional, nullable, maximum value of 9999.99999999, minimum value of -9999.99999999

LaundryFeatures

optional, array of strings
LeasableArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

LeasableAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

LeaseAmount
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

LeaseAmountFrequency

optional, string enum, nullable

Possible Enum Values

Annually

BiMonthly

BiWeekly

Daily

Monthly

OneTime

Quarterly

LeaseAssignableYN

optional, boolean, nullable

LeaseConsideredYN

optional, boolean, nullable

LeaseExpiration

optional, string, nullable

LeaseRenewalCompensation

optional, array of strings

LeaseRenewalOptionYN

optional, boolean, nullable

LeaseTerm

optional, string enum, nullable

Possible Enum Values

MonthToMonth

Negotiable

None

Other

RenewalOption

ShortTermLease

SixMonths

Levels

optional, array of strings

License1

optional, string, nullable, maximum length of 25

License2

optional, string, nullable, maximum length of 25

License3

optional, string, nullable, maximum length of 25
LicensesExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

ListAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

ListAgentAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

ListAgentDesignation

optional, array of strings

ListAgentDirectPhone

optional, string, nullable, maximum length of 16

ListAgentEmail

optional, string, nullable, maximum length of 80

ListAgentFax

optional, string, nullable, maximum length of 16

ListAgentFirstName

optional, string, nullable, maximum length of 50

ListAgentFullName

optional, string, nullable, maximum length of 150

ListAgentHomePhone

optional, string, nullable, maximum length of 16

ListAgentKey

optional, string, nullable, maximum length of 255
ListAgentKeyNumeric
optional, nullable

ListAgentLastName

optional, string, nullable, maximum length of 50

ListAgentMiddleName

optional, string, nullable, maximum length of 50

ListAgentMlsId

optional, string, nullable, maximum length of 25

ListAgentMobilePhone

optional, string, nullable, maximum length of 16

ListAgentNamePrefix

optional, string, nullable, maximum length of 10

ListAgentNameSuffix

optional, string, nullable, maximum length of 10

ListAgentOfficePhone

optional, string, nullable, maximum length of 16

ListAgentOfficePhoneExt

optional, string, nullable, maximum length of 10

ListAgentPager

optional, string, nullable, maximum length of 16

ListAgentPreferredPhone

optional, string, nullable, maximum length of 16

ListAgentPreferredPhoneExt

optional, string, nullable, maximum length of 10

ListAgentStateLicense

optional, string, nullable, maximum length of 50

ListAgentTollFreePhone

optional, string, nullable, maximum length of 16

ListAgentURL

optional, string, nullable, maximum length of 8000

ListAgentVoiceMail

optional, string, nullable, maximum length of 16

ListAgentVoiceMailExt

optional, string, nullable, maximum length of 10

ListOfficeAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

ListOfficeEmail

optional, string, nullable, maximum length of 80

ListOfficeFax

optional, string, nullable, maximum length of 16

ListOfficeKey

optional, string, nullable, maximum length of 255
ListOfficeKeyNumeric
optional, nullable

ListOfficeMlsId

optional, string, nullable, maximum length of 25

ListOfficeName

optional, string, nullable, maximum length of 255

ListOfficePhone

optional, string, nullable, maximum length of 16

ListOfficePhoneExt

optional, string, nullable, maximum length of 10

ListOfficeURL

optional, string, nullable, maximum length of 8000
ListPrice
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
ListPriceLow
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

ListTeamKey

optional, string, nullable, maximum length of 255
ListTeamKeyNumeric
optional, nullable

ListTeamName

optional, string, nullable, maximum length of 50

ListingAgreement

optional, string enum, nullable

Possible Enum Values

ExclusiveAgency

ExclusiveRightToLease

ExclusiveRightToSell

ExclusiveRightWithException

Net

Open

Probate

ListingContractDate

optional, string, nullable

ListingId

optional, string, nullable, maximum length of 255
ListingKeyNumeric
optional, nullable

ListingService

optional, string enum, nullable

Possible Enum Values

EntryOnly

FullService

LimitedService

ListingTerms

optional, array of strings
LivingArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

LivingAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

LivingAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

LockBoxLocation

optional, string, nullable, maximum length of 255

LockBoxSerialNumber

optional, string, nullable, maximum length of 25

LockBoxType

optional, array of strings
Longitude
optional, nullable, maximum value of 9999.99999999, minimum value of -9999.99999999

LotDimensionsSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

GisCalculated

Measured

Other

LotFeatures

optional, array of strings
LotSizeAcres
optional, nullable
LotSizeArea
optional, nullable

LotSizeDimensions

optional, string, nullable, maximum length of 150

LotSizeSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

LotSizeSquareFeet
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

LotSizeUnits

optional, string enum, nullable

Possible Enum Values

Acres

SquareFeet

SquareMeters

MLSAreaMajor

optional, string enum, nullable

Possible Enum Values

SampleMLSAreaMajorEnumValue

MLSAreaMinor

optional, string enum, nullable

Possible Enum Values

SampleMLSAreaMinorEnumValue

MainLevelBathrooms
optional, nullable
MainLevelBedrooms
optional, nullable
MaintenanceExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

MajorChangeTimestamp

optional, string, nullable

MajorChangeType

optional, string enum, nullable

Possible Enum Values

Active

ActiveUnderContract

BackOnMarket

Canceled

Closed

Deleted

Expired

Make

optional, string, nullable, maximum length of 50
ManagerExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

MapCoordinate

optional, string, nullable, maximum length of 25

MapCoordinateSource

optional, string, nullable, maximum length of 25

MapURL

optional, string, nullable, maximum length of 8000

MiddleOrJuniorSchool

optional, string enum, nullable

Possible Enum Values

SampleMiddleOrJuniorSchoolEnumValue

MiddleOrJuniorSchoolDistrict

optional, string enum, nullable

Possible Enum Values

SampleMiddleOrJuniorSchoolDistrictEnumValue

MlsStatus

optional, string enum, nullable

Possible Enum Values

SampleMlsStatusEnumValue

MobileDimUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

MobileHomeRemainsYN

optional, boolean, nullable
MobileLength
optional, nullable
MobileWidth
optional, nullable

Model

optional, string, nullable, maximum length of 50

ModificationTimestamp

optional, string, nullable
NetOperatingIncome
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

NewConstructionYN

optional, boolean, nullable
NewTaxesExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
NumberOfBuildings
optional, nullable
NumberOfFullTimeEmployees
optional, nullable
NumberOfLots
optional, nullable
NumberOfPads
optional, nullable
NumberOfPartTimeEmployees
optional, nullable
NumberOfSeparateElectricMeters
optional, nullable
NumberOfSeparateGasMeters
optional, nullable
NumberOfSeparateWaterMeters
optional, nullable
NumberOfUnitsInCommunity
optional, nullable
NumberOfUnitsLeased
optional, nullable
NumberOfUnitsMoMo
optional, nullable
NumberOfUnitsTotal
optional, nullable
NumberOfUnitsVacant
optional, nullable

OccupantName

optional, string, nullable, maximum length of 50

OccupantPhone

optional, string, nullable, maximum length of 16

OccupantType

optional, string enum, nullable

Possible Enum Values

Owner

Tenant

Vacant

OffMarketDate

optional, string, nullable

OffMarketTimestamp

optional, string, nullable

OnMarketDate

optional, string, nullable

OnMarketTimestamp

optional, string, nullable
OpenParkingSpaces
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

OpenParkingYN

optional, boolean, nullable
OperatingExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

OperatingExpenseIncludes

optional, array of strings

OriginalEntryTimestamp

optional, string, nullable
OriginalListPrice
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

OriginatingSystemID

optional, string, nullable, maximum length of 25

OriginatingSystemKey

optional, string, nullable, maximum length of 255

OriginatingSystemName

optional, string, nullable, maximum length of 255

OtherEquipment

optional, array of strings
OtherExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

OtherParking

optional, string, nullable, maximum length of 1024

OtherStructures

optional, array of strings

OwnerName

optional, string, nullable, maximum length of 50

OwnerPays

optional, array of strings

OwnerPhone

optional, string, nullable, maximum length of 16

Ownership

optional, string, nullable, maximum length of 1024

OwnershipType

optional, string enum, nullable

Possible Enum Values

Corporation

Llc

Partnership

SoleProprietor

ParcelNumber

optional, string, nullable, maximum length of 50

ParkManagerName

optional, string, nullable, maximum length of 50

ParkManagerPhone

optional, string, nullable, maximum length of 16

ParkName

optional, string, nullable, maximum length of 50

ParkingFeatures

optional, array of strings
ParkingTotal
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
PastureArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

PatioAndPorchFeatures

optional, array of strings

PendingTimestamp

optional, string, nullable
PestControlExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

PetsAllowed

optional, array of strings

PhotosChangeTimestamp

optional, string, nullable
PhotosCount
optional, nullable
PoolExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

PoolFeatures

optional, array of strings

PoolPrivateYN

optional, boolean, nullable

Possession

optional, array of strings

PossibleUse

optional, array of strings

PostalCity

optional, string enum, nullable

Possible Enum Values

SamplePostalCityEnumValue

PostalCode

optional, string, nullable, maximum length of 10

PostalCodePlus4

optional, string, nullable, maximum length of 4

PowerProductionType

optional, array of strings
PreviousListPrice
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

PriceChangeTimestamp

optional, string, nullable

PrivateOfficeRemarks

optional, string, nullable, maximum length of 4000

PrivateRemarks

optional, string, nullable, maximum length of 4000
ProfessionalManagementExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

PropertyAttachedYN

optional, boolean, nullable

PropertyCondition

optional, array of strings

PropertySubType

optional, string enum, nullable

Possible Enum Values

Agriculture

Apartment

BoatSlip

Business

Cabin

Condominium

DeededParking

PropertyType

optional, string enum, nullable

Possible Enum Values

BusinessOpportunity

CommercialLease

CommercialSale

Farm

Land

ManufacturedInPark

Residential

PublicRemarks

optional, string, nullable, maximum length of 4000

PublicSurveyRange

optional, string, nullable, maximum length of 20

PublicSurveySection

optional, string, nullable, maximum length of 20

PublicSurveyTownship

optional, string, nullable, maximum length of 20

PurchaseContractDate

optional, string, nullable

RVParkingDimensions

optional, string, nullable, maximum length of 50
RangeArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

RentControlYN

optional, boolean, nullable

RentIncludes

optional, array of strings

RoadFrontageType

optional, array of strings

RoadResponsibility

optional, array of strings

RoadSurfaceType

optional, array of strings

Roof

optional, array of strings

RoomType

optional, array of strings
RoomsTotal
optional, nullable
SeatingCapacity
optional, nullable

SecurityFeatures

optional, array of strings

SeniorCommunityYN

optional, boolean, nullable

SerialU

optional, string, nullable, maximum length of 25

SerialX

optional, string, nullable, maximum length of 25

SerialXX

optional, string, nullable, maximum length of 25

Sewer

optional, array of strings
ShowingAdvanceNotice
optional, nullable

ShowingAttendedYN

optional, boolean, nullable

ShowingContactName

optional, string, nullable, maximum length of 40

ShowingContactPhone

optional, string, nullable, maximum length of 16

ShowingContactPhoneExt

optional, string, nullable, maximum length of 10

ShowingContactType

optional, array of strings

ShowingDays

optional, array of strings

ShowingEndTime

optional, string, nullable

ShowingInstructions

optional, string, nullable, maximum length of 4000

ShowingRequirements

optional, array of strings

ShowingStartTime

optional, string, nullable

SignOnPropertyYN

optional, boolean, nullable

Skirt

optional, array of strings

SourceSystemID

optional, string, nullable, maximum length of 25

SourceSystemKey

optional, string, nullable, maximum length of 255

SourceSystemName

optional, string, nullable, maximum length of 255

SpaFeatures

optional, array of strings

SpaYN

optional, boolean, nullable

SpecialLicenses

optional, array of strings

SpecialListingConditions

optional, array of strings

StandardStatus

optional, string enum, nullable

Possible Enum Values

Active

ActiveUnderContract

Canceled

Closed

ComingSoon

Delete

Expired

StateOrProvince

optional, string enum, nullable

Possible Enum Values

AB

AK

AL

AR

AZ

BC

CA

StateRegion

optional, string, nullable, maximum length of 150

StatusChangeTimestamp

optional, string, nullable
Stories
optional, nullable
StoriesTotal
optional, nullable

StreetAdditionalInfo

optional, string, nullable, maximum length of 50

StreetDirPrefix

optional, string enum, nullable

Possible Enum Values

E

N

NE

NW

S

SE

SW

StreetDirSuffix

optional, string enum, nullable

Possible Enum Values

E

N

NE

NW

S

SE

SW

StreetName

optional, string, nullable, maximum length of 50

StreetNumber

optional, string, nullable, maximum length of 25
StreetNumberNumeric
optional, nullable

StreetSuffix

optional, string enum, nullable

Possible Enum Values

SampleStreetSuffixEnumValue

StreetSuffixModifier

optional, string, nullable, maximum length of 25

StructureType

optional, array of strings

SubAgencyCompensation

optional, string, nullable, maximum length of 25

SubAgencyCompensationType

optional, string enum, nullable

Possible Enum Values

Dollars

Other

Percent

SeeRemarks

SubdivisionName

optional, string, nullable, maximum length of 50
SuppliesExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

SyndicateTo

optional, array of strings

SyndicationRemarks

optional, string, nullable, maximum length of 4000
TaxAnnualAmount
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
TaxAssessedValue
optional, nullable

TaxBlock

optional, string, nullable, maximum length of 25

TaxBookNumber

optional, string, nullable, maximum length of 25

TaxLegalDescription

optional, string, nullable, maximum length of 6000

TaxLot

optional, string, nullable, maximum length of 25

TaxMapNumber

optional, string, nullable, maximum length of 25
TaxOtherAnnualAssessmentAmount
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

TaxParcelLetter

optional, string, nullable, maximum length of 25

TaxStatusCurrent

optional, array of strings

TaxTract

optional, string, nullable, maximum length of 25
TaxYear
optional, nullable

TenantPays

optional, array of strings

Topography

optional, string, nullable, maximum length of 255
TotalActualRent
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

Township

optional, string, nullable, maximum length of 50

TransactionBrokerCompensation

optional, string, nullable, maximum length of 25

TransactionBrokerCompensationType

optional, string enum, nullable

Possible Enum Values

Dollars

Other

Percent

SeeRemarks

TrashExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

UnitNumber

optional, string, nullable, maximum length of 25

UnitTypeType

optional, array of strings

UnitsFurnished

optional, string enum, nullable

Possible Enum Values

AllUnits

None

VariesByUnit

UniversalPropertyId

optional, string, nullable, maximum length of 128

UniversalPropertySubId

optional, string, nullable, maximum length of 128

UnparsedAddress

optional, string, nullable, maximum length of 255

Utilities

optional, array of strings
VacancyAllowance
optional, nullable
VacancyAllowanceRate
optional, nullable, maximum value of 999.99, minimum value of -999.99

Vegetation

optional, array of strings

VideosChangeTimestamp

optional, string, nullable
VideosCount
optional, nullable

View

optional, array of strings

ViewYN

optional, boolean, nullable

VirtualTourURLBranded

optional, string, nullable, maximum length of 8000

VirtualTourURLUnbranded

optional, string, nullable, maximum length of 8000
WalkScore
optional, nullable

WaterBodyName

optional, string, nullable, maximum length of 50
WaterSewerExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

WaterSource

optional, array of strings

WaterfrontFeatures

optional, array of strings

WaterfrontYN

optional, boolean, nullable

WindowFeatures

optional, array of strings

WithdrawnDate

optional, string, nullable
WoodedArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
WorkmansCompensationExpense
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
YearBuilt
optional, nullable

YearBuiltDetails

optional, string, nullable, maximum length of 1024
YearBuiltEffective
optional, nullable

YearBuiltSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

PublicRecords

YearEstablished
optional, nullable
YearsCurrentOwner
optional, nullable

Zoning

optional, string, nullable, maximum length of 25

ZoningDescription

optional, string, nullable, maximum length of 255
PATCH
/Property(':ListingKey')
1
EXAMPLE BODY
{
  "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"
}

Delete entity from Property

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

ListingKey

required, string, nullable, maximum length of 255

key: ListingKey

DELETE
/Property(':ListingKey')
1

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.

Get entities from Member

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

JobTitle

JobTitle desc

LastLoginTimestamp

LastLoginTimestamp desc

MemberAOR

MemberAOR desc

MemberAORMlsId

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

JobTitle

LastLoginTimestamp

MemberAOR

MemberAORMlsId

MemberAORkey

MemberAORkeyNumeric

MemberAddress1

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Office

OriginatingSystem

SourceSystem

MemberSocialMedia

MemberOtherPhone

HistoryTransactional

GET
/Member
1

Add new entity to Member

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/Member
1

Get entity from Member by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

JobTitle

LastLoginTimestamp

MemberAOR

MemberAORMlsId

MemberAORkey

MemberAORkeyNumeric

MemberAddress1

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Office

OriginatingSystem

SourceSystem

MemberSocialMedia

MemberOtherPhone

HistoryTransactional

Path Parameters

MemberKey

required, string, nullable, maximum length of 255

key: MemberKey

GET
/Member(':MemberKey')
1

Update entity in Member

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

MemberKey

required, string, nullable, maximum length of 255

key: MemberKey

Request Body

New property values

odata_context

optional, string

The requested url

JobTitle

optional, string, nullable, maximum length of 50

LastLoginTimestamp

optional, string, nullable

MemberAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

MemberAORMlsId

optional, string, nullable, maximum length of 25

MemberAORkey

optional, string, nullable, maximum length of 255
MemberAORkeyNumeric
optional, nullable

MemberAddress1

optional, string, nullable, maximum length of 50

MemberAddress2

optional, string, nullable, maximum length of 50

MemberAssociationComments

optional, string, nullable, maximum length of 500

MemberCarrierRoute

optional, string, nullable, maximum length of 9

MemberCity

optional, string, nullable, maximum length of 50

MemberCountry

optional, string enum, nullable

Possible Enum Values

AD

AE

AF

AG

AI

AL

AM

MemberCountyOrParish

optional, string enum, nullable

Possible Enum Values

SampleCountyOrParishEnumValue

MemberDesignation

optional, array of strings

MemberDirectPhone

optional, string, nullable, maximum length of 16

MemberEmail

optional, string, nullable, maximum length of 80

MemberFax

optional, string, nullable, maximum length of 16

MemberFirstName

optional, string, nullable, maximum length of 50

MemberFullName

optional, string, nullable, maximum length of 150

MemberHomePhone

optional, string, nullable, maximum length of 16

MemberIsAssistantTo

optional, string, nullable, maximum length of 50
MemberKeyNumeric
optional, nullable

MemberLanguages

optional, array of strings

MemberLastName

optional, string, nullable, maximum length of 50

MemberLoginId

optional, string, nullable, maximum length of 25

MemberMiddleName

optional, string, nullable, maximum length of 50

MemberMlsAccessYN

optional, boolean, nullable

MemberMlsId

optional, string, nullable, maximum length of 25

MemberMlsSecurityClass

optional, string enum, nullable

Possible Enum Values

SampleMemberMlsSecurityClassEnumValue

MemberMobilePhone

optional, string, nullable, maximum length of 16

MemberNamePrefix

optional, string, nullable, maximum length of 10

MemberNameSuffix

optional, string, nullable, maximum length of 10

MemberNationalAssociationId

optional, string, nullable, maximum length of 25

MemberNickname

optional, string, nullable, maximum length of 50

MemberOfficePhone

optional, string, nullable, maximum length of 16

MemberOfficePhoneExt

optional, string, nullable, maximum length of 10

MemberOtherPhoneType

optional, string enum, nullable

Possible Enum Values

Direct

Fax

First

Home

Mobile

Modem

Office

MemberPager

optional, string, nullable, maximum length of 16

MemberPassword

optional, string, nullable, maximum length of 25

MemberPhoneTTYTDD

optional, string, nullable, maximum length of 16

MemberPostalCode

optional, string, nullable, maximum length of 10

MemberPostalCodePlus4

optional, string, nullable, maximum length of 4

MemberPreferredPhone

optional, string, nullable, maximum length of 16

MemberPreferredPhoneExt

optional, string, nullable, maximum length of 10

MemberStateLicense

optional, string, nullable, maximum length of 50

MemberStateLicenseState

optional, string enum, nullable

Possible Enum Values

AB

AK

AL

AR

AZ

BC

CA

MemberStateOrProvince

optional, string enum, nullable

Possible Enum Values

AB

AK

AL

AR

AZ

BC

CA

MemberStatus

optional, string enum, nullable

Possible Enum Values

Active

Inactive

MemberTollFreePhone

optional, string, nullable, maximum length of 16

MemberType

optional, string enum, nullable

Possible Enum Values

Assistant

AssociationStaff

DesignatedRealtorAppraiser

DesignatedRealtorParticipant

LicensedAssistant

MlsOnlyAppraiser

MlsOnlyBroker

MemberVoiceMail

optional, string, nullable, maximum length of 16

MemberVoiceMailExt

optional, string, nullable, maximum length of 10

ModificationTimestamp

optional, string, nullable

OfficeKey

optional, string, nullable, maximum length of 255
OfficeKeyNumeric
optional, nullable

OfficeMlsId

optional, string, nullable, maximum length of 25

OfficeName

optional, string, nullable, maximum length of 255

OriginalEntryTimestamp

optional, string, nullable

OriginatingSystemID

optional, string, nullable, maximum length of 25

OriginatingSystemMemberKey

optional, string, nullable, maximum length of 255

OriginatingSystemName

optional, string, nullable, maximum length of 255

SocialMediaType

optional, string enum, nullable

Possible Enum Values

Blog

Digg

Facebook

FacebookMessenger

Googleplus

iMessage

Instagram

SourceSystemID

optional, string, nullable, maximum length of 25

SourceSystemMemberKey

optional, string, nullable, maximum length of 255

SourceSystemName

optional, string, nullable, maximum length of 255

SyndicateTo

optional, array of strings
PATCH
/Member(':MemberKey')
1
EXAMPLE BODY
{
  "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"
  ]
}

Delete entity from Member

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

MemberKey

required, string, nullable, maximum length of 255

key: MemberKey

DELETE
/Member(':MemberKey')
1

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.

Get entities from Office

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

FranchiseAffiliation

FranchiseAffiliation desc

IDXOfficeParticipationYN

IDXOfficeParticipationYN desc

MainOfficeKey

MainOfficeKey desc

MainOfficeKeyNumeric

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

FranchiseAffiliation

IDXOfficeParticipationYN

MainOfficeKey

MainOfficeKeyNumeric

MainOfficeMlsId

ModificationTimestamp

OfficeAOR

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

MainOffice

OfficeBroker

OfficeManager

OriginatingSystem

SourceSystem

HistoryTransactional

GET
/Office
1

Add new entity to Office

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/Office
1

Get entity from Office by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

FranchiseAffiliation

IDXOfficeParticipationYN

MainOfficeKey

MainOfficeKeyNumeric

MainOfficeMlsId

ModificationTimestamp

OfficeAOR

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

MainOffice

OfficeBroker

OfficeManager

OriginatingSystem

SourceSystem

HistoryTransactional

Path Parameters

OfficeKey

required, string, nullable, maximum length of 255

key: OfficeKey

GET
/Office(':OfficeKey')
1

Update entity in Office

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

OfficeKey

required, string, nullable, maximum length of 255

key: OfficeKey

Request Body

New property values

FranchiseAffiliation

optional, string, nullable, maximum length of 50

IDXOfficeParticipationYN

optional, boolean, nullable

MainOfficeKey

optional, string, nullable, maximum length of 255
MainOfficeKeyNumeric
optional, nullable

MainOfficeMlsId

optional, string, nullable, maximum length of 25

ModificationTimestamp

optional, string, nullable

OfficeAOR

optional, string enum, nullable

Possible Enum Values

SampleAOREnumValue

OfficeAORMlsId

optional, string, nullable, maximum length of 25

OfficeAORkey

optional, string, nullable, maximum length of 255
OfficeAORkeyNumeric
optional, nullable

OfficeAddress1

optional, string, nullable, maximum length of 50

OfficeAddress2

optional, string, nullable, maximum length of 50

OfficeAssociationComments

optional, string, nullable, maximum length of 500

OfficeBranchType

optional, string enum, nullable

Possible Enum Values

Branch

Main

StandAlone

OfficeBrokerKey

optional, string, nullable, maximum length of 255
OfficeBrokerKeyNumeric
optional, nullable

OfficeBrokerMlsId

optional, string, nullable, maximum length of 25

OfficeCity

optional, string, nullable, maximum length of 50

OfficeCorporateLicense

optional, string, nullable, maximum length of 50

OfficeCountyOrParish

optional, string enum, nullable

Possible Enum Values

SampleCountyOrParishEnumValue

OfficeEmail

optional, string, nullable, maximum length of 80

OfficeFax

optional, string, nullable, maximum length of 16
OfficeKeyNumeric
optional, nullable

OfficeManagerKey

optional, string, nullable, maximum length of 255
OfficeManagerKeyNumeric
optional, nullable

OfficeManagerMlsId

optional, string, nullable, maximum length of 25

OfficeMlsId

optional, string, nullable, maximum length of 25

OfficeName

optional, string, nullable, maximum length of 255

OfficeNationalAssociationId

optional, string, nullable, maximum length of 25

OfficePhone

optional, string, nullable, maximum length of 16

OfficePhoneExt

optional, string, nullable, maximum length of 10

OfficePostalCode

optional, string, nullable, maximum length of 10

OfficePostalCodePlus4

optional, string, nullable, maximum length of 4

OfficeStateOrProvince

optional, string enum, nullable

Possible Enum Values

AB

AK

AL

AR

AZ

BC

CA

OfficeStatus

optional, string enum, nullable

Possible Enum Values

Active

Inactive

OfficeType

optional, string enum, nullable

Possible Enum Values

Affiliate

Appraiser

Association

Mls

MlsOnlyBranch

MlsOnlyFirm

MlsOnlyOffice

OriginalEntryTimestamp

optional, string, nullable

OriginatingSystemID

optional, string, nullable, maximum length of 25

OriginatingSystemName

optional, string, nullable, maximum length of 255

OriginatingSystemOfficeKey

optional, string, nullable, maximum length of 255

SocialMediaType

optional, string enum, nullable

Possible Enum Values

Blog

Digg

Facebook

FacebookMessenger

Googleplus

iMessage

Instagram

SourceSystemID

optional, string, nullable, maximum length of 25

SourceSystemName

optional, string, nullable, maximum length of 255

SourceSystemOfficeKey

optional, string, nullable, maximum length of 255

SyndicateAgentOption

optional, string enum, nullable

Possible Enum Values

SampleSyndicateAgentOptionEnumValue

SyndicateTo

optional, array of strings
PATCH
/Office(':OfficeKey')
1
EXAMPLE BODY
{}

Delete entity from Office

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

OfficeKey

required, string, nullable, maximum length of 255

key: OfficeKey

DELETE
/Office(':OfficeKey')
1

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.

Get entities from Media

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

ChangedByMemberID

ChangedByMemberID desc

ChangedByMemberKey

ChangedByMemberKey desc

ChangedByMemberKeyNumeric

ChangedByMemberKeyNumeric desc

ClassName

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ChangedByMemberID

ChangedByMemberKey

ChangedByMemberKeyNumeric

ClassName

ImageHeight

ImageOf

ImageSizeDescription

GET
/Media
1

Add new entity to Media

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Request Body

New entity

ChangedByMemberID

optional, string, nullable, maximum length of 25

ChangedByMemberKey

optional, string, nullable, maximum length of 255
ChangedByMemberKeyNumeric
optional, nullable

ClassName

optional, string enum, nullable

Possible Enum Values

BusinessOpportunity

CommercialLease

CommercialSale

Contacts

CrossProperty

Farm

HistoryTransactional

ImageHeight
optional, nullable

ImageOf

optional, string enum, nullable

Possible Enum Values

AerialView

Atrium

Attic

BackOfStructure

Balcony

Bar

Barn

ImageSizeDescription

optional, string enum, nullable

Possible Enum Values

SampleImageSizeDescriptionEnumValue

ImageWidth
optional, nullable

LongDescription

optional, string, nullable, maximum length of 1024

MediaCategory

optional, string enum, nullable

Possible Enum Values

AgentPhoto

BrandedVirtualTour

Document

FloorPlan

OfficeLogo

OfficePhoto

Photo

MediaHTML

optional, string, nullable, maximum length of 8500

MediaKey

required, string, nullable, maximum length of 255
MediaKeyNumeric
optional, nullable

MediaModificationTimestamp

optional, string, nullable

MediaObjectID

optional, string, nullable, maximum length of 255

MediaStatus

optional, string enum, nullable

Possible Enum Values

SampleMediaStatusEnumValue

MediaType

optional, string enum, nullable

Possible Enum Values

Doc

Docx

Gif

Jpeg

Mov

Mp4

Mpeg

MediaURL

optional, string, nullable, maximum length of 8000

ModificationTimestamp

optional, string, nullable
Order
optional, nullable

OriginatingSystemID

optional, string, nullable, maximum length of 25

OriginatingSystemMediaKey

optional, string, nullable, maximum length of 255

OriginatingSystemName

optional, string, nullable, maximum length of 255

Permission

optional, array of strings

PreferredPhotoYN

optional, boolean, nullable

ResourceName

optional, string enum, nullable

Possible Enum Values

Contacts

Member

Office

Property

ResourceRecordID

optional, string, nullable, maximum length of 255

ResourceRecordKey

optional, string, nullable, maximum length of 255
ResourceRecordKeyNumeric
optional, nullable

ShortDescription

optional, string, nullable, maximum length of 50

SourceSystemID

optional, string, nullable, maximum length of 25

SourceSystemMediaKey

optional, string, nullable, maximum length of 255

SourceSystemName

optional, string, nullable, maximum length of 255
POST
/Media
1
EXAMPLE BODY
{
  "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"
}

Get entity from Media by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ChangedByMemberID

ChangedByMemberKey

ChangedByMemberKeyNumeric

ClassName

ImageHeight

ImageOf

ImageSizeDescription

Path Parameters

MediaKey

required, string, nullable, maximum length of 255

key: MediaKey

GET
/Media(':MediaKey')
1

Update entity in Media

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

MediaKey

required, string, nullable, maximum length of 255

key: MediaKey

Request Body

New property values

ChangedByMemberID

optional, string, nullable, maximum length of 25

ChangedByMemberKey

optional, string, nullable, maximum length of 255
ChangedByMemberKeyNumeric
optional, nullable

ClassName

optional, string enum, nullable

Possible Enum Values

BusinessOpportunity

CommercialLease

CommercialSale

Contacts

CrossProperty

Farm

HistoryTransactional

ImageHeight
optional, nullable

ImageOf

optional, string enum, nullable

Possible Enum Values

AerialView

Atrium

Attic

BackOfStructure

Balcony

Bar

Barn

ImageSizeDescription

optional, string enum, nullable

Possible Enum Values

SampleImageSizeDescriptionEnumValue

ImageWidth
optional, nullable

LongDescription

optional, string, nullable, maximum length of 1024

MediaCategory

optional, string enum, nullable

Possible Enum Values

AgentPhoto

BrandedVirtualTour

Document

FloorPlan

OfficeLogo

OfficePhoto

Photo

MediaHTML

optional, string, nullable, maximum length of 8500
MediaKeyNumeric
optional, nullable

MediaModificationTimestamp

optional, string, nullable

MediaObjectID

optional, string, nullable, maximum length of 255

MediaStatus

optional, string enum, nullable

Possible Enum Values

SampleMediaStatusEnumValue

MediaType

optional, string enum, nullable

Possible Enum Values

Doc

Docx

Gif

Jpeg

Mov

Mp4

Mpeg

MediaURL

optional, string, nullable, maximum length of 8000

ModificationTimestamp

optional, string, nullable
Order
optional, nullable

OriginatingSystemID

optional, string, nullable, maximum length of 25

OriginatingSystemMediaKey

optional, string, nullable, maximum length of 255

OriginatingSystemName

optional, string, nullable, maximum length of 255

Permission

optional, array of strings

PreferredPhotoYN

optional, boolean, nullable

ResourceName

optional, string enum, nullable

Possible Enum Values

Contacts

Member

Office

Property

ResourceRecordID

optional, string, nullable, maximum length of 255

ResourceRecordKey

optional, string, nullable, maximum length of 255
ResourceRecordKeyNumeric
optional, nullable

ShortDescription

optional, string, nullable, maximum length of 50

SourceSystemID

optional, string, nullable, maximum length of 25

SourceSystemMediaKey

optional, string, nullable, maximum length of 255

SourceSystemName

optional, string, nullable, maximum length of 255
PATCH
/Media(':MediaKey')
1
EXAMPLE BODY
{
  "SourceSystemMediaKey": "exercitation et ut officia"
}

Delete entity from Media

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

MediaKey

required, string, nullable, maximum length of 255

key: MediaKey

DELETE
/Media(':MediaKey')
1

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.

Get entities from PropertyRooms

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

ListingId

ListingId desc

ListingKey

ListingKey desc

ListingKeyNumeric

ListingKeyNumeric desc

ModificationTimestamp

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ListingId

ListingKey

ListingKeyNumeric

ModificationTimestamp

RoomArea

RoomAreaSource

RoomAreaUnits

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Listing

HistoryTransactional

GET
/PropertyRooms
1

Add new entity to PropertyRooms

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/PropertyRooms
1

Get entity from PropertyRooms by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ListingId

ListingKey

ListingKeyNumeric

ModificationTimestamp

RoomArea

RoomAreaSource

RoomAreaUnits

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Listing

HistoryTransactional

Path Parameters

RoomKey

required, string, nullable, maximum length of 255

key: RoomKey

GET
/PropertyRooms(':RoomKey')
1

Update entity in PropertyRooms

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

RoomKey

required, string, nullable, maximum length of 255

key: RoomKey

Request Body

New property values

ListingId

optional, string, nullable, maximum length of 255

ListingKey

optional, string, nullable, maximum length of 255
ListingKeyNumeric
optional, nullable

ModificationTimestamp

optional, string, nullable
RoomArea
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

RoomAreaSource

optional, string enum, nullable

Possible Enum Values

Appraiser

Assessor

Builder

Estimated

Other

Owner

Plans

RoomAreaUnits

optional, string enum, nullable

Possible Enum Values

SquareFeet

SquareMeters

RoomDescription

optional, string, nullable, maximum length of 1024

RoomDimensions

optional, string, nullable, maximum length of 50

RoomFeatures

optional, array of strings
RoomKeyNumeric
optional, nullable
RoomLength
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

RoomLengthWidthUnits

optional, string enum, nullable

Possible Enum Values

Feet

Meters

RoomType

optional, string enum, nullable

Possible Enum Values

Basement

Bathroom

Bathroom1

Bathroom2

Bathroom3

Bathroom4

Bathroom5

RoomWidth
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
PATCH
/PropertyRooms(':RoomKey')
1
EXAMPLE BODY
{
  "ListingKey": "anim mollit occaecat dolore aliqua",
  "ModificationTimestamp": "1896-09-20T03:13:46.0Z",
  "RoomAreaSource": "Estimated",
  "RoomKeyNumeric": "42",
  "RoomLength": 0,
  "RoomLengthWidthUnits": "Feet",
  "RoomWidth": 0
}

Delete entity from PropertyRooms

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

RoomKey

required, string, nullable, maximum length of 255

key: RoomKey

DELETE
/PropertyRooms(':RoomKey')
1

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.

Get entities from PropertyUnitTypes

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

ListingId

ListingId desc

ListingKey

ListingKey desc

ListingKeyNumeric

ListingKeyNumeric desc

ModificationTimestamp

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ListingId

ListingKey

ListingKeyNumeric

ModificationTimestamp

UnitTypeActualRent

UnitTypeBathsTotal

UnitTypeBedsTotal

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Listing

HistoryTransactional

GET
/PropertyUnitTypes
1

Add new entity to PropertyUnitTypes

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST
/PropertyUnitTypes
1

Get entity from PropertyUnitTypes by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

ListingId

ListingKey

ListingKeyNumeric

ModificationTimestamp

UnitTypeActualRent

UnitTypeBathsTotal

UnitTypeBedsTotal

$expand

optional, array of strings, items must be unique

Expand related entities, see Expand

Possible Enum Values

*

Listing

HistoryTransactional

Path Parameters

UnitTypeKey

required, string, nullable, maximum length of 255

key: UnitTypeKey

GET
/PropertyUnitTypes(':UnitTypeKey')
1

Update entity in PropertyUnitTypes

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

UnitTypeKey

required, string, nullable, maximum length of 255

key: UnitTypeKey

Request Body

New property values

ListingId

optional, string, nullable, maximum length of 255

ListingKey

optional, string, nullable, maximum length of 255
ListingKeyNumeric
optional, nullable

ModificationTimestamp

optional, string, nullable
UnitTypeActualRent
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
UnitTypeBathsTotal
optional, nullable
UnitTypeBedsTotal
optional, nullable

UnitTypeDescription

optional, string, nullable, maximum length of 1024

UnitTypeFurnished

optional, string enum, nullable

Possible Enum Values

SampleUnitTypeFurnishedEnumValue

UnitTypeGarageAttachedYN

optional, boolean, nullable
UnitTypeGarageSpaces
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99
UnitTypeKeyNumeric
optional, nullable
UnitTypeProForma
optional, nullable
UnitTypeTotalRent
optional, nullable, maximum value of 999999999999.99, minimum value of -999999999999.99

UnitTypeType

optional, string enum, nullable

Possible Enum Values

Apartments

Efficiency

FourBedroomOrMore

Loft

ManagersUnit

OneBedroom

Penthouse

UnitTypeUnitsTotal
optional, nullable
PATCH
/PropertyUnitTypes(':UnitTypeKey')
1
EXAMPLE BODY
{
  "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
}

Delete entity from PropertyUnitTypes

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

UnitTypeKey

required, string, nullable, maximum length of 255

key: UnitTypeKey

DELETE
/PropertyUnitTypes(':UnitTypeKey')
1

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.

Get entities from Field

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

FieldKey

FieldKey desc

ResourceName

ResourceName desc

FieldName

FieldName desc

DisplayName

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

FieldKey

ResourceName

FieldName

DisplayName

ModificationTimestamp

GET
/Field
1

Get entity from Field by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

FieldKey

ResourceName

FieldName

DisplayName

ModificationTimestamp

Path Parameters

FieldKey

required, string, nullable

key: FieldKey

GET
/Field(':FieldKey')
1

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.

Get entities from Lookup

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$top

optional, integer, minimum value of 0

Show only the first n items, see Paging - Top

$skip

optional, integer, minimum value of 0

Skip the first n items, see Paging - Skip

$search

optional, string

Search items by search phrases, see Searching

$filter

optional, string

Filter items by property values, see Filtering

$count

optional, boolean

Include count of items, see Count

$orderby

optional, array of strings, items must be unique

Order items by property values, see Sorting

Possible Enum Values

LookupKey

LookupKey desc

LookupName

LookupName desc

LookupValue

LookupValue desc

StandardLookupValue

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

LookupKey

LookupName

LookupValue

StandardLookupValue

LegacyODataValue

ModificationTimestamp

GET
/Lookup
1

Get entity from Lookup by key

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

$select

optional, array of strings, items must be unique

Select properties to be returned, see Select

Possible Enum Values

LookupKey

LookupName

LookupValue

StandardLookupValue

LegacyODataValue

ModificationTimestamp

Path Parameters

LookupKey

required, string, nullable

key: LookupKey

GET
/Lookup(':LookupKey')
1