PredictHQ is the demand intelligence company combining real-world events into one global source of truth to help businesses better understand demand and plan for the future.
The PredicHQ Python client is distributed as a pip package. You can simply install it by running
pip install predicthq
We support all the endpoints available in our API.
oauth2
accounts
events
places
Please refer to our API Documentation for a description of each endpoint.
Additional examples are available in usecases/pagination.py file.
By default the search()
method only returns the first page of results, with a default page size of 10.
from predicthq import Client
phq = Client(access_token="abc123")
for event in phq.events.search():
print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))
You can chain the iter_all()
generator to iterate over all your events.
for event in phq.events.search().iter_all():
print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))
Additional examples are available in usecases/events folder.
The following example searches for the 'Katy Perry' events (full text search) with rank level of 4 or 5 (rank >= 60) in the concerts category.
from predicthq import Client
phq = Client(access_token="abc123")
for event in phq.events.search(q='Katy Perry', rank_level=[4, 5], category='concerts'):
print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))
Please refer to our Events endpoint documentation for the lists of search parameters and event fields available.
Additional examples are available in usecases/places.py file.
The following example searches for the 'New York' places (full text search) in the US.
from predicthq import Client
phq = Client(access_token="abc123")
for place in phq.places.search(q='New York', country='US'):
print(place.id, place.name, place.type, place.location)
Please refer to our Places endpoint documentation for the lists of search parameters and place fields available.
pip install tox
tox
Please log an issue.