Datafiniti API

The Datafiniti Developer Hub

Welcome to the Datafiniti Developer Hub. Here you'll find comprehensive guides and documentation to help you start using the Datafiniti API as quickly as possible. Let's get some data!

Get Started    

Property Data Schema

The property data schema below lists all available fields in a property record. Note that actual propertyrecords (actually, most of them) may not have every field present.

Field Name
Example Value (in JSON)
Description

address

"address": "7206 Walling Ln"

The physical street address for this property.
Field type: text

availableDates

"availableDates": "[
  {
    "dateSeen": [
      "2017-03-16T00:00:00Z"
    ],
    "endDate": "2017-02-16T00:00:00Z",
    "sourceURLs": [
      "http://www.booking.com/hotel/ru/konnogvardeyskyapartment.html"
    ],
    "startDate": "2017-02-16T00:00:00Z"
  }
]

A list of dates this property is available (typically for rent). Each availability contains:
Field type: nested

  • dateSeen: A list of dates when this availability was seen.
    Field type: date

  • endDate: The ending date for the property's availability.
    Field type: date

  • sourceURLs: A list of source URLs where this availability was seen.
    Field type: keyword

  • startDate: The starting date for the property's availability.
    Field type: date

brokers

"brokers": [
  {
    "agent": "Frances Zuckerman",
    "company": "Fillmore",
    "dateSeen": "2017-01-17T09:47:16Z",
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "3214561234"
    ]
  }
]

A list of brokers that have represented this property over time. Each broker may contain:
Field type: nested

  • agent: The name of the real estate agent representing this property.
    Field type: text

  • company: The company this agent works for (or the company representing this property).
    Field type: text

  • dateSeen: The date this agent/company was seen representing the property.
    Field type: date

  • emails: A list of email addresses associated with the agent or company.
    Field type: keyword

  • phones: A phone number associated with the agent or company.
    Field type: keyword

  • websites: A list of websites associated with the agent or company.
    Field type: keyword

buildingName

"buildingName":"Castle Beach Club"

The name of the building where this property is located. This field is specific to apartments, condos, and similar property types.
Field type: text

city

"city": "Dallas"

The city where the property is located.
Field type: text

country

"country": "US"

The two-letter country code for the business location's country.
Field type: text

dateAdded

"dateAdded": "2017-01-08T19:12:13Z"

The date this property was first added to the property database.
Field type: date

dateUpdated

"dateUpdated": "2017-01-08T19:12:13Z"

The most recent date this property was updated or seen by our system.
Field type: date

deposits

"deposits": [
  {
    "amount": 104,
    "currency": "USD",
    "dateSeen": [
      "2016-08-07T18:07:05Z"
    ],
    "sourceURLs": [
      "https://www.airbnb.com/rooms/13843905"
    ]
  }
]

A list of deposit fees that have been seen for this property. Each deposit contains:
Field type: nested

  • amount: The fee amount.
    Field type: float

  • currency: The currency for the amount.
    Field type: keyword

  • dateSeen: A list of dates this deposit fee was seen.
    Field type: date

  • sourceURLs: A list of source URLs where this deposit fee was seen.
    Field type: keyword

descriptions

"descriptions": [
  {
    "dateSeen": "2016-08-07T18:07:05Z",
    "sourceURLs": [   "http://streeteasy.com/sale/1183869"
    ],
    "value": "charming starter home priced to sell. full finished basement with bath and with separate entrance."
  }
]

A list of descriptions for this property from various sources. Each description contains:
Field type: nested

  • dateSeen: The date when this description has been seen for this property.
    Field type: date

  • sourceURLs: A list of source URLs where this specific description was seen.
    Field type: keyword

  • value: A unique description for this property.
    Field type: text

domains

"domains": [
""www.airbnb.com"
]

A list of each unique domain found in the sourceURLs field.
Field type: domain

features

"features": [
  {
    "key": "Community District",
    "value": [
      "318"
    ]
  }              
]

A list of features associated with this property. The feature list can be collected from specific feature sections available on listings for this property. It can also serve as a catch-all field for miscellaneous characteristics of this property that don't make sense to include as top-level fields.
Field type: nested

Each feature contains:

  • key: A label for this feature.
    Field type: text

  • value: A list of possible values for this feature.
    Field type: text

fees

"fees": [
  {
    "amountMax": 11,
    "amountMin": 11,
    "currency": "USD",
    "dateSeen": [
      "2016-08-07T18:07:05Z"
    ],
    "sourceURLs": [
      "https://www.airbnb.com/rooms/13843905"
     ],
     "type": "Cleaning Fee"
   }
]

