Skip to main content

Python The Noun Project API Wrapper.

Project description

Build Status Language grade: Python codecov license


TheNounProjectAPI is a Python wrapper allowing convenient access to the Noun Project API. It supports all endpoints and types of responses. Documentation for this wrapper can be found here, while the official documentation of the API itself may be found here.


TheNounProjectAPI is supported on Python 3.7+. The recommended method of installation is via pip.

pip install TheNounProjectAPI

You can also install TheNounProjectAPI directly from github using:

pip install --upgrade

For help with installing Python and/or pip, see "The Hitchhiker's Guide to Python" Installation Guides

Getting started

It's strongly encouraged to use the documentation's Getting started section to get started, as it's tied to the rest of the documentation, allowing you to quickly find exactly what you need.

However, I'll provide a quick sample.

# See the Documentation for more information:
from TheNounProjectAPI import API

if __name__ == "__main__":
    # API Key and Secret from
    key = "<my api key>"
    secret = "<my api secret>"

    # Create api object
    api = API(key=key, secret=secret)

    # See the documentation for more endpoints
    icons = api.get_icons_by_term("goat", public_domain_only=True, limit=2)

    # >>>icons
    # [<IconModel: Term: Goat Feeding, Slug: goat-feeding, Id: 24014>,
    # <IconModel: Term: Herbivore teeth, Slug: herbivore-teeth, Id: 675870>]

    for icon in icons:
        print("Icon's term:", icon.term)
        print("This icon's tags:", ", ".join(tag.slug for tag in icon.tags))
        print("Uploader's username:", icon.uploader.username)

Examine the TheNounProjectAPI documentation for more examples of what can be done with TheNounProjectAPI.


Documentation can be found here:


Run python, nosetests, python nosetests or python test to run all tests in one batch.


TheNounProjectAPI is licensed under MIT.


Contributions are welcome.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for TheNounProjectAPI, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size TheNounProjectAPI-1.0.5-py2.py3-none-any.whl (16.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size TheNounProjectAPI-1.0.5.tar.gz (14.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page