Events

The Events API gives you a read-only interface to PredictHQ's event data. An event represents something happening at a specific date, time and location, which is either scheduled or unscheduled.

New Data Sources

As PredictHQ evolves and develops, we will continue to provide more event categories as more sources become available.

If you're interested in a category that is not listed here or would like to see a specific data source added, drop us a line.

Properties

Below are the properties returned by the Events endpoint. Please note that these are not the fields used for filtering - please refer to the Search Events section to discover which parameters can be used for filtering events.

Property

Description

id string read-only

The unique identifier of the event.

E.g. z13B3870YOgv

scope string read-only

The geographical scope the events apply to.

Possible values:

  • locality
  • county
  • region
  • country

E.g. locality

title string read-only

The title of the event.

E.g. Katy Perry

description string read-only

A description of the event.

E.g. See Katy Perry in concert [...]

start string read-only

The start date of the event in ISO 8601 format.

All start dates are in UTC if the event time zone is provided, and in local time otherwise. For example, Independence Day falls on the 4th of July regardless of the time zone, and will have a null time zone.

If an event has a start time of midnight (in the event time zone) this is an indication that the actual time may be unknown. You may wish to omit the time when displaying these events.

E.g. 2018-12-19T06:00:00Z

end string read-only

The end date of the event in ISO 8601 format.

All end dates are in UTC if the event time zone is provided, and in local time otherwise. For example, Independence Day falls on the 4th of July regardless of the time zone, and will have a null time zone.

E.g. 2018-12-19T10:00:00Z

updated string

read-only

The last modification date of the event in ISO 8601 format. All dates are in UTC.

E.g. 2018-05-01T05:00:00Z

first_seen string

read-only

The date the event first entered our dataset in ISO 8601 format. All dates are in UTC. This value may be missing on some events, and should not be considered an event announcement date.

E.g. 2017-12-19T06:00:00Z

timezone string read-only

The time zone of the event in TZ Database format. This is helpful so you know which time zone to convert the dates to (if needed).

If the time zone is null, the start and end date should be regarded as time zone agnostic and already being in local time. Our start and end filters take this into account when specifying a lower and higher bound on dates.

E.g. Pacific/Auckland

duration number read-only

The duration of the event in seconds.

E.g. 3600

category string read-only

The category of the event

Possible values:

  • school-holidays
  • public-holidays
  • observances
  • politics
  • conferences
  • expos
  • concerts
  • festivals
  • performing-arts
  • sports
  • community
  • daylight-savings
  • airport-delays
  • severe-weather
  • disasters
  • terror

E.g. concerts

labels array read-only

The labels associated with the event. Use the count endpoint to fetch a list of available labels.

E.g. ["holiday", "holiday-national"]

country string read-only

The country code in ISO 3166-1 alpha 2 format.

E.g. NZ

rank number read-only

A number between 0 and 100 representing the estimated impact of the event.

E.g. 83

local_rank number read-only

A number between 0 and 100 representing the estimated local impact of the event. This is designed to be more representative of the event’s local impact by taking into account population density to adjust the estimated event impact according to the surrounding geographic area.

local_rank is calculated for events in the categories community, concerts, conferences, expos, sports, festivals, performing-arts. If local_rank is not intended to be available for an event, this field will be null.

E.g. 72

location array read-only

A 2-tuple representing the geo location of the event. Note that the longitude/latitude coordinates use the GeoJSON order [lon, lat].

E.g. [174.776792, -36.847319]

place_hierarchies array read-only

An array of place hierarchies for the event. Each hierarchy is an array of place ids (see Places). The final place in a hierarchy is a specific place the event applies to. Each place is a sub-place of the place immediately preceding it in the hierarchy.

For example, a hierarchy might contain the following places in this order: Earth > Europe > United Kingdom > England > Nottingham

E.g. [["6295630", "6255148", "2635167", "6269131", "3333178", "2641170"]]

relevance number read-only

Relative relevance of the event to the event search.

See the relevance parameter for information on how relevance is calculated.

E.g. 2.9654586

state string read-only

The publication state of the event.

Possible values:

  • active: the event is published and valid.
  • deleted: the event was removed, either because it was cancelled or is a duplicate.

Search Events

Use the below parameters to search and filter all events that are available to your account.

Visibility Window

