Python wrapper for The Noun Project's API: TheNounProject API.
The easiest way to install the latest version is by using pip/easy_install to pull it from PyPI:
pip install python-thenounproject
You may also use Git to clone the repository from Github and install it manually:
git clone https://github.com/yakupadakli/python-thenounproject.git
cd python-thenounproject
python setup.py install
Python 2.7, 3.3, 3.4 and 3.6, is supported for now.
from thenounproject.api import Api
api_key = ""
secret_key = ""
api = Api(api_key, secret_key)
Return’s a list of all collections
Query Parameters:
limit (int) – maximum number of results
offset (int) – number of results to displace or skip over
page (int) – number of results of limit length to displace or skip over
api.collection.list()
Returns a single collection
api.collection.get(4)
Returns a single collection
api.collection.get_by_slug("national-park-service")
Retrieve information for a given collection.
Query Parameters:
limit (int) – maximum number of results
offset (int) – number of results to displace or skip over
page (int) – number of results of limit length to displace or skip over
api.collection.icons(55)
Returns a list of icons associated with a collection
Query Parameters:
limit (int) – maximum number of results
offset (int) – number of results to displace or skip over
page (int) – number of results of limit length to displace or skip over
api.collection.icons_by_slug("bicycle")
Returns a list of icons
Query Parameters:
limit_to_public_domain (int) – limit results to public domain icons only
limit (int) – maximum number of results
offset (int) – number of results to displace or skip over
page (int) – number of results of limit length to displace or skip over
api.icon.list("fish")
Returns a single icon
api.icon.get(15)
Returns a single icon
api.icon.get_by_term(15)
Returns list of most recently uploaded icons
Query Parameters:
limit (int) – maximum number of results
offset (int) – number of results to displace or skip over
page (int) – number of results of limit length to displace or skip over
api.icon.recent_uploads(15)
Returns current oauth usage and limits
api.usage.get()
Returns a list of collections associated with a user
api.usage.collections(6)
Returns a single collection associated with a user
api.usage.collection_by_slug("bicycle")
Returns a list of uploads associated with a user
api.usage.uploads("edward")
Accepts icon ids for reporting icon usage. Default mode is test.
api.usage.report_usage(["42", "143", "1337"])