A list of various fees that have been seen for this property. Each fee will contain:
Field type: text

  • amountMax: The minimum fee value listed.
    Field type: float

  • amountMin: The maximum fee value listed.
    Field type: float

  • currency: The currency listed for amountMin and amountMax
    Field type: keyword

  • dateSeen: A list of dates when this fee was seen.
    Field type: date

  • sourceURLs: A list of URLs where this fee was seen.
    Field type: keyword

  • type: A classification value for the fee.
    Field type: text

floorSizeValue

"floorSizeValue": 947

The size of the walkable area of the property. For apartments and condos, this is the size of the property. For homes and buildings, this is the combined size of each floor and does not include lot size.
Field type: float

floorSizeUnit

"floorSizeUnit": "Sq. ft"

The units of measurement for floorSize.
Field type: keyword

geoLocation

"geoLocation": "POINT (-119.5094 37.229366)"

A location value that stores the latitude and longitude in a format that allows geospatial querying.
Field type: geo_shape

The value is stored as Well-Known Text format, which resembles an (x, y) value, i.e. (longitude latitude).

hours

"hours": [
  {
    "day": "Saturday",
    "hour": "10:00am-5:00pm"
  }
]

The hours of operation for property.
Field type: nested

Each hour object may contain:

  • day: The day(s) for this hour of operation.
    Field type: text

  • hour: The hours of operation.
    Field type: text

imageURLs

"imageURLs": [
  "http://image.rent.com/imgr/61bbc9f535f0e180bc804ac8f4c50067/480-280"
]

A list of image URLs for this property.
Field type: keyword

keys

"keys": [
  "us/ca/nhills/9411brightwoodct"
]

A list of internal Datafiniti identifiers for this property. The keys field is used to merge raw data from individual sources into the master Datafiniti record. Learn how this works
Field type: keyword

languagesSpoken

"languagesSpoken: [
  "French",
  "English"
]

A list of the languages spoken at this property.
Field type: text

latitude

"latitude": "32.860858"

The latitude coordinates for this property.
Field type: text

leasingTerms

"leasingTerms: [
  {
    "dateSeen": "2016-07-30T20:41:01Z",
    "sourceURLs": [   "https://www.showmetherent.com/4022-N-Sheridan-Rd-Chicago-IL-60613-3"
    ],
    "value": "12 Months"
  }
]

A list of leasing terms that have been associated with this property. Each leasing term will contain:
Field type: nested

  • dateSeen: The date when this term was seen.
    Field type: date

  • sourceURLs: A list of URLs where this term was seen.
    Field type: keyword

  • value: The leasing term description.
    Field type: text

listingName

"listingName": "Antico Appartamento"

The name of the property listing. This isn't the name of the building. It's a descriptive name supplied for the listing itself.
Field type: text

longitude

"longitude": "-96.735808"

The longitude coordinates for this property.
Field type: text

lotSizeValue

"lotSizeValue": 2219

The lot size for the property. This is the ground area covered by the property.
Field type: integer

lotSizeUnit

"lotSizeUnit": "Sq. ft"

The units of measurement for lotSize.
Field type: keyword

managedBy

"managedBy": [
  {
    "dateSeen": [
      "2016-03-03T15:02:13Z"
    ],
    "sourceURLs": [

  "http://www.rentcafe.com/apartments/ca/los-angeles/5118-de-longpre/default.aspx"
     ],
     "value": "ROM Investments"
  }
]

A list of companies or people that have managed this property. Each managedBy object will contain:
Field type: nested

  • dateSeen: A list of dates when this information was seen.
    Field type: date

  • sourceURLs: A list of URLs where this was seen.
    Field type: keyword

  • value: The name of the company or person.
    Field type: text

mlsNumber

"mlsNumber": "16177277"

The MLS number for the property. Learn more about MLS numbers.
Field type: keyword

mostRecentStatus

"mostRecentStatus": "For Sale"

The most recent value for statuses.type for this property. See possible values here.
Field type: keyword

mostRecentStatusDate

"mostRecentStatus": "2017-01-10T20:12:16Z"

The date that corresponds to the mostRecentStatus for this property.
Field type: date

nearbySchools

"nearbySchools": [
  {
    "dateSeen": "2017-06-11T11:40:54Z",
    "distanceUnit": "mi",
    "distanceValue": 5.3,
    "name": "Holbrook High School",
    "sourceURLs": [      "http://www.century21.com/property/0000-n-hwy-77--holbrook-az-86025-REN012338741"
    ]
  }
]

