Skip to content
PredictHQ API Client for Python
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ext
predicthq
tests
usecases
.gitignore
.travis.yml
LICENSE
MANIFEST.in
README.md
requirements.txt
setup.cfg
setup.py
tox.ini

README.md

PredictHQ logo

PredictHQ API Client for Python

Version PyPI package Build Status Coverage Status

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.

Installation

The PredicHQ Python client is distributed as a pip package. You can simply install it by running

pip install predicthq

Usage

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.

Pagination

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'))

Events endpoint

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.

Places endpoint

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.

Running Tests

pip install tox
tox

Found a Bug?

Please log an issue.

You can’t perform that action at this time.