Documentation¶
Collection¶
- GET /collection/(int: id)¶
Returns a single collection
- Parameters:
id (int) – collection id
Request:
GET http://api.thenounproject.com/collection/4Response:
{ "collection": { "author": { "location": "Los Angeles, California, US", "name": "Iconathon", "permalink": "/Iconathon1", "username": "Iconathon1" }, "author_id": "12701", "date_created": "2012-01-27 19:15:26", "date_updated": "2012-12-11 08:40:24", "description": "", "icon_count": "183", "id": "4", "is_collaborative": "", "is_featured": "1", "is_published": "0", "is_store_item": "0", "name": "Iconathon", "permalink": "/Iconathon1/collection/iconathon", "slug": "iconathon", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } }
- GET /collection/(slug)¶
Returns a single collection
- Parameters:
slug (string) – collection slug
Request:
GET http://api.thenounproject.com/collection/national-park-serviceResponse:
{ "collection": { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:26", "date_updated": "2012-01-27 19:15:26", "description": "", "icon_count": "143", "id": "2", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "0", "name": "National Park Service", "permalink": "/edward/collection/national-park-service", "slug": "national-park-service", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } }
- GET /collection/(int: id)/icons¶
Returns a list of icons associated with a collection
- Parameters:
id (int) – collection id
- 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
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
A default call returns up to 50 results. By using the limit, offset, and page parameters, additional data can be retrieved. Setting the page parameter will override the offset parameter.
Request:
GET http://api.thenounproject.com/collection/55/icons?limit=4Response:
{ "generated_at": "Thu, 05 Mar 2015 20:21:57 GMT", "icons": [ { "attribution": "fun by XOXO from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/23936-600.png", "date_uploaded": "2013-10-02", "icon_url": "https://static.thenounproject.com/svg/7c2f2d9b-068b-484a-9b40-5485d17b6d13.svg?Expires=1425590517&Signature=J7u7PjEV01SnXi3pd3AJCktqoMntim~V1fHQkrFnd~jpZD0kszRivNYabC-6BgQRbjphL9mth1wFngCYYoc5GJth5Ixs1JA4O0TYhyc7yLLO8k8sYkAogxFHpS4L8SrHXej1brnr8y-8NDZqj3IWq47OaPgQvwx6GfCbeAXGXmI_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "23936", "is_active": "1", "license_description": "public-domain", "permalink": "/term/fun/23936", "preview_url": "https://static.thenounproject.com/png/23936-200.png", "preview_url_42": "https://static.thenounproject.com/png/23936-42.png", "preview_url_84": "https://static.thenounproject.com/png/23936-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "fun", "term_id": 3127, "term_slug": "fun", "uploader": { "location": "US", "name": "XOXO", "permalink": "/xoxo", "username": "xoxo" }, "uploader_id": "202222", "year": 2013 }, { "attribution": "Crowdsourcing by Duke Innovation Co-Lab from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/27466-600.png", "date_uploaded": "2013-12-04", "icon_url": "https://static.thenounproject.com/svg/1fd63245-ec14-4f00-8ef9-215a4b985960.svg?Expires=1425590517&Signature=mUZYY2LHPdiIYB~oxzzlHr57BavJbyWaFKwq6KsktMQfeUbOHUEdbGKsmwpmxmxqu0O0hZiERrRGcwSPIVTPmL8SR7sXx62Rh4oOXKkghWvwnx~MEru0bpDDFFTzjatUebiBWv3EIZWVX2n58BBs6FTL1hw9URo3E3p1K7rW6TE_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "27466", "is_active": "1", "license_description": "public-domain", "permalink": "/term/crowdsourcing/27466", "preview_url": "https://static.thenounproject.com/png/27466-200.png", "preview_url_42": "https://static.thenounproject.com/png/27466-42.png", "preview_url_84": "https://static.thenounproject.com/png/27466-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Crowdsourcing", "term_id": 12936, "term_slug": "crowdsourcing", "uploader": { "location": "Durham, North Carolina, US", "name": "Duke Innovation Co-Lab", "permalink": "/Duke Innovation Co-Lab", "username": "Duke Innovation Co-Lab" }, "uploader_id": "238191", "year": 2013 }, { "attribution": "Close the Loop by Matt Brooks from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/30207-600.png", "date_uploaded": "2014-01-22", "icon_url": "https://static.thenounproject.com/svg/0d4506a1-3b61-43cb-aa0f-878148934587.svg?Expires=1425590517&Signature=fkplt5T6yj63agIgHdYKRs9o5rwbuHB~wYPkYq-P7R0sETv~uch9VUkzRZWAdFRIAp9VtBWCpMOzlGeAtPw1-8Ysdk2TIA8yumzFqC6UkaHT8JF255FUZYPRbElshOHgvo4a0DQrwoqlRgPJS~UyLLuop0o5XJM2P1h5mU3XtMA_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "30207", "is_active": "1", "license_description": "public-domain", "permalink": "/term/close-the-loop/30207", "preview_url": "https://static.thenounproject.com/png/30207-200.png", "preview_url_42": "https://static.thenounproject.com/png/30207-42.png", "preview_url_84": "https://static.thenounproject.com/png/30207-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Close the Loop", "term_id": 23212, "term_slug": "close-the-loop", "uploader": { "location": "Los Angeles, California, US", "name": "Matt Brooks", "permalink": "/Mattebrooks", "username": "Mattebrooks" }, "uploader_id": "21993", "year": 2014 }, { "attribution": "labor by Matt Brooks from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/30208-600.png", "date_uploaded": "2014-01-22", "icon_url": "https://static.thenounproject.com/svg/7f3232e3-2271-459f-820f-afc96cac750d.svg?Expires=1425590517&Signature=MYuatNnRw3Cs8t~Nr3l3g9FV~Vat6nAzxagYCNd9AS~SITSsPXhdvIeLGghR6nTcj1hN6GrhDqRpOHoGKjQDegwjhp3z1I0W0gr~Ty7bhyQnMto-x554eASDV0wd7HVZD8LcQrE0XvCucVhRuejpJiTmP0ETBpOJtnOaHM~jt90_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "30208", "is_active": "1", "license_description": "public-domain", "permalink": "/term/labor/30208", "preview_url": "https://static.thenounproject.com/png/30208-200.png", "preview_url_42": "https://static.thenounproject.com/png/30208-42.png", "preview_url_84": "https://static.thenounproject.com/png/30208-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "labor", "term_id": 8825, "term_slug": "labor", "uploader": { "location": "Los Angeles, California, US", "name": "Matt Brooks", "permalink": "/Mattebrooks", "username": "Mattebrooks" }, "uploader_id": "21993", "year": 2014 } ] }
- GET /collection/(slug)/icons¶
Returns a list of icons associated with a collection
- Parameters:
slug (string) – collection slug
- 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
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
A default call returns up to 50 results. By using the limit, offset, and page parameters, additional data can be retrieved. Setting the page parameter will override the offset parameter.
Request:
GET http://api.thenounproject.com/collection/bicycle/iconsResponse:
{ "generated_at": "Thu, 05 Mar 2015 20:21:57 GMT", "icons": [ { "attribution": "Bicycle from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/79-600.png", "date_uploaded": "", "icon_url": "https://static.thenounproject.com/svg/79_1.svg?Expires=1425590517&Signature=VG4MLr70For8NIW7OaDIXpChNolhZu9ksUWqQUcJocXcowN5g432RnkGl-4CKwwJPUvcg3CvanOhUN49gRd0f8TEFVE7SSQ0zAuUSm-1HUwsYp2SksnqYL9lJzAitq9W3NMd47JlB0W1xBqRQjM~P6p4iUDEGUSRssA1hlDfZG4_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "79", "is_active": "1", "license_description": "public-domain", "permalink": "/term/bicycle/79", "preview_url": "https://static.thenounproject.com/png/79-200.png", "preview_url_42": "https://static.thenounproject.com/png/79-42.png", "preview_url_84": "https://static.thenounproject.com/png/79-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Bicycle", "term_id": 83, "term_slug": "bicycle", "uploader": "", "uploader_id": "", "year": 0 }, { "attribution": "Bicycle from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/550-600.png", "date_uploaded": "", "icon_url": "https://static.thenounproject.com/svg/546_1.svg?Expires=1425590517&Signature=V-cR44iyU~kDAegkAVnQwldecPQAJ8S5wh7B1uCDTqtTnx6WvR5eqMZCX616inigLt4ywq1bpO9yhMpxrs06IQgwE6gJZueCMpJ6TKC1CkGQFikFPOqOfPsHAbe80tLxahFCgsSq7XQcRkVYkcaUv92SYaxGBIkrBTACMQnuBeE_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "550", "is_active": "1", "license_description": "public-domain", "permalink": "/term/bicycle/550", "preview_url": "https://static.thenounproject.com/png/550-200.png", "preview_url_42": "https://static.thenounproject.com/png/550-42.png", "preview_url_84": "https://static.thenounproject.com/png/550-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Bicycle", "term_id": 83, "term_slug": "bicycle", "uploader": "", "uploader_id": "", "year": null }, { "attribution": "Female by Olivier Guin from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/1348-600.png", "date_uploaded": "2012-02-09", "icon_url": "https://static.thenounproject.com/svg/noun_project_1348.svg?Expires=1425590517&Signature=CdhpozmSkKRQp9mO566uIvFC7DcUmU3MHJtgfiJozWKk1RaKvTTU0cx2G499UUI0kStFyPaoE9Uq8YIGDKQTpw0Khnq2mOA-xnpiKXBxH5Orw7l8QUj8V8YkyTJBhcXdvGh6XIYGptUOx~tiwIm3UvPNxs8AqFwyrEi95q4Dfuo_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "1348", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/female/1348", "preview_url": "https://static.thenounproject.com/png/1348-200.png", "preview_url_42": "https://static.thenounproject.com/png/1348-42.png", "preview_url_84": "https://static.thenounproject.com/png/1348-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Female", "term_id": 160, "term_slug": "female", "uploader": { "location": "Paris, FR", "name": "Olivier Guin", "permalink": "/olivierguin", "username": "olivierguin" }, "uploader_id": "2393", "year": 2008 }, { "attribution": "Bike Lane by d\u0361\u0292\u025brmi Good from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/4544-600.png", "date_uploaded": "2012-08-31", "icon_url": "https://static.thenounproject.com/svg/ff6f58e3-0347-4579-94e5-e5527a4a06dd.svg?Expires=1425590517&Signature=IO9~EfBtugT9V2A6OZmrXyr1L4e4xzlrBhBiIeN~Fss2Rfxoo~6zm4XWjkoNJYJI9zafxofVRTQhyHGVKs68RFqjjGl-sG72yBuJCV625cpzbsnMHsWAGmPtEmNXtmm5ZkCUnUF-InV5nSueK70CQl60gGJaIwRr0wkQkv44wOM_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "4544", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/bike-lane/4544", "preview_url": "https://static.thenounproject.com/png/4544-200.png", "preview_url_42": "https://static.thenounproject.com/png/4544-42.png", "preview_url_84": "https://static.thenounproject.com/png/4544-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Bike Lane", "term_id": 5868, "term_slug": "bike-lane", "uploader": { "location": "Los Angeles, California, US", "name": "d\u0361\u0292\u025brmi Good", "permalink": "/Jeremy", "username": "Jeremy" }, "uploader_id": "306", "year": 2012 }, { "attribution": "Bike Lane by d\u0361\u0292\u025brmi Good from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/4545-600.png", "date_uploaded": "2012-08-31", "icon_url": "https://static.thenounproject.com/svg/16124ea0-d043-4442-970e-28484b547be0.svg?Expires=1425590517&Signature=Wcx~pIcIUwEKGF0QEjxj8kFmYPHgIRYM8kReDKJzxnqFjaUswXEKvXw6J7xYl1CuprjXSRtMMQBfT8lf0dHBL5eGkVJC9xSGjMs0la6u1ARypUkinuvABQMK674RtIDrpmLNIdDHx6HZ9KjgdDoKrJVH39DTq54CPNMcNjAbvNY_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "4545", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/bike-lane/4545", "preview_url": "https://static.thenounproject.com/png/4545-200.png", "preview_url_42": "https://static.thenounproject.com/png/4545-42.png", "preview_url_84": "https://static.thenounproject.com/png/4545-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Bike Lane", "term_id": 5868, "term_slug": "bike-lane", "uploader": { "location": "Los Angeles, California, US", "name": "d\u0361\u0292\u025brmi Good", "permalink": "/Jeremy", "username": "Jeremy" }, "uploader_id": "306", "year": 2012 }, { "attribution": "Bicycle by d\u0361\u0292\u025brmi Good from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/95557-600.png", "date_uploaded": "2015-01-16", "icon_url": "https://static.thenounproject.com/icon_uploads/678b9129-b691-4aef-8f97-b936dedf2148.svg?Expires=1425590517&Signature=BF-eYPDikk5jC3l7PH8F37ppJXKXrhxgExBRAd3LC9PDDU0MLcosjE1Twhnc4QudU2sdz853v-ho-Qj7H5Zx55qlC-6aTdD0hkZmqy3cgfZbisucO2-XTRX6rSMWvtRNdZ84RnrKYasWgLv9UFoMZui~NNldzSVlfJLkHtZkpNE_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "95557", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/bicycle/95557", "preview_url": "https://static.thenounproject.com/png/95557-200.png", "preview_url_42": "https://static.thenounproject.com/png/95557-42.png", "preview_url_84": "https://static.thenounproject.com/png/95557-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Bicycle", "term_id": 83, "term_slug": "bicycle", "uploader": { "location": "Los Angeles, California, US", "name": "d\u0361\u0292\u025brmi Good", "permalink": "/Jeremy", "username": "Jeremy" }, "uploader_id": "306", "year": 2015 }, { "attribution": "Cycling by d\u0361\u0292\u025brmi Good from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/95558-600.png", "date_uploaded": "2015-01-16", "icon_url": "https://static.thenounproject.com/icon_uploads/e048bf6f-19fa-4bab-bae0-8ffa43b6af52.svg?Expires=1425590517&Signature=g2brQSSBrMBOl0XWbvz28iifYhuSqgFmUgl5DwAWt5Y5YZldS9-CppXa-dC1O9cCDvXmX8KjZER59F8I161p69KfiAQrSU41yA34akRHoweftbD-i5mwC10u6DGfwYjayFhUZPRNhxTRRx5Y~~mDmutkFukReFcgfo6~OY45ixk_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "95558", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/cycling/95558", "preview_url": "https://static.thenounproject.com/png/95558-200.png", "preview_url_42": "https://static.thenounproject.com/png/95558-42.png", "preview_url_84": "https://static.thenounproject.com/png/95558-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Cycling", "term_id": 263, "term_slug": "cycling", "uploader": { "location": "Los Angeles, California, US", "name": "d\u0361\u0292\u025brmi Good", "permalink": "/Jeremy", "username": "Jeremy" }, "uploader_id": "306", "year": 2015 }, { "attribution": "Cycling by d\u0361\u0292\u025brmi Good from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/95559-600.png", "date_uploaded": "2015-01-16", "icon_url": "https://static.thenounproject.com/icon_uploads/bc76beea-d4ee-4fbd-9199-97bf44bfcc56.svg?Expires=1425590517&Signature=fSJrXZnYUCqs-pNAp0L4OZNhoE2coYDKb~XJ11ErUIgEUc9oQ6CmZc20Kh0iASGx4SGpcmoYNx3P7ZuL6xKKDXLRcFuo8MayvRqfe5myaTuhfJHsuHZ1H~TFtpB8M5ZxH~kNn~hFuPotJKS9oBVjqxNGIklwuASMUxer0Tu2Myg_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "95559", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/cycling/95559", "preview_url": "https://static.thenounproject.com/png/95559-200.png", "preview_url_42": "https://static.thenounproject.com/png/95559-42.png", "preview_url_84": "https://static.thenounproject.com/png/95559-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Cycling", "term_id": 263, "term_slug": "cycling", "uploader": { "location": "Los Angeles, California, US", "name": "d\u0361\u0292\u025brmi Good", "permalink": "/Jeremy", "username": "Jeremy" }, "uploader_id": "306", "year": 2015 } ] }
Collections¶
- GET /collections¶
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
Note
A default call returns up to 50 results. By using the limit, offset, and page parameters, additional data can be retrieved. Setting the page parameter will override the offset parameter.
Request:
GET http://api.thenounproject.com/collections/?limit=5Response:
{ "collections": [ { "author": { "location": "", "name": "Thomas Jakobsen", "permalink": "/lewl_roflcopter", "username": "lewl_roflcopter" }, "author_id": "695255", "date_created": "2015-03-05 20:25:58", "date_updated": "2015-03-05 20:25:58", "description": "", "id": "3348", "is_collaborative": "", "is_featured": "0", "is_published": "1", "is_store_item": "0", "name": "Dinosaurs", "permalink": "/lewl_roflcopter/collection/dinosaurs", "slug": "dinosaurs", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [ "dinosaur", "prehistoric", "dino" ], "template": "24" }, { "author": { "location": "Hadera, IL", "name": "Raz Cohen", "permalink": "/razco7", "username": "razco7" }, "author_id": "63993", "date_created": "2015-03-05 19:06:15", "date_updated": "2015-03-05 19:06:15", "description": "", "id": "3347", "is_collaborative": "", "is_featured": "0", "is_published": "1", "is_store_item": "0", "name": "Musical Instruments", "permalink": "/razco7/collection/musical-instruments", "slug": "musical-instruments", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "", "name": "ANA", "permalink": "/ana.multimedia.colon", "username": "ana.multimedia.colon" }, "author_id": "691381", "date_created": "2015-03-05 18:18:16", "date_updated": "2015-03-05 18:18:16", "description": "", "id": "3346", "is_collaborative": "", "is_featured": "0", "is_published": "1", "is_store_item": "0", "name": "ice cream 3", "permalink": "/ana.multimedia.colon/collection/ice-cream-3", "slug": "ice-cream-3", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "", "name": "ANA", "permalink": "/ana.multimedia.colon", "username": "ana.multimedia.colon" }, "author_id": "691381", "date_created": "2015-03-05 18:16:13", "date_updated": "2015-03-05 18:16:13", "description": "", "id": "3345", "is_collaborative": "", "is_featured": "0", "is_published": "1", "is_store_item": "0", "name": "ice cream", "permalink": "/ana.multimedia.colon/collection/ice-cream", "slug": "ice-cream", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "", "name": "ANA", "permalink": "/ana.multimedia.colon", "username": "ana.multimedia.colon" }, "author_id": "691381", "date_created": "2015-03-05 18:08:59", "date_updated": "2015-03-05 18:08:59", "description": "", "id": "3344", "is_collaborative": "", "is_featured": "0", "is_published": "1", "is_store_item": "0", "name": "key", "permalink": "/ana.multimedia.colon/collection/key", "slug": "key", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } ] }
Icon¶
- GET /icon/(int: id)¶
Returns a single icon
- Parameters:
id (int) – icon id
- Query Parameters:
include_png_1200 (int) – include 1200x1200 png in response
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
Request:
GET http://api.thenounproject.com/icon/15Response:
{ "icon": { "attribution": "Beauty Salon from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/15-600.png", "collections": [ { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:26", "date_updated": "2012-09-27 13:27:02", "description": "", "id": "3", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "0", "name": "AIGA", "permalink": "/edward/collection/aiga", "slug": "aiga", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:07", "date_updated": "2012-10-16 15:37:06", "description": "", "id": "1", "is_collaborative": "", "is_featured": "0", "is_published": "0", "is_store_item": "0", "name": "Noun Collection", "permalink": "/edward/collection/noun-collection", "slug": "noun-collection", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } ], "date_uploaded": "", "icon_url": "https://static.thenounproject.com/svg/15.svg?Expires=1425591205&Signature=XQZ8DdKHKbkiGJLvGlqNd7GKMNdguZ2a1cyQYdWbQUfor9NvByBGtviS2EjZ4osaZWU7gBTmnWIfE~Lrna5kaFzfK1Tca7Nx~9IrMyqN3iDCIVRdJXiKwhIAMbzjGcTDIBqWJUWb-JVTv-A2s~C8RFaQvZVv4XHdXt6sPmIySmI_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "15", "is_active": "1", "license_description": "public-domain", "permalink": "/term/beauty-salon/15", "preview_url": "https://static.thenounproject.com/png/15-200.png", "preview_url_42": "https://static.thenounproject.com/png/15-42.png", "preview_url_84": "https://static.thenounproject.com/png/15-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "tags": [ { "id": "41", "slug": "beauty-salon" }, { "id": "42", "slug": "haircut" } ], "term": "Beauty Salon", "term_id": 41, "term_slug": "beauty-salon", "uploader": "", "uploader_id": "", "year": 1974 } }
- GET /icon/(string: term)¶
Returns a single icon
- Parameters:
term (string) – icon term
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
Request:
GET http://api.thenounproject.com/icon/globeResponse:
{ "icon": { "attribution": "Globe by Edward Boatman from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/247-600.png", "collections": [ { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:07", "date_updated": "2012-10-16 15:37:06", "description": "", "id": "1", "is_collaborative": "", "is_featured": "0", "is_published": "0", "is_store_item": "0", "name": "Noun Collection", "permalink": "/edward/collection/noun-collection", "slug": "noun-collection", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } ], "date_uploaded": "", "icon_url": "https://static.thenounproject.com/svg/247_1.svg?Expires=1425591205&Signature=QtfhhRuhHEY8dSnOVqg6w2wI41q2cwPe3wwu-zU9kUtGcan9NHB6-m9zoTSinM-zyMga~eE6eD8ZSSz2XCySlw6f9bK~8B5Y9emBXGRVi8wOxtbhkOV7hfUQMIwZEe5r6OFWGXnjqHBR3iHCZS4XwLnzL1J6wwUd9DaSrb97MaQ_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "247", "is_active": "1", "license_description": "creative-commons-attribution", "permalink": "/term/globe/247", "preview_url": "https://static.thenounproject.com/png/247-200.png", "preview_url_42": "https://static.thenounproject.com/png/247-42.png", "preview_url_84": "https://static.thenounproject.com/png/247-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "tags": [ { "id": "292", "slug": "globe" } ], "term": "Globe", "term_id": 292, "term_slug": "globe", "uploader": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "uploader_id": "6", "year": 2010 } }
Icons¶
- GET /icons/(string: term)¶
Returns a list of icons
- Parameters:
term (string) – icon term
- 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
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
A default call returns up to 50 results. By using the limit, offset, and page parameters, additional data can be retrieved. Setting the page parameter will override the offset parameter.
Request:
GET http://api.thenounproject.com/icons/fish?limit_to_public_domain=1&limit=4Response:
{ "generated_at": "Thu, 05 Mar 2015 20:21:58 GMT", "icons": [ { "attribution": "Fish by Tonielle Krisanski from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/7770-600.png", "collections": [], "date_uploaded": "2012-11-15", "icon_url": "https://static.thenounproject.com/svg/3377c517-a6a9-477a-a446-cfcba9a4bca1.svg?Expires=1425590518&Signature=OXQLF5~U4AC7pmPnbfgywe4kcjJSGQjQsyHjFqLDF1iAfLDO6nhy~C1h5Gu7-VhI1x94cl2zE5VF21Mg9oObCqvitVNqGFusdMV3gGwXEUDVw2cAcMFWm4jh5LM7alYLIVPlewfbY136DMzFONvmzkR9zc84LCcOMB0DZzGVOmc_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "7770", "is_active": "1", "license_description": "public-domain", "permalink": "/term/fish/7770", "preview_url": "https://static.thenounproject.com/png/7770-200.png", "preview_url_42": "https://static.thenounproject.com/png/7770-42.png", "preview_url_84": "https://static.thenounproject.com/png/7770-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Fish", "term_id": 246, "term_slug": "fish", "uploader": { "location": "Melbourne, VIC, AU", "name": "Tonielle Krisanski", "permalink": "/tonikdesigns", "username": "tonikdesigns" }, "uploader_id": "8916", "year": 2012 }, { "attribution": "Fish by James Keuning from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/11742-600.png", "collections": [], "date_uploaded": "2013-02-16", "icon_url": "https://static.thenounproject.com/svg/aa552ef8-421c-4e51-86ae-d0a5af88603c.svg?Expires=1425590518&Signature=XdhZ2iDJyWLWxAuVog9iMufgTeu7TknaVGfOg5oP0VDFatdamEw9hOrZQnCyQBI3BRtc8FR0HH8ct54xtUq3IKZ5k1rEmEb5tgUGC14svqHMjPCEDNJxF0-5NwoJsSGZM4SAgD5tKrYKVEh3RMFCFLoIiVgfoA~lRSC1wTfg6hE_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "11742", "is_active": "1", "license_description": "public-domain", "permalink": "/term/fish/11742", "preview_url": "https://static.thenounproject.com/png/11742-200.png", "preview_url_42": "https://static.thenounproject.com/png/11742-42.png", "preview_url_84": "https://static.thenounproject.com/png/11742-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Fish", "term_id": 246, "term_slug": "fish", "uploader": { "location": "Saint Paul, Minnesota, US", "name": "James Keuning", "permalink": "/jmkeuning", "username": "jmkeuning" }, "uploader_id": "12121", "year": 2013 }, { "attribution": "Fishing by Jesse Jacob / iBureauet / Information Daily from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/12563-600.png", "collections": [], "date_uploaded": "2013-03-02", "icon_url": "https://static.thenounproject.com/svg/a5d6d6a1-5089-4be7-8726-264370be5795.svg?Expires=1425590518&Signature=Zbrq7BaIk3MFoTFOeHUw9pnYpunuYgJtkUhT7JNuCgiQuadbn-T~O2exckEKEZaZGpzF-yLb5BJ71jrF4r6VZ8Y25I56kMhIsFRrB~38uTAdtFayQmZwMuTu4bw2kw8s~wRaou6G0mvLaNqa8MqFo0vcN6zgBfVogD98d-Zc38w_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "12563", "is_active": "1", "license_description": "public-domain", "permalink": "/term/fishing/12563", "preview_url": "https://static.thenounproject.com/png/12563-200.png", "preview_url_42": "https://static.thenounproject.com/png/12563-42.png", "preview_url_84": "https://static.thenounproject.com/png/12563-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Fishing", "term_id": 252, "term_slug": "fishing", "uploader": { "location": "", "name": "Jesse Jacob / iBureauet / Information Daily", "permalink": "/Jesse Jacob", "username": "Jesse Jacob" }, "uploader_id": "50959", "year": 2009 }, { "attribution": "Fish by Teresa S Garner from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/24913-600.png", "collections": [], "date_uploaded": "2013-10-20", "icon_url": "https://static.thenounproject.com/svg/3671fe0b-56db-498f-ba71-5c344379a126.svg?Expires=1425590518&Signature=K9dLQGWzwpkomOhio2Ob0QkuSKLlgHej8~~mLZxLLtNcs4hvsQauKlW96JR36uO7mZq~YKjLpQCJ-cDsEHdUnle9hp1PDAznugHyWLPxJXQq~QTmpaQQZn1IBPwXXpab~FD9nCwSn8uQnSpNwStN9qsqrPrCwOs2zOpHeGdzwhw_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "24913", "is_active": "1", "license_description": "public-domain", "permalink": "/term/fish/24913", "preview_url": "https://static.thenounproject.com/png/24913-200.png", "preview_url_42": "https://static.thenounproject.com/png/24913-42.png", "preview_url_84": "https://static.thenounproject.com/png/24913-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Fish", "term_id": 246, "term_slug": "fish", "uploader": { "location": "US", "name": "Teresa S Garner", "permalink": "/sgarner", "username": "sgarner" }, "uploader_id": "214620", "year": 2013 } ] }
Usage¶
- GET /oauth/usage¶
Returns current oauth usage and limits
Request:
GET http://api.thenounproject.com/oauth/usageResponse:
{ "limits": { "daily": null, "hourly": null, "monthly": 5000 }, "usage": { "daily": 30, "hourly": 16, "monthly": 32 } }
User¶
- GET /user/(string: username)/uploads¶
Returns a list of uploads associated with a user
- Parameters:
username (string) – username
- 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
Note
Asset URLs are temporary and will expire within an hour after the call. Following that duration, a new call will be required to retrieve a new asset URL.
A default call returns up to 50 results. By using the limit, offset, and page parameters, additional data can be retrieved. Setting the page parameter will override the offset parameter.
Request:
GET http://api.thenounproject.com/user/edward/uploads?limit=2Response:
{ "generated_at": "Thu, 05 Mar 2015 20:21:59 GMT", "uploads": [ { "attribution": "Brazil by Edward Boatman from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/67379-600.png", "date_uploaded": "2014-08-28", "icon_url": "https://static.thenounproject.com/icon_uploads/51abe2a5-b196-4b9b-97c8-681de2afd3b2.svg?Expires=1425590519&Signature=CDO8gLIDjxy2y~5~CCOsdpvLKl6VTOtwdZafLsy0ectxzbtdg3qnZYKm0UveC1PG3ikrFzMuRrBnyg5tCzSTs501pctb7uJz7Ir29CErMwD9~IfYhB-KNkZSg68rBzFSQrEKJ0ZQLUPyVPTPluYY2OggADfHTANdPajX363djOo_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "67379", "is_active": "1", "license_description": "public-domain", "permalink": "/edward/icon/67379", "preview_url": "https://static.thenounproject.com/png/67379-200.png", "preview_url_42": "https://static.thenounproject.com/png/67379-42.png", "preview_url_84": "https://static.thenounproject.com/png/67379-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Brazil", "term_id": "", "term_slug": "", "uploader": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "uploader_id": "6", "year": 2014 }, { "attribution": "Israel by Edward Boatman from The Noun Project", "attribution_preview_url": "https://static.thenounproject.com/attribution/67345-600.png", "date_uploaded": "2014-08-28", "icon_url": "https://static.thenounproject.com/icon_uploads/bde7c9e5-c9ab-40d7-a966-f89300a53f56.svg?Expires=1425590519&Signature=ddns0ETyhxoGTJMgJWVoUaDYxMDNlP5kLWLFYyJRkzD6ONplr5j6~7oqXYOemjFb3yDzPSL1gMxjOlh8ttOnaaCUmuLlMvsQCabgTSrp5iFWnJVMvmqZ~VaOB026JsaJN3FQ84cZHISVzDuxkGyHXjaANJfGqNZOrqR~23GDCUM_&Key-Pair-Id=APKAI5ZVHAXN65CHVU2Q", "id": "67345", "is_active": "1", "license_description": "public-domain", "permalink": "/edward/icon/67345", "preview_url": "https://static.thenounproject.com/png/67345-200.png", "preview_url_42": "https://static.thenounproject.com/png/67345-42.png", "preview_url_84": "https://static.thenounproject.com/png/67345-84.png", "sponsor": {}, "sponsor_campaign_link": null, "sponsor_id": "", "term": "Israel", "term_id": "", "term_slug": "", "uploader": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "uploader_id": "6", "year": 2014 } ] }
- GET /user/(int: user_id)/collections¶
Returns a list of collections associated with a user
- Parameters:
user_id (int) – user id
Request:
GET http://api.thenounproject.com/user/6/collectionsResponse:
{ "collections": [ { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-08-21 17:39:19", "date_updated": "2012-08-21 17:40:15", "description": "", "id": "15", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "1", "name": "Truck", "permalink": "/edward/collection/truck", "slug": "truck", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:07", "date_updated": "2012-10-16 15:37:06", "description": "", "id": "1", "is_collaborative": "", "is_featured": "0", "is_published": "0", "is_store_item": "0", "name": "Noun Collection", "permalink": "/edward/collection/noun-collection", "slug": "noun-collection", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:26", "date_updated": "2012-01-27 19:15:26", "description": "", "id": "2", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "0", "name": "National Park Service", "permalink": "/edward/collection/national-park-service", "slug": "national-park-service", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-02-15 13:47:32", "date_updated": "2012-02-15 14:13:13", "description": "", "id": "6", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "0", "name": "Health Care Symbols", "permalink": "/edward/collection/health-care-symbols", "slug": "health-care-symbols", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2014-08-26 00:00:01", "date_updated": "2014-08-26 00:00:01", "description": "", "id": "913", "is_collaborative": "1", "is_featured": "0", "is_published": "0", "is_store_item": "0", "name": "Face Lines", "permalink": "/edward/collection/face-lines", "slug": "face-lines", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [ "face", "line", "faceline", "drawing", "illustration", "cartoon", "abstract", "abstract face", "single line", "one line", "facial features", "person" ], "template": "24" }, { "author": { "location": "Los Angeles, US", "name": "Edward Boatman", "permalink": "/edward", "username": "edward" }, "author_id": "6", "date_created": "2012-01-27 19:15:26", "date_updated": "2012-09-27 13:27:02", "description": "", "id": "3", "is_collaborative": "", "is_featured": "1", "is_published": "1", "is_store_item": "0", "name": "AIGA", "permalink": "/edward/collection/aiga", "slug": "aiga", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } ] }
- GET /user/(int: user_id)/collections/(slug)¶
Returns a single collection associated with a user
- Parameters:
user_id (int) – user id
slug (string) – collection slug
Request:
GET http://api.thenounproject.com/user/1/collections/bicycleResponse:
{ "collection": { "author": { "location": "US", "name": "mnmly", "permalink": "/mnmly", "username": "mnmly" }, "author_id": "1", "date_created": "2012-02-22 13:32:49", "date_updated": "2012-02-22 13:33:00", "description": "", "icon_count": "3", "id": "7", "is_collaborative": "", "is_featured": "0", "is_published": "0", "is_store_item": "1", "name": "Bicycle", "permalink": "/mnmly/collection/bicycle", "slug": "bicycle", "sponsor": {}, "sponsor_campaign_link": "", "sponsor_id": "", "tags": [], "template": "24" } }
Enterprise¶
- POST /notify/publish¶
Accepts icon ids for reporting icon usage
- JSON Parameters:
icons (string) – a string containing icon ids separated by commas
Important
Enterprise clients are required to report icon usage
Note
To test endpoint without reporting data, use
/notify/publish?test=1
Request:
POST http://api.thenounproject.com/notify/publishData:
{ "icons": "42,143,1337" }Response:
{ "licenses_consumed": 3, "result": "success" }