A list of schools near this property. Each school may contain:
Field type: nested

  • assigned: A true/fase value that indicates if the property is assigned to this school.
    Field type: boolean

  • address: The school's address.
    Field type: text

  • city: The school's city.
    Field type: text

  • country: The school's country.
    Field type: text

  • dateSeen: The date when this school was seen.
    Field type: date

  • distanceValue: The distance to the school from the property.
    Field type: float

  • distanceUnit: The units of measurement for distance.
    Field type: keyword

  • faxes: A list of fax numbers for the school.
    Field type: text

  • gradeLevels: The grade levels offered by this school.
    Field type: text

  • name: The name of the school.
    Field type: text

  • phones: A list of phone numbers for this school.
    Field type: keyword

  • postalCode: The school's postal or zip code.
    Field type: keyword

  • province: The school's province or state.
    Field type: text

  • sourceURLs: A list of URLs where this school was seen.
    Field type: keyword

neighborhoods

"neighborhoods": [
  "Canarsie"
]

A list of neighborhoods where this property is located. Sometimes an area can belong to multiple neighborhoods, which is why this field is a list.
Field type: text

numBathroom

"numBathroom": 1.25

The number of bathrooms in this property. Can be a whole number (e.g. "1") or a float (e.g., 1.25).
Field type: float

numBedroom

"numBedroom": 3

The number of bedrooms in this property.
Field type: integer

numFloor

"numFloor": 2

The number of floors or stories in this property.
Field type: integer

numPeople

"numPeople": 6

The number of people that can occupy this property.
Field type: integer

numRoom

"numRoom": 2

The number of rooms in this property.
Field type: integer

numUnit

"numUnit": 1

The number of units available in this property.
Field type: integer

parking

"parking": [
  "Garage"
]

A list of details regarding parking at this property.
Field type: text

paymentTypes

"paymentTypes": [
  "Visa"
]

A list of payment options accepted by the property.
Field type: text

people

"people": [
  {
    "dateSeen": "2017-06-11T11:40:54Z",
    "name": "Pulcano Yvonne",
    "title": "Owner"
  }
]

A list of known people associated with or employed by this property.
Field type: nested

Each person may contain:

  • dateSeen: The date when this person was seen.
    Field type: date

  • email: The person's email.
    Field type: text

  • name: The person's name.
    Field type: text

  • phone: The person's phone number.
    Field type: text

  • title: The person's title.
    Field type: text

petPolicy

"petPolicy": "Pets are not allowed."

The pet policy for the property.
Field type: text

phones

"phones": [
  "5058982700"
]

A list of phone numbers for the property.
Field type: keyword

postalCode

"postalCode": "75231"

The postal or zip code of the property.
Field type: keyword

prices

"prices": [
  {
    "amountMax": 289000,
    "amountMin": 289000,
    "availability": "true",
    "comment": ""Listed by Awaye Realty Management",
    "currency": "USD",
    "date": "2017-10-21T00:00:00Z",
    "dateSeen": [
      "2017-10-09T00:00:00Z"
    ],
    "isSale": "false",
    "isSold": "false",
    "pricePerSquareFoot": 197,
    "sourceURLs": [
      "http://www.movoto.com/dallas-tx/402_11008589/"
    ]
  },
  {
    "amountMax": 817,
    "amountMin": 817,
    "currency": "USD",
    "dateSeen": [
      "2016-01-20T00:00:00Z"
    ],
    "isSale": "false",
    "minStay": "7 nights",
    "period": "Per week",
    "sourceURLs": [   "http://www.vacationrentals.com/1234"
    ]
  }
]

A list of prices for this property.
Field type: nested

Price objects may contain:

  • amountMin: The minimum price value listed.
    Field type: float

  • amountMax: The maximum price value listed. This is typically the same as amountMin, except in cases where a price range is listed.
    Field type: float

  • availability: The property's availability at this price.
    Field type: keyword

  • comment: A note related to this price.
    Field type: text

  • currency: The currency listed for amountMin and amountMax.
    Field type: text

  • date: A list of date when the property was set to this price.
    Field type: date

  • dateSeen: A list of dates when this price was seen.
    Field type: date

  • dateValidStart: The date when this price becomes valid.
    Field type: date

  • dateValidEnd: The date when this price is no longer valid.
    Field type: date

  • isSale: A true/false for whether or not this is a sale price.
    Field type: boolean

  • isSold: A true/false for whether or not this is the sold price.
    Field type: boolean

  • minStay: The minimum length of stay required for this price.
    Field type: text

  • period: The calendar period for which this price is valid.
    Field type: text

  • pricePerSquareFoot: The price divide by the square footage.
    Field type: float

  • sourceURLs: A list of URLs where this price was seen.
    Field type: keyword

