API Quickstart

This article describes how to quickly create an access token, view and replicate a Streamlit demo app and explore our APIs.

What you need:

  1. A PredictHQ account - sign up for free to get started.

  2. An API Access Token.

Create an access token

Read a more in-depth guide to creating a new API Client and Token or follow the basic steps below:

  1. Log into Control Center and visit the API Clients page.

  2. Select "New Client" and fill in the required information.

  3. Make sure to keep a copy of your new Client Secret as this cannot be shown to you again.

  4. Use the new Client Secret to create a new Token.

  5. Make sure to keep a copy of your new API Token as this cannot be shown to you again.

Now you can use the new API Token in the Authorization header of your API requests.

Streamlit Demo Apps

To demonstrate how quick and easy it is to build extremely powerful apps using our APIs, we put together some Streamlit demos. All the code is available on GitHub and we encourage you to take the code, modify it, and use your own locations of interest to demo our APIs internally to your team or to simply better understand our technology.

alt

Explore the API

Now that you have your API access token, make your first request to test it out. The access token is used in the Authorization header as in the example to the right.

For more detailed info on each of our APIs, please visit the relevant page:

  • Events API - full real-world event information.

  • Broadcasts API - full broadcast (Live TV) information.

  • Features API - aggregated daily-level features ready for use by ML models.

  • Beam API - decomposition and correlation engine.

  • Demand Surge API - identify abnormal increases in predicted attendance around your location.

  • Suggested Radius API - takes the guesswork out of working out a suitable radius around your location when searching for events.

  • Places API - geonames place data.

  • Account API - basic account information.

Did you know - Control Center uses the same APIs you have access to. One of the easiest ways to learn how to use our APIs is to see it in action in Control Center.

curlpythonraw
curl -X GET "https://api.predicthq.com/v1/events/" \
     -H "Authorization: Bearer $ACCESS_TOKEN"