Please note that you will not receive an error when requesting a date range that is outside of your subscription's event visibility window.

However, your event visibility window will be automatically applied to your results.

Result Limit

Please note the count of your search results will be limited to your subscription's result limit. If more results exist the field overflow will be set to true to indicate it is being capped.

Parameters

Parameter

Description

limit number

The maximum number of results to return. The default limit is 10.

E.g. ?limit=10

offset number

The number of results to skip. The default is 0.

E.g. ?offset=20

sort string

A comma-separated list of properties to sort results by. The default is relevance,-start.

Prefix the property name with - for reverse order.

Possible values:

  • id
  • title
  • start
  • end
  • updated
  • rank
  • local_rank
  • category
  • duration
  • country
  • labels
  • relevance

Note when sorting on local_rank (regardless of sort order), events that do not have a local_rank will be placed last.

When sorting by relevance the most relevant results are sorted first, regardless of sort order.

E.g. ?sort=country,-start

relevance string

A comma-separated list of components to include when calculating the relevance property of an event. The relevance components are multiplied together to produce the overall relevance.

Parameter Components: These components correspond to search parameters that can influence relevance. If the parameter isn't provided as part of a search its component will be ignored. By default, relevance includes the components of each relevance-influencing parameter in a search.

  • q
  • start_around
  • end_around
  • location_around

Property Components: These components correspond to event properties that can be included in relevance. They are not included in relevance by default.

  • rank
  • local_rank

E.g. ?relevance=q,rank,location_around

q string

A full-text search query.

Can influence relevance.

E.g. ?q=katy+perry

id string

A comma-separated list of event identifiers.

E.g. ?id=z13B3870YOgv

start.* date range

The date from and/or to the event starts. Supports gt, gte, lt, lte and tz suffixes.

Please note that use of a suffix is required.

E.g. ?start.gte=2018-12-19&start.lte=2018-12-19

start_around.* date around

Fuzzy date search around event start. Supports origin, offset, scale, decay suffixes.

  • origin: The date (required)
  • offset: The number of days from the origin before the score starts to decay (optional, defaults to 0d)
  • scale: Distance from origin +/- offset at which the score will equal the decay value (optional, defaults to 3d)
  • decay: Score value at the scale distance (optional, defaults to 0.5)

Can influence relevance.

E.g. ?start_around.origin=2018-12-19

end.* date range

The date from and/or to the event ends. Supports gt, gte, lt, lte and tz suffixes.

Please note that use of a suffix is required.

E.g. ?end.gte=2018-12-19&end.lte=2018-12-19

end_around.* date around

Fuzzy date search around event end. Supports origin, offset, scale, decay suffixes.

  • origin: The date (required)
  • offset: The number of days from the origin before the score starts to decay (optional, defaults to 0d)
  • scale: Distance from origin +/- offset at which the score will equal the decay value (optional, defaults to 3d)
  • decay: Score value at the scale distance (optional, defaults to 0.5)

Can influence relevance.

E.g. ?end_around.origin=2018-12-19

active.* date range

The date from and/or to the events intersect with. Supports gt, gte, lt, lte and tz suffixes.

Please note that use of a suffix is required.

E.g. ?active.gte=2015-01-01&active.lte=2015-03-01

updated.* date range

The date from and/or to the event was last modified. Supports gt, gte, lt, lte and tz suffixes.

Please note that use of a suffix is required.

E.g. ?updated.gte=2018-05-01

state string

A comma-separated list of states for the events. Supports active and deleted. By default, returns active events only.

This parameter is useful in conjunction with updated when you cache events and are interested in retrieving a list of all events that have changed since a specific date and time

E.g. ?state=active,deleted

rank.* rank range

Supports gt, gte, lt and lte suffixes.

Please note that use of a suffix is required.

E.g. ?rank.gte=80&rank.lte=90

local_rank.* rank range

Supports gt, gte, lt and lte suffixes.

Please note that use of a suffix is required.

Note when filtering on local_rank events that do not have a local_rank will not be returned.

E.g. ?local_rank.gte=80&local_rank.lte=90

rank_level number

A comma-separated list of numbers between 1 and 5, corresponding to the PredictHQ rank levels.

Possible values:

  • 1 - Minor (rank between 0 and 20).
  • 2 - Moderate (rank between 21 and 40).
  • 3 - Important (rank between 41 and 60).
  • 4 - Significant (rank between 61 and 80).
  • 5 - Major (rank between 81 and 100).