propertyTaxes

"propertyTaxes": [
  {
    "amount": 1582,
    "currency": "USD",
    "dateSeen": [
      "2016-08-09T09:34:15Z"
    ],
    "sourceURLs": [   "http://www.movoto.com/columbia-heights-mn/3719-jackson-st-ne-columbia-heights-mn-55421-651_4745601/for-sale/"
    ]
  }
]

A list of property taxes that have been seen for this property. Each property tax will include:
Field type: nested

  • amount: The tax amount.
    Field type: float

  • currency: The amount's currency.
    Field type: text

  • dateSeen: A list of dates when this tax has been seen for this property.
    Field type: date

  • sourceURLs: A list of source URLs where this tax was seen.
    Field type: keyword

propertyType

"propertyType": "Condo"

A classification for the property type. See possible values here.
Field type: text

province

"province": "TX"

The province or state for this property.
Field type: text

reviews

"reviews": [
  {
    "dateSeen": "2016-08-17T00:00:00Z",
    "sourceURLs": [ "https://www.airbnb.com/rooms/12090852"
    ],
    "text": "We love this place a lot!",
    "username": "Yuwei"
  }
]

A list of reviews for this property.
Field type: nested

Review objects may contain:

  • date: The date the review was posted.
    Field type: date

  • dateSeen: The date when the review was seen by Datafiniti.
    Field type: date

  • doRecommend: A true/false for whether or not the reviewer recommends the product.
    Field type: boolean

  • rating: A 1 to 5 star value for the review.
    Field type: float

  • sourceURLs: A list of URLs where this review was seen.
    Field type: keyword

  • text: The full (or available) text of the review.
    Field type: text

  • title: The review's title.
    Field type: text

  • userCity: The reviewer's city.
    Field type: text

  • username: The reviewer's username.
    Field type: text

  • userProvince: The reviewer's province or state.
    Field type: text

rules

"rules": [
  "No smoking"
]

A list of rules for living or staying at this property.
Field type: text

sourceURLs

"sourceURLs": [
  ""https://www.airbnb.com/rooms/13392408"
]

A list of URLs used to generate data for this property.
Field type: keyword

statuses

"statuses": [
  {
    "dateSeen": [
      "2017-10-10T20:12:16Z"
    ],
    "date":  "2017-01-10T20:12:16Z",
    "isUnderContract": "false",
    "sourceURLs": [
      "http://www.movoto.com/dallas-tx/402_11008589/"
    ],
    "type": "Sold"
  }
]

A list of statuses for this property. This field is used to indicate when the property is for sale, etc.
Field type: nested

Each status includes:

  • date: Date the status occurred
    Field type: date

  • dateSeen: A list of dates when this status was seen by Datafiniti.
    Field type: date

  • isUnderContract: A true/false value to indicate if this status is under contract.
    Field type: boolean

  • sourceURLs: A list of URLs where this status was seen.
    Field type: keyword

  • type: The status. See possible values here.
    Field type: keyword

taxID

"taxID": "30-9011-019-0029758"

The tax ID for the property.
Field type: keyword

unavailableDates

"unavailableDates": [
  {
    "dateSeen": [
      "2016-05-29T00:00:00Z"
    ],
    "endDate": "2016-04-29T00:00:00Z",
    "sourceURLs": [
      "http://www.booking.com/hotel/dm/manicou-river.html"
    ],
    "startDate": "2016-04-29T00:00:00Z"
  }
]

A list of dates this property is unavailable (typically for rent).
Field type: nested

Each unavailability contains:

  • dateSeen: A list of dates when this unavailability was seen.
    Field type: date

  • endDate: The ending date for the property's unavailability.
    Field type: date

  • sourceURLs: A list of source URLs where this unavailability was seen.
    Field type: keyword

  • startDate: The starting date for the property's unavailability.
    Field type: date

websiteIDs

"websiteIDs": [
  "domain.com-123",
  "website.com-4567"
]

A list of website IDs for this product. Website IDs are tied to a specific online retailer. They are the unique identifier used by website. They are used by Datafiniti when other unique identifiers are not available for a product.
Field type: keyword

Updated 3 months ago

Property Data Schema


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.