psolin / csepy

Google Custom Search Engine API Python Wrapper

#csepy

Google Custom Search Engine API Python Wrapper

##Before you start

• Turn on Custom Search API by agreeing to the terms. Note the API key.

• Create a custom search engine that works the way that you want it to work. Note its ID in the URL.

##Usage

Import the module:

from csepy import googlecse

Use your secret key and custom search engine ID:

x = googlecse(SECRET_KEY='YOUR_SECRET_KEY', CSE_ID='YOUR_CSE_ID')

Grab the JSON results:

y = x.results(query='test')
for result in y.result_list:
    print result['link']

You can use a host of other parameters, but 'query' is required. Check them out here: https://developers.google.com/custom-search/json-api/v1/reference/cse/list

In case something went wrong, you can view the URL that is generated:

z = x.url(query='test')
print z

With Google CSE, you have a limit of 10 pages of results (100 results max). Each page is considered to be its own separate API request. You can specify how many pages of requests will go out by adding the following parameter to the 'results' function:

pages=#

...with the number being 1-10. If there are no pages specified, only one query will be run. Also, if the pages you enter exceed the total results, you won't be docked for it!

##Feedback

Feel free to fork the project, file issues, or contact me at paulsolin.com.