E.g. ?rank_level=4,5

local_rank_level number

A comma-separated list of numbers between 1 and 5, corresponding to the PredictHQ local rank levels.

Possible values:

  • 1 - Minor (rank between 0 and 20).
  • 2 - Moderate (rank between 21 and 40).
  • 3 - Important (rank between 41 and 60).
  • 4 - Significant (rank between 61 and 80).
  • 5 - Major (rank between 81 and 100).

Note when filtering on local_rank_level events that do not have a local_rank will not be returned.

E.g. ?local_rank_level=4,5

category string

A comma-separated list of categories.

Possible values:

  • school-holidays
  • public-holidays
  • observances
  • politics
  • conferences
  • expos
  • concerts
  • festivals
  • performing-arts
  • sports
  • community
  • daylight-savings
  • airport-delays
  • severe-weather
  • disasters
  • terror

E.g. ?category=school-holidays,public-holidays

label string

A comma-separated list of labels. Use the count endpoint to fetch a list of available labels.

E.g. ?label=holiday,observance

within area

A geo centre and radius in the form {radius}{unit}@{latitude},{longitude}, where the radius unit can be one of: m, km, ft, mi.

Note that results may contain events that apply to a parent scope of the specified area.

E.g. National school holidays that apply to the local radius.

E.g. ?within=10km@-36.844480,174.768368

location_around.* location around

Fuzzy location search around event location. Supports origin, offset, scale, decay suffixes.

  • origin: The location in the form {latitude},{longitude} (required)
  • offset: The distance before decay is applied (optional, defaults to 0km) (Distance unit can be one of m, km, ft, mi)
  • scale: Distance from origin + offset at which the score will equal decay value (optional, defaults to 2km) (Distance unit can be one of m, km, ft, mi)
  • decay: Score value at scale value (optional, defaults to 0.5)

Can influence relevance.

E.g. ?location_around.origin=40.730610,-73.935242

place.* place

A comma-separated list of place ids (see Places) and/or IATA (3 character), ICAO (4 character), and UN/LOCODE (5 character) airport codes where the events occur. Supports scope or exact suffixes. Download CSV list of all supported airport codes and their respective place ids.

When place.scope is used, results will contain events that apply to the parent and children places of the specified place. E.g. National, regional and local school holidays that apply to a region.

When place.exact is used, results will contain events that apply to the specified place only. E.g. Regional school holidays only.

Please note that use of a suffix is required.

E.g.

  • all events that apply to the State of New York: ?place.scope=5128638
  • all events that apply to the place associated with San Francisco Airport: ?place.scope=SFO

signal.* signal

The signal to use for event impact explanation (past) or prediction (future).

Supports the following modifiers:

  • id: the ID of the signal to use for predictions (required)
  • analysis_from: start date of the analysis (optional, defaults to the earliest data point, or 2 years back from the analysis_to date, whichever is later)
  • analysis_to: end date of the analysis (optional, defaults to the latest data point, or today, whichever is earlier)
  • analysis_tz: time zone to use for the purpose of the analysis (optional, defaults to UTC)
  • significance: number between 0 and 100 (optional, defaults to 50)
  • metric: metric to use for event relevance (optional, defaults to demand, valid options are: demand, lead and span)
  • explain: date for which you require an explanation (required for past analysis only)

When signal.explain is not provided, active or start can be used to retrieve future predictions of events that we estimate will impact your business.

For details about signals, see our signals endpoint.

Please note that use of a suffix is required.

E.g.

  • Past explanation: ?signal.id=reg5gzuWf3ug&signal.explain=2017-12-24
  • Future prediction: ?signal.id=reg5gzuWf3ug&active.gte=2018-12-17&active.lte=2018-12-21 (modify dates accordingly)

country string

A comma-separated list of country codes.

E.g. ?country=AU,NZ


Retrieve Events Count

This endpoint accepts the same parameters as the ones described in Search Events and can be used to get aggregated counts of all matching events that are available to your account.


Retrieve Events Calendar

This endpoint accepts the same parameters as the ones described in Search Events and can be used to get a calendar view of all matching events that are available to your account.

Each day in the calendar contains aggregate counts of all active events for that day.