Property
Get a list of Properties
get/odata/v1/Property
Query parameters
$selectstring
Selects which properties to include in the response.
$countboolean
Return, along with the results, the total number of records in the dataset. NOTE: There is a performance cost with this query option.
$filterstring
Filters the results, based on a Boolean condition.
$topstring
Returns only the first n results.
$skipstring
Skips the first n results.
$orderbystring
Sorts the results.
Response
OK
Example response
{
"@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.Property",
"value": [
{
"ListingKey": "12345",
"PropertySubType": "Business",
"DocumentsAvailable": [
"Floor Plan, Site Plan"
],
"LeaseAmount": 1000,
"LeaseAmountFrequency": "Monthly",
"BusinessType": [
"Agriculture, Forestry"
],
"LeasePerUnit": "Acres",
"PricePerUnit": "square feet",
"WaterBodyName": "WaterBodyName",
"View": [
"Ocean view"
],
"NumberOfBuildings": 1,
"NumberOfUnitsTotal": 45,
"LotFeatures": [
"Acreage"
],
"LotSizeArea": 1,
"LotSizeDimensions": "60 X 262",
"LotSizeUnits": "Acres",
"PoolFeatures": [
"On Ground Pool"
],
"RoadSurfaceType": [
"Paved road"
],
"CurrentUse": [
"Recreational"
],
"PossibleUse": [
"Agriculture - active"
],
"AnchorsCoTenants": "AnchorsCoTenant",
"FrontageLengthNumeric": 400,
"Appliances": [
"Dryer - Electric"
],
"OtherEquipment": [
"Unknown"
],
"TotalActualRent": 300,
"ExistingLeaseType": [
"Percentage"
],
"AssociationFee": 10,
"AssociationFeeFrequency": "Monthly",
"AssociationName": "AssociationName",
"AssociationFeeIncludes": [
"Management"
],
"OriginalEntryTimestamp": "\"2021-01-01T00:00:00.000Z\"",
"ModificationTimestamp": "\"2021-01-01T00:00:00.000Z\"",
"AvailabilityDate": "\"2021-01-01T00:00:00.000Z\"",
"ListingId": "00001",
"ListAgentNationalAssociationId": "00001",
"CoListAgentNationalAssociationId": "00001",
"CoListAgentNationalAssociationId2": "00001",
"CoListAgentNationalAssociationId3": "00001",
"InternetEntireListingDisplayYN": true,
"StatusChangeTimestamp": "\"2021-01-01T00:00:00.000Z\"",
"PublicRemarks": "PRIME COMMERCIAL LOCATION.",
"ListPrice": 800000,
"Inclusions": "Inclusions",
"ListOfficeKey": "ListOfficeKey",
"CoListOfficeKey": "CoListOfficeKey",
"CoListOfficeKey3": "CoListOfficeKey3",
"ListOfficeNationalAssociationId": "ListOfficeNationalAssociationId",
"CoListOfficeNationalAssociationId": "CoListOfficeNationalAssociationId",
"CoListOfficeNationalAssociationId2": "CoListOfficeNationalAssociationId2",
"CoListOfficeNationalAssociationId3": "CoListOfficeNationalAssociationId3",
"CoListAgentKey": "CoListAgentKey",
"CoListAgentKey2": "CoListAgentKey2",
"CoListAgentKey3": "CoListAgentKey3",
"ListAgentKey": "ListAgentKey",
"InternetAddressDisplayYN": true,
"PhotosChangeTimestamp": "\"2021-01-01T00:00:00.000Z\"",
"CommonInterest": "Business",
"ListAOR": "Fredericton",
"UnparsedAddress": "UnparsedAddress",
"PostalCode": "PostalCode",
"SubdivisionName": "SubdivisionName",
"StateOrProvince": "Ontario",
"StreetDirPrefix": "North",
"StreetDirSuffix": "South",
"StreetName": "StreetName",
"StreetNumber": "StreetNumber",
"UnitNumber": "123",
"Country": "Canada",
"City": "City",
"Directions": "Directions",
"CityRegion": "Parkdale",
"MapCoordinateVerifiedYN": true,
"GeocodeManualYN": true,
"ParkingTotal": 1,
"YearBuilt": 2003,
"BathroomsPartial": 1,
"BathroomsTotalInteger": 2,
"BedroomsTotal": 2,
"BuildingAreaTotal": 2000,
"BuildingAreaUnits": "square feet",
"BuildingFeatures": [
"Laundry Facility"
],
"AboveGradeFinishedArea": 100,
"AboveGradeFinishedAreaUnits": "Square Feet",
"AboveGradeFinishedAreaSource": "Appraiser",
"AboveGradeFinishedAreaMinimum": 100,
"AboveGradeFinishedAreaMaximum": 100,
"BelowGradeFinishedArea": 100,
"BelowGradeFinishedAreaUnits": "Square Feet",
"BelowGradeFinishedAreaSource": "Appraiser",
"BelowGradeFinishedAreaMinimum": 100,
"BelowGradeFinishedAreaMaximum": 100,
"LivingArea": 100,
"LivingAreaUnits": "Acres",
"LivingAreaSource": "Appraiser",
"LivingAreaMinimum": 100,
"LivingAreaMaximum": 100,
"FireplacesTotal": 1,
"FireplaceYN": true,
"FireplaceFeatures": [
"Conventional"
],
"ArchitecturalStyle": [
"Hillside Bungalow"
],
"Heating": [
"Heat Pump"
],
"FoundationDetails": [
"Wood"
],
"Basement": [
"Full"
],
"ExteriorFeatures": [
"Steel"
],
"Flooring": [
"Concrete"
],
"ParkingFeatures": [
"Attached Garage"
],
"Cooling": [
"Central air conditioning"
],
"PropertyCondition": [
"New"
],
"Roof": [
"Conventional"
],
"ConstructionMaterials": [
"Insulbrick"
],
"Rooms": [
{
"RoomKey": "12345",
"ListingId": "ListingId",
"ListingKey": "12345",
"ModificationTimestamp": "\"2021-01-01T00:00:00.000Z\"",
"RoomDescription": "RoomDescription",
"RoomDimensions": "RoomDimensions",
"RoomLength": 10,
"RoomLevel": "Second level",
"RoomWidth": 10,
"RoomLengthWidthUnits": "Square feet",
"RoomType": "Living room"
}
],
"Stories": 3,
"BedroomsAboveGrade": 3,
"BedroomsBelowGrade": 2,
"Zoning": "Zoning",
"ZoningDescription": "ZoningDescription",
"TaxAnnualAmount": 3000,
"TaxBlock": "TaxBlock",
"TaxLot": "TaxLot",
"TaxYear": 2021,
"StructureType": [
"House"
],
"ParcelNumber": "029-005-370",
"Utilities": [
"Sewer"
],
"IrrigationSource": [
"Flood"
],
"WaterSource": [
"Municipal water"
],
"Sewer": [
"No sewage system"
],
"Electric": [
"220v Entry",
"600 Amp Service"
],
"Media": [
{
"MediaKey": "MediaKey",
"LongDescription": "REALTOR.ca Logo",
"MediaURL": "https:///ddfcdn.realtor.ca/realtorlogo.png",
"ModificationTimestamp": "2019-08-24T14:15:22Z",
"Order": 1,
"PreferredPhotoYN": true,
"ResourceRecordId": "RealtorLogo.png",
"ResourceRecordKey": "1234",
"ResourceName": "Member",
"MediaCategory": "Photo"
}
]
}
],
"@odata.nextLink": "https://localhost:7051/odata/v1/DDF.Core.Entities.Property?skip=1"
}