webhose 0.1.5

API Key

To make use of the webhose.io API, you need to obtain a token that would be used on every request. To obtain an API key, create an account at https://webhose.io/auth/signup, and then go into https://webhose.io/dashboard to see your token.

Installing

You can install from source:

$ git clone https://github.com/Buzzilla/webhose-python
$ cd webhose-python
$ python setup.py install

Use the API

To get started, you need to import the library, and set your access token. (Replace YOUR_API_KEY with your actual API key).

>>> import webhose
>>> webhose.config(token=YOUR_API_KEY)

Now you can make a request and inspect the results:

>>> r = webhose.search("foobar")
>>> r.total
62
>>> len(r.posts)
62
>>> r.posts[0].language
'english'
>>> r.posts[0].title
'Putting quotes around dictionary keys in JS'

For your convenience, the Response object is iterable, so you can loop over it and get all the results. The iterator will create additional API requests to fetch additional pages.

>>> total_words = 0
>>> for post in r:
...     total_words += len(post.text.split(" "))
...
>>> print(total_words)
56006

Warning: This method can use up your credits if your search has lots of results.

Full documentation

• config(token)

  • token - your API key

• search(query, token=None)

  • query - the search query, either as a search string, or as a Query object

  • token - you can provide the API key directly to the search function if you want

Polling

If you want to make repeated searches, performing an action whenever there are new results, use code like this:

r = webhose.search("skyrim")
while True:
    for post in r:
        perform_action(post)
    time.sleep(300)
    r = r.get_next()