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.

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:

  • dateSeen: A list of dates when this availability was seen.
  • endDate: The ending date for the property's availability.
  • sourceURLs: A list of source URLs where this availability was seen.
  • startDate: The starting date for the property's availability.

brokers

"brokers": [
  {
    "agent": "Frances Zuckerman",
    "company": "Fillmore",
    "dateSeen": [
      "2017-01-17T09:47:16Z"
    ],
    "emails": [
      "fzuckerman@gmail.com"
    ],
    "phones": [
      "3214561234"
    ]
  }
]

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

  • agent: The name of the real estate agent representing this property.
  • company: The company this agent works for (or the company representing this property).
  • dateSeen: The date this agent/company was seen representing the property.
  • emails: A list of email addresses associated with the agent or company.
  • phones: A phone number associated with the agent or company.
  • websites: A list of websites associated with the agent or company.

buildingName

"buildingName":""

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

city

"city": "Dallas"

The city where the property is located.

country

"country": "US"

The two-letter country code for the business location's country.

dateAdded

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

The date this property was first added to the property database.

dateUpdated

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

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

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:

  • amount: The fee amount.
  • currency: The currency for the amount.
  • dateSeen: A list of dates this deposit fee was seen.
  • sourceURLs: A list of source URLs where this deposit fee was seen.

descriptions

"descriptions": [
  {
    "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:

  • dateSeen: A list of dates when this description has been seen for this property.
  • sourceURLs: A list of source URLs where this specific description was seen.
  • value: A unique description for this property.

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.

Each feature contains:

  • key: A label for this feature.
  • value: A list of possible values for this feature.

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:

  • amountMax: The minimum fee value listed.
  • amountMin: The maximum fee value listed.
  • currency: The currency listed for amountMin and amountMax
  • dateSeen: A list of dates when this fee was seen.
  • sourceURLs: A list of URLs where this fee was seen.
  • type: A classification value for the fee.

floorSizeValue

"floorSizeValue":

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.

floorSizeUnit

"floorSizeUnit":

The units of measurement for floorSize.

hours

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

The hours of operation for property.

Each hour object may contain:

  • day: The day(s) for this hour of operation.
  • hour: The hours of operation.

imageURLs

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

A list of image URLs for this property.

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

languagesSpoken

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

A list of the languages spoken at this property.

latitude

"latitude": "32.860858"

The latitude coordinates for this property.

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:

  • dateSeen: A list of dates when this term was seen.
  • sourceURLs: A list of URLs where this term was seen.
  • value: The leasing term description.

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.

longitude

"longitude": "-96.735808"

The longitude coordinates for this property.

lotSizeValue

"lotSizeValue": 2219

The lot size for the property. This is the ground area covered by the property.

lotSizeUnit

"lotSizeUnit": "Sq. ft"

The units of measurement for lotSize.

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:

  • dateSeen: A list of dates when this information was seen.
  • sourceURLs: A list of URLs where this was seen.
  • value: The name of the company or person.

mlsNumber

"mlsNumber": "16177277"

The MLS number for the property. Learn more about MLS numbers.

mostRecentStatus

"mostRecentStatus": "For Sale"

The most recent value for statuses.type for this property.

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:

  • assigned: A true/fase value that indicates if the property is assigned to this school.
  • address: The school's address.
  • city: The school's city.
  • country: The school's country.
  • dateSeen: A list of dates when this school was seen.
  • distanceValue: The distance to the school from the property.
  • distanceUnit: The units of measurement for distance.
  • faxes: A list of fax numbers for the school.
  • gradeLevels: The grade levels offered by this school.
  • name: The name of the school.
  • phones: A list of phone numbers for this school.
  • postalCode: The school's postal or zip code.
  • province: The school's province or state.
  • sourceURLs: A list of URLs where this school was seen.

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.

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).

numBedroom

"numBedroom": 3

The number of bedrooms in this property.

numFloor

"numFloor": 2

The number of floors or stories in this property.

numPeople

"numPeople": 6

The number of people that can occupy this property.

numRoom

"numRoom":

The number of rooms in this property.

numUnit

"numUnit": 1

The number of units available in this property.

parking

"parking": [
  "Garage"
]

A list of details regarding parking at this property.

paymentTypes

"paymentTypes": [
  "Visa"
]

A list of payment options accepted by the property.

people

"people": [
  {
    "name": "Pulcano Yvonne",
    "title": "Owner"
  }
]

A list of known people associated with or employed by this property.

Each person may contain:

  • dateSeen: A list of dates when this person was seen.
  • email: The person's email.
  • name: The person's name.
  • phone: The person's phone number.
  • title: The person's title.

petPolicy

"petPolicy": "Pets are not allowed."

The pet policy for the property.

phones

"phones": [
  "5058982700"
]

A list of phone numbers for the property.

postalCode

"postalCode": "75231"

The postal or zip code of the property.

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.

Price objects may contain:

  • amountMin: The minimum price value listed.
  • amountMax: The maximum price value listed. This is typically the same as amountMin, except in cases where a price range is listed.
  • availability: The property's availability at this price.
  • comment: A note related to this price.
  • currency: The currency listed for amountMin and amountMax.
  • date: A list of date when the property was set to this price.
  • dateSeen: A list of dates when this price was seen.
  • dateValidStart: The date when this price becomes valid.
  • dateValidEnd: The date when this price is no longer valid.
  • isSale: A true/false for whether or not this is a sale price.
  • isSold: A true/false for whether or not this is the sold price.
  • minStay: The minimum length of stay required for this price.
  • period: The calendar period for which this price is valid.
  • pricePerSquareFoot: The price divide by the square footage.
  • sourceURLs: A list of URLs where this price was seen.

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:

  • amount: The tax amount.
  • currency: The amount's currency.
  • dateSeen: A list of dates when this tax has been seen for this property.
  • sourceURLs: A list of source URLs where this tax was seen.

propertyType

"propertyType": "Condo"

A classification for the property type. See possible values here.

province

"province": "TX"

The province or state for this property.

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.

Review objects may contain:

  • date: The date the review was posted.
  • dateSeen: A list of dates when the review was seen by Datafiniti.
  • doRecommend: A true/false for whether or not the reviewer recommends the product.
  • rating: A 1 to 5 star value for the review.
  • sourceURLs: A list of URLs where this review was seen.
  • text: The full (or available) text of the review.
  • title: The review's title.
  • userCity: The reviewer's city.
  • username: The reviewer's username.
  • userProvince: The reviewer's province or state.

rules

"rules": [
  "No smoking"
]

A list of rules for living or staying at this property.

sourceURLs

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

A list of URLs used to generate data for this property.

statuses

"statuses": [
  {
    "dateSeen": [
      "2017-10-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. Each status includes:

  • dateSeen: A list of dates when this status was seen by Datafiniti.
  • isUnderContract: A true/false value to indicate if this status is under contract.
  • sourceURLs: A list of URLs where this status was seen.
  • type: The status. See possible values here.

taxID

"taxID": ""

The tax ID for the property.

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). Each unavailability contains:

  • dateSeen: A list of dates when this unavailability was seen.
  • endDate: The ending date for the property's unavailability.
  • sourceURLs: A list of source URLs where this unavailability was seen.
  • startDate: The starting date for the property's unavailability.

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.