get https://api.diffbot.com/v3/event
Automatically extracts dates, location and address information, images and event descriptions from event pages.
Event API is in Beta
Please use with the understanding that parameters and response data formats may change to support usage feedback.
The Event API returns information on an event like a webinar, meetup, etc. and can be used to extract clean event details, text descriptions and other data from online and in-person event pages for standalone events held within a single day.
Most popular event aggregation sites are supported, but the Event API is a new release so please make sure to report any bugs you find to [email protected].
Support for multi-day, multi-track events (i.e. full conference schedules and festivals), is planned but not yet supported.
Test drive Event API without a trial token at diffbot.com/testdrive.
Response
The Event API returns data in JSON format.
Each response includes a request object (which returns request-specific metadata), and an objects array, which will include the extracted information for all objects on a submitted page.
Objects in the Event API's objects array will include the following fields:
| Field | Description |
|---|---|
type | Type of object (always event). |
pageUrl | URL of submitted page / page from which the event is extracted. |
resolvedPageUrl | Returned if the pageUrl redirects to another URL. |
title | Title of the event. |
startDate | Start date of extracted event in GMT, normalized in most cases to RFC 1123 (HTTP/1.1). If no start time was found, the time is midnight. |
endDate | End date of extracted event in GMT, normalized in most cases to RFC 1123 (HTTP/1.1). If no end time was found, the time is midnight. |
startDateLocalTimezone | Start date of extracted event in the local timezone as deplayed on the page. If no start time was found, the time is midnight. |
endDateLocalTimezone | End date of extracted eventin the local timezone as deplayed on the page. If no start time was found, the time is midnight. |
timezoneOffset | GMT offset in hours and minutes. |
description | Text description, if available, of the event. |
venue | The name of the venue, if available. |
location | Parsed location information, if a parsable location was found. |
↳country | Country name. |
↳isCurrent | Returns true if the address is current. |
↳address | The complete location address as a normalized string. |
↳city | City name. |
↳street | Street address. |
↳subregion | Subregion of the city or area, such as a county. |
↳latitude | Latitude of the geographic coordinate of the address. |
↳longitude | Longitude of the geographic coordinate of the address. |
↳postalCode | Postal code. |
↳region | Region, such as a state or province. |
↳precision | The scale of the area described by the address. More specific addresses describe a smaller area and will have a lower value. |
images | Array of images, if present within the event page. |
↳url | Fully resolved link to image. If the image SRC is encoded as base64 data, the complete data URI will be returned. |
↳title | Description or caption of the image. |
↳height | Height of image as (re-)sized via browser/CSS. |
↳width | Width of image as (re-)sized via browser/CSS. |
↳naturalHeight | Raw image height, in pixels. |
↳naturalWidth | Raw image width, in pixels. |
↳primary | Returns true if image is identified as primary based on visual analysis. |
↳xpath | XPath expression identifying the image node. |
↳diffbotUri | Internal ID used for indexing. |
humanLanguage | Returns the (spoken/human) language of the submitted page, using two-letter ISO 639-1 nomenclature. |
meta | Returns a top-level object (meta) containing the full contents of page meta tags, including sub-arrays for OpenGraph tags, Twitter Card metadata, schema.org microdata, and -- if available -- oEmbed metadata. |
diffbotUri | Unique object ID. The diffbotUri is generated from the values of various event fields and uniquely identifies the object. This can be used for deduplication. |
The following is an example response from a successfully extracted event page.
{
"request":{
"pageUrl":"https://www.eventbrite.com/e/graphql-summit-2018-tickets-46601841362",
"api":"event",
"version":3
},
"objects":[
{
"venue":"The Regency Center",
"images":[
{
"naturalHeight":0,
"width":720,
"diffbotUri":"image|3|2088675194",
"url":"https://img.evbuc.com/https%3A%2F%2Fcdn.evbuc.com%2Fimages%2F45534724%2F182934487936%2F1%2Foriginal.jpg?w=800&auto=compress&rect=0%2C0%2C2160%2C1080&s=e73c0be202c2cd939dcd3e809d96e093",
"naturalWidth":0,
"primary":true,
"height":360
}
],
"timezoneOffset": "-07:00",
"endDate":"Fri, 09 Nov 2018 01:00:00 GMT",
"endDateLocalTimezone":"Thu, 08 Nov 2018 17:00:00",
"humanLanguage":"en",
"diffbotUri":"event|3|-2069254052",
"description":"Join over 850 developers at the 3rd annual GraphQL Summit, the world's largest conference dedicated to GraphQL. Whether you're just getting started or a veteran GraphQL practitioner, this is the must-attend developer conference of the year.\nChoose from 40+ sessions across two tracks at one of San Francisco's most historic event venues\nSee how teams at top startups and enterprises are modernizing their platforms by using GraphQL in complex production environments\nHear where the technology is heading next, directly from the leaders of GraphQL's major open source projects\nMeet top solution providers from around the world - all under one roof.\nEnroll in hands-on workshops and classroom training to boost your skills to get the most out of GraphQL.\nGraphQL Summit Day Code of Conduct\nWe believe our community and events should be truly open for everyone. As such, we are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, or religion. Our event code of conduct outlines our expectations for participant behavior, as well as the consequences for unacceptable behavior.\n*GraphQL Summit is hosted at the Regency Center which is an accessible space with elevator access*",
"pageUrl":"https://archives.diffbot.com/replay/4F02A5A651C6767544362C27B1D9BAC1/",
"location":{
"country":{
"name":"United States",
"diffbotUri":"http://diffbot.com/entity/A01d4EK33MmCosgI2KXa4-A",
"websiteUris":[
"wikidata.org/entity/Q30"
],
"targetDiffbotUri":"http://diffbot.com/entity/A01d4EK33MmCosgI2KXa4-A",
"surfaceForm":"United States"
},
"isCurrent":true,
"address":"1300 Van Ness Ave, San Francisco, California",
"city":{
"name":"San Francisco",
"diffbotUri":"http://diffbot.com/entity/A8AV-O2v0MBuACAY7pFZzbg",
"websiteUris":[
"wikidata.org/entity/Q62"
],
"targetDiffbotUri":"http://diffbot.com/entity/A8AV-O2v0MBuACAY7pFZzbg",
"surfaceForm":"San Francisco"
},
"street":"1300 Van Ness Ave",
"subregion":{
"name":"San Francisco County",
"diffbotUri":"http://diffbot.com/entity/A8AV-O2v0MBuACAY7pFZzbg",
"websiteUris":[
"wikidata.org/entity/Q62"
],
"targetDiffbotUri":"http://diffbot.com/entity/A8AV-O2v0MBuACAY7pFZzbg",
"surfaceForm":"San Francisco County"
},
"latitude":37.78785705566406,
"precision":0.10000000149011612,
"postalCode":"94109",
"region":{
"name":"California",
"diffbotUri":"http://diffbot.com/entity/Al0_8ehooNxOPT36Y4RdV9w",
"websiteUris":[
"wikidata.org/entity/Q99"
],
"targetDiffbotUri":"http://diffbot.com/entity/Al0_8ehooNxOPT36Y4RdV9w",
"surfaceForm":"California"
},
"longitude":-122.42138671875
},
"type":"event",
"title":"GraphQL Summit 2018",
"startDate":"Wed, 07 Nov 2018 16:30:00 GMT",
"startDateLocalTimezone":"Wed, 07 Nov 2018 08:30:00"
}
]
}
Optional Fields
Event API may also return some optional fields if specified. (comma delimited) in the &fields= argument.
Already have the source HTML? POST it to Event API.
Event API supports a POST option that allows you to upload HTML or plain text for extraction. See Extract Content Not Available Online.