Data Description
These are the descriptions of the fields included in the data we make available. All data is presented in JSON format.
List Format
In these data definitions, many of the models contain lists of elements. These lists follow a standard format:
- each element in the list is a distinct element, usually either a sub-document or a string (i.e., the list is not a single string containing a comma-separated list of elements)
- zero or more elements can be in the list
Location Field Descriptions
A location consists of a JSON document containing the following information:
- id: the unique name of this location as used in the REST API and in the menu links. This is alpha-numeric.
- factualId: the factual ID mapping for this location
- outOfBusiness: indicates if the location is in business or out of business (i.e., closed). Valid values: true or false
- NOTE: This field has been deprecated. While we still expose the field as to not disrupt existing publisher integrations, all values for outOfBusiness will be false.
- businessType: the type of business for the location
- publishedAt: the date the location was published
- hasPhotos: indicates if a location has photos available via our Photos API. Valid values: true or_ false_
-
isOwnerVerified: indicates if a location is Owner Verified (i.e. SinglePlatform customer). Valid values: true or false
-
general
- name: the name of the location
- timeZone: time zone of the location
- desc: general description of the location
- website: location's existing website
-
location: address, directions, and other information about the physical location of the location
-
address1: physical street address of the location
- address2: physical street address of the location
- city: city of the location
- region: region of the location (state, province, territory, etc.)
- postcode: postal code of the location
- country: the country in which the location resides
- latitude: the latitude of the location
- longitude: the longitude of the location
-
phones: a map of phone name to phone numbers. Each number is a 10 digit number with no dashes or spaces and no 1 at the beginning.
-
main: location's main number
- fax: location's fax number
- Hours: the daily opening and closing hours for a business
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"title" : "Root schema.",
"description" : "An explanation about the purpose of this instance.",
"type" : "object",
"properties" : {
"id" : {
"title" : "Id schema.",
"description" : "the unique name of this location as used in the REST API and in the menu links. This is alpha-numeric.",
"type" : "string"
},
"factualId" : {
"title" : "FactualId schema.",
"description" : "the factual ID mapping for this location",
"type" : "string"
},
"outOfBusiness" : {
"title" : "OutOfBusiness schema.",
"description" : "indicates if the location is in business or out of business (i.e., closed).",
"type" : "boolean"
},
"publishedAt" : {
"title" : "PublishedAt schema.",
"description" : "the date the location was published",
"type" : "string"
},
"general" : {
"title" : "General schema.",
"type" : "object",
"properties" : {
"name" : {
"title" : "Name schema.",
"description" : "the name of the location",
"type" : "string"
},
"timeZone" : {
"title" : "TimeZone schema.",
"description" : "time zone of the location",
"type" : "string"
},
"desc" : {
"description" : "general description of the location",
"title" : "Desc schema.",
"type" : "string"
},
"website" : {
"title" : "Website schema.",
"description" : "location's existing website",
"type" : "string"
}
}
},
"location" : {
"title" : "Location schema.",
"description" : "address, directions, and other information about the physical location of the location",
"type" : "object",
"properties" : {
"address1" : {
"title" : "Address1 schema.",
"description" : "physical street address of the location",
"type" : "string"
},
"address2" : {
"title" : "Address2 schema.",
"description" : "physical street address of the location",
"type" : "string"
},
"city" : {
"title" : "City schema.",
"description" : "city of the location",
"type" : "string"
},
"region" : {
"title" : "Region schema.",
"description" : "region of the location (state, province, territory, etc.)",
"type" : "string"
},
"state" : {
"title" : "State schema.",
"description" : "the state in which the location resides",
"type" : "string"
},
"postcode" : {
"title" : "Postcode schema.",
"description" : "postal code of the location",
"type" : "string"
},
"zipCode" : {
"title" : "ZipCode schema.",
"description" : "postal code of the location",
"type" : "string"
},
"country" : {
"title" : "Country schema.",
"description" : "the country in which the location resides",
"type" : "string"
},
"latitude" : {
"title" : "Latitude schema.",
"description" : "the latitude of the location",
"type" : "number"
},
"longitude" : {
"title" : "Longitude schema.",
"description" : "the longitude of the location",
"type" : "number"
}
}
},
"phones" : {
"title" : "Phones schema.",
"description" : "a map of phone name to phone numbers. Each number is a 10 digit number with no dashes or spaces and no 1 at the beginning.",
"type" : "object",
"properties" : {
"main" : {
"title" : "Main schema.",
"description" : "location's main number",
"type" : "string"
},
"fax" : {
"description" : "location's fax number",
"title" : "Fax schema.",
"type" : "string"
}
}
},
"hours" : {
"title" : "Hours schema.",
"description" : "the daily opening and closing hours for a business",
"type" : "object",
"properties" : {
"mon" : {
"title" : "Monday Hours.",
"type" : "object",
"properties" : { "start" : { "type" : "string" }, "end" : { "type" : "string" } }
},
"tue" : {
"title" : "Tuesday Hours.",
"type" : "object",
"properties" : { "start" : { "type" : "string" }, "end" : { "type" : "string" } }
},
"wed" : {
"title" : "Wednesday Hours.",
"type" : "object",
"properties" : { "end" : { "type" : "string" }, "start" : { "type" : "string" } }
},
"thu" : {
"title" : "Thursday Hours.",
"type" : "object",
"properties" : { "end" : { "type" : "string" }, "start" : { "type" : "string" } }
},
"fri" : {
"title" : "Friday Hours.",
"type" : "object",
"properties" : { "start" : { "type" : "string" }, "end" : { "type" : "string" } }
},
"sat" : {
"title" : "Saturday Hours.",
"type" : "object",
"properties" : { "end" : { "type" : "string" }, "start" : { "type" : "string" } }
},
"sun" : {
"title" : "Sunday Hours.",
"type" : "object",
"properties" : { "end" : { "type" : "string" }, "start" : { "type" : "string" } }
},
"holidaySchedule" : {
"title" : "HolidaySchedule schema.",
"type" : "string"
}
}
},
"hasPhotos" : {
"title" : "HasPhotos schema.",
"description" : "indicates if a location has photos available via our Photos API.",
"type" : "boolean"
},
"businessType" : {
"title" : "BusinessType schema.",
"description" : "the type of business for the location",
"type" : "string"
},
"isOwnerVerified" : {
"title" : "IsOwnerVerified schema.",
"description" : "indicates if a location is Owner Verified (i.e. SinglePlatform customer).",
"type" : "boolean"
}
}
}
Sample Location Data
Here is a sample of what the location data would look like.
Single Location Entry
{
"id": "island-prime",
"factualId": "71f291e0-bef8-012e-5614-003048cad9da",
"outOfBusiness": false,
"publishedAt": "2012-03-09 11:07:15",
"general": {
"name": "Island Prime",
"timeZone": "PST",
"desc": "Resting on stilts atop San Diego Bay overlooking the city skyline and Coronado, there’s nowhere better than Island Prime & C Level to experience quintessential San Diego. \r\n\r\nIsland Prime and C Level are two concepts under one roof! Enjoy the casual side at C Level for lunch where it is first come, first serve in our dining room, lanai and outside terrace. Island Prime is open for dinner and reservations are recommended but NOT required.",
"website": "http://www.islandprime.com/"
},
"location": {
"address1": "880 Harbor Island Dr",
"address2": "",
"city": "San Diego",
"region": "CA",
"country": "US",
"postcode": "92101",
"longitude": -117.19415,
"latitude": 32.72494,
"state": "CA",
"zipCode": "92101"
},
"phones": {
"main": "619-298-6802",
"fax": null
},
"hours": {
"mon": {
"start": "11:30am",
"end": "12:00am"
},
"tue": {
"start": "11:30am",
"end": "12:00am"
},
"wed": {
"start": "11:30am",
"end": "12:00am"
},
"thu": {
"start": "11:30am",
"end": "12:00am"
},
"fri": {
"start": "11:30am",
"end": "12:00am"
},
"sat": {
"start": "11:30am",
"end": "12:00am"
},
"sun": {
"start": "11:30am",
"end": "12:00am"
},
"holidaySchedule": ""
},
"hasPhotos": true,
"businessType": "Restaurant",
"isOwnerVerified": true
}
List of Locations
[
{
"id": "union-square-cafe",
"factualId": "8f1687c6-2a90-4706-a99f-914c55be32a9",
"outOfBusiness": false,
"publishedAt": "2012-03-09 11:04:04",
"general": {
"name": "Union Square Cafe",
"timeZone": "EST",
"desc": "In October of 1985, Danny Meyer opened his first restaurant, Union Square Cafe. A new breed of American eatery, USC paired imaginative food and wine with caring hospitality, comfortable surroundings and exceptional value. Serving American cuisine with an Italian soul, USC was an immediate hit. From outstanding wines by the glass, dining at the bar and seasonal ingredients to an emerging downtown location and a mission to support our community, USC has changed the restaurant landscape in NYC and across the country. A critical success from the outset, USC has twice garnered The New York Times' three-star rating, and also earned Zagat Survey's #1 ranking as New York's Most Popular Restaurant for an unprecedented eight years.",
"website": "http://unionsquarecafe.com/"
},
"location": {
"address1": "21 E 16th St",
"address2": "",
"city": "New York",
"region": "NY",
"country": "US",
"postcode": "10003",
"longitude": -73.99169,
"latitude": 40.73692,
"state": "NY",
"zipCode": "10003"
},
"phones": {
"main": "212-243-4020",
"fax": "212-627-2673"
},
"hours": {
"mon": {
"start": "12:00pm",
"end": "10:00pm"
},
"tue": {
"start": "12:00pm",
"end": "10:00pm"
},
"wed": {
"start": "12:00pm",
"end": "10:00pm"
},
"thu": {
"start": "12:00pm",
"end": "10:00pm"
},
"fri": {
"start": "12:00pm",
"end": "11:00pm"
},
"sat": {
"start": "12:00pm",
"end": "11:00pm"
},
"sun": {
"start": "12:00pm",
"end": "10:00pm"
},
"holidaySchedule": ""
},
"hasPhotos": true,
"businessType": "Restaurant",
"isOwnerVerified": true
},
{
"id": "banc-cafe",
"factualId": "a2e3baf2-eae4-4017-98d1-1cf4ab02d145",
"outOfBusiness": false,
"publishedAt": "2012-03-09 10:35:56",
"general": {
"name": "Banc Cafe",
"timeZone": "EST",
"desc": "A neighborhood bar restaurant occupying the space of a 1920's bank. The decor is inspired by nineteenth century Parisian establishments. Terra Cotta textured walls, dimly lit chandelier's, copper table tops & curved banquette seating create a very unique and intimate setting. Executive Chef, John J. Loughran formerly of River Cafe in Brooklyn has created a menu that changes seasonally using the best of locally sourced ingredients. Chef John's philosophy, buy local and be creative. This is evident in every dish you taste at Banc Cafe. Our cocktails are created using fresh fruit & natural ingredients.We feel that tasty food & flavorful drinks provided with honest friendly service is a great way to win someone over. We hope that someone is you. Enjoy!",
"website": "http://www.banccafe.com/"
},
"location": {
"address1": "431 3rd Ave",
"address2": "",
"city": "New York",
"region": "NY",
"country": "US",
"postcode": "10016",
"longitude": -73.97973,
"latitude": 40.74351,
"state": "NY",
"zipCode": "10016"
},
"phones": {
"main": "212-252-0146",
"fax": null
},
"hours": {
"mon": {
"start": "11:00am",
"end": "04:00am"
},
"tue": {
"start": "11:00am",
"end": "04:00am"
},
"wed": {
"start": "11:00am",
"end": "04:00am"
},
"thu": {
"start": "11:00am",
"end": "04:00am"
},
"fri": {
"start": "11:00am",
"end": "04:00am"
},
"sat": {
"start": "11:00am",
"end": "04:00am"
},
"sun": {
"start": "11:00am",
"end": "04:00am"
},
"holidaySchedule": ""
},
"hasPhotos": true,
"businessType": "Restaurant",
"isOwnerVerified": true
}
]
- locations.json (application/octet-stream)