IconFinder API v 2.0
This is not official version of Iconfinder REST API v2.0 (beta) Link to Official documentation
All API access is performed over HTTPS and accessed from the api.iconfinder.com
domain.
The API version 2.0 is accessed under the v2/
subpath.
This means that the full base path of all the REST API 2.0
endpoints is https://api.iconfinder.com/v2/
, although throughout the documentation
this is shortened to /v2/
.
Usage of the Iconfinder API version 2.0 is subject to the API terms of service.
The Iconfinder API version 2.0 is currently in beta. We will do our best to avoid breaking changes, but consider the current version unstable at the moment.
Where possible, the Iconfinder REST API strives to use appropriate HTTP methods for each action:
Method | Action |
---|---|
HEAD |
Retrieve HTTP header information for one or more resources. Do not rely on this information between requests. |
GET |
Retrieve one or more resources. |
POST |
Create a resource or perform a custom action. |
PATCH |
Partially update a resource. |
PUT |
Completely replace a resource. |
DELETE |
Delete a resource. |
All data is sent as UTF-8 encoded JSON identified by the media type application/json
.
GET https://api.iconfinder.com/v2/
HTTP/1.1 200 OK
Server: nginx
Date: Mon, 21 Apr 2014 13:26:48 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
Content-Length: 194
Data types
Blank fields, ie. fields whose value would be a JSON null, are omitted to keep the response size to a minimum. All timestamps are returned as strings in the ISO 8601 format of arbitrary precision guaranteed to be in UTC:
--T::Z
--T::.Z
Summaries and detailed representations
Depending on the endpoint used, either a summary or a detailed representation
of a resource will be returned. Generally, listing and search endpoints such
as /v2/iconsets
will return summaries while resource specific
endpoints such as /v2/iconsets/<icon set ID>
will return a detailed representation.
While the levels of detail in the representations differ, detailed representations are guaranteed to at least contain the same information in the same structure as summary representations.
The following status codes will be sent from the Iconfinder REST API:
Status code | Meaning |
---|---|
200 OK |
Indicates that a request completed successfully and the response contains data. |
304 Not Modified |
The requested resource has not been modified. |
400 Bad Request |
Client request error as described above. |
401 Unauthorized |
Error indicating that the request was performed with invalid or no authorization information. |
403 Forbidden |
Error indicating that the requesting user has a valid set of credentials but does not have access to the given resource. |
404 Not Found |
Error indicating that the requested resource was not found or, alternatively, is not publicly available. |
The Iconfinder API version 2.0 uses two different methods of pagination for listing resources.
Endpoints with deterministic ordering rely on the last received resource for pagination using
the after
parameter, while non-deterministic endpoints use the more traditional offset
query
parameter. See /v2/iconsets and /v2/icons/search respectively for details.
The Iconfinder API version 2.0 employs strict rate limiting depending on the authentication method.
For OAuth 2.0
authenticated requests, you can make up to 5,000 requests per hour for each authorized user.
For unautheticated requests, you can make 15 requests per minute.
Rate limits may change during the beta period of Iconfinder API version 2.0.
Not all requests count towards your request rate. Using conditional requests to ease the load on Iconfinder’s servers will only count towards your request rate if a resource has changed.
All responses from the API contain information about the current state of rate limiting:
GET https://api.iconfinder.com/v2/iconsets
HTTP/1.1 200 OK
Date: Mon, 21 Apr 2014 13:26:48 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
X-RateLimit-Limit: 15
X-RateLimit-Remaining: 14
X-RateLimit-Reset: Mon, 21 Apr 2014 13:27:48 GMT
The special X-RateLimit-
headers have the following meaning:
Header name | Description |
---|---|
X-RateLimit-Limit |
Current rate limit for the authentication method used. |
X-RateLimit-Remaining |
Requests remaining until rate limit is reached. |
X-RateLimit-Reset |
Time at which the request counter is reset. |
Hitting the wall
If you exceed the request rate limit, the Iconfinder API will return a 429 Too Many Requests
response code with the following content:
GET https://api.iconfinder.com/v2/iconsets
HTTP/1.1 429 Too Many Requests
Date: Mon, 21 Apr 2014 13:27:04 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
X-RateLimit-Limit: 15
X-RateLimit-Remaining: 0
X-RateLimit-Reset: Mon, 21 Apr 2014 13:27:48 GMT
{
"code": "rate_limit_exceeded",
"message": "API rate limit exceeded"
}
If you need a higher rate limit, please contact support with details about your use case.
Unauthenticated requests with higher rate limit
If you need to make unauthenticated requests to the API with a higher rate limit, you can send the client ID and secret of your API application along with the request. The rate limit will then be the same as for an authenticated request, but the limit is applied at an application level rather than authorization level:
GET https://api.iconfinder.com/v2/iconsets?client_id=x&client_secret=y
HTTP/1.1 200 OK
Date: Mon, 21 Apr 2014 13:26:48 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
X-RateLimit-Reset: Mon, 21 Apr 2014 13:27:48 GMT
Only use this method for server-to-server calls. Never share your application’s client secret with anyone or include it in client-side browser code.
Most API version 2.0 endpoints expose a modification time of resources in the Last-Modified
header.
The modification time can be used in subsequent requests to the same endpoints using the
If-Modified-Since
conditional header.
If the resource has not been modified between requests,
the response status code will be 304 Not Modified
.
It is heavily encouraged that server-to-server communications cache responses and use the conditional request mechanisms to reduce the load on the Iconfinder API servers.
The Iconfinder API version 2.0 supports Cross Origin Resource Sharing (CORS) for AJAX requests, independent of the request origin. This means that the API can be used for unauthenticated AJAX requests:
$ curl -i https://api.iconfinder.com/v2/iconsets
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS
Access-Control-Expose-Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Cross-domain policy
For usage in Flash based applications, the Iconfinder API has a cross-domain policy file allowing full access over HTTPS. See https://api.iconfinder.com/crossdomain.xml for details.
The Iconfinder API 2.0 offers both a public and a private part of the API. The public part includes the basic functionality, one would experience as a user of Iconfinder without being logged in. The private part of the API includes access to user information, purchases etc. depending on the authorization scope.
There are currently two ways to authenticate. Using a JSON Web Token or using authorization code. Using the web token will allow you to hide the API access from your users - this will require that your account is on an API subscription plan. The authorization code approach lets your users authenticate using their own Iconfinder accounts.
In order to use OAuth 2.0, you need to register an API application, which will be assigned a unique client ID and client secret.
Once you have registered your application, you need to authorize users to be able to access the Iconfinder API version 2.0 as the specific user. The authorization flow between your application and Iconfinder depends on the type of application you’re developing.
It is very important that the client secret is not shared with anyone. When developing an application that uses OAuth 2.0 you should also make sure to use a strong, unique password for your Iconfinder account.
The method is used to begin the authorization flow
Request parameters
your application’s client ID.
Response type. Must be code
for web application registration.
Optional comma separated list of scopes. See scopes for more details.
Optional random string used to protect against cross site request forgery attacks.
Responses
If the user chooses to authorize your application,
Iconfinder redirects back to your site at the callback URL you configured for your application when registering it.
The URL will include with an intermediate code
in the code request parameter as well as the opaque state
value if provided.
If no code
parameter is provided,
it means that the user did not choose to authorize your application.
If you supplied a state
parameter, make sure to validate this to avoid security vulnerabilities.
Once you have the intermediate code, it must be exchanged for an access token that will be used for all authenticated requests. Access tokens are obtained at the following URL:
Request parameters
Your application’s client ID.
Your application’s client secret.
The intermediate code received from Iconfinder. The result of Begin the authorization flow
Grant type. Must be authorization_code to indicate that the token is granted based on an authorization code
.
Responses
pon successful exchange of the intermediate code, Iconfinder returns a JSON response with the access token and token type issued. Access tokens are guaranteed to be alphanumerical strings of 64 byte lengths:
Body
JSON Web Tokens (JWT) are a standard way of representing security claims between your application and Iconfinder API. A JWT token is simply a signed JSON object which contains information which enables the receiver to authenticate the sender of the request. For more documentation about JWT, see the JWT documentation
Based on an example of a JavaScript based application that makes requests to the Iconfinder API, the sequence diagram will be following:
Generate token server-side
Requesting a new token requires a server-side script that uses the client ID and secret. We have created snippets that can be used as a foundation for your implementation:
- PHP example code can be found on https://github.com/iconfinder/api-demo/tree/gh-pages/php-server
- Node.js project can be found here: https://github.com/iconfinder/api-demo/tree/gh-pages/node-server
- Python example code can be found on https://github.com/iconfinder/api-demo/tree/gh-pages/python-server
Getting a client ID and secret
To generate new tokens you need client ID and secret. You can get these by creating a new API application.
Supported browsers
Authenticating using web tokens requires Cross-Origin Resource Sharing (CORS). To see which users support CORS, please see: http://caniuse.com/#feat=cors
Please find more information for Internet Explorer support on Microsoft’s website
Content on Iconfinder is always associated with a creator, ie. an entity of some sort, that has created the content. But, because Iconfinder both indexes as well as allows content creators to upload their works, not all content is linked to a known user, who created the content. Instead, indexed content created by someone who is not a user on Iconfinder will be represented as the special “author” type rather than the normal user type.
{author id}
Get details about a specific author identified by a unique ID.
Path variables
Author ID
Responses
Body
GET https://api.iconfinder.com/v2/authors/2 HTTP/1.1
Content-Type: application/json
{
"author_id" : 2,
"name" : "Everaldo Coelho",
"iconsets_count" : 12,
"website_url" : "http://www.everaldo.com/"
}
curl -X GET "https://api.iconfinder.com/v2/authors/1"
HTTP/1.1 200 OK
Content-Type: application/json
{
"author_id": 2,
"name": "Everaldo Coelho",
"iconsets_count": 12,
"website_url": "http://www.everaldo.com/"
}
Icons can depict virtually anything and have many different use cases, and it can therefore be difficult to find just the icons you need. On Iconfinder, apart from being tagged, icons and icon sets are assigned to at least one of a predefined set of categories to make it easier to find icons based on use case.
Categories on Iconfinder are identified in the API by their unique, humanly readable identifier
rather than a numerical ID.
List all categories sorted ascendingly by their identifier
.
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Responses
Body
GET https://api.iconfinder.com/v2/categories?count=2 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": 40,
"categories": [
{
"identifier": "abstract",
"name": "Abstract"
},
{
"identifier": "animal",
"name": "Animals"
}
]
}
GET https://api.iconfinder.com/v2/categories?count=1 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": 1,
"categories": [
{
"identifier": "halloween",
"name": "Halloween"
}
]
}
{category identifier}
t details about a specific category identified by its identifier
.
Path variables
Responses
Body
curl -X GET "https://api.iconfinder.com/v2/categories/halloween"
HTTP/1.1 200 OK
Content-Type: application/json
{
"identifier": "halloween",
"name": "Halloween"
}
{icon id}
Get details about a specific icon.
Path variables
Responses
Body
GET https://api.iconfinder.com/v2/icons/11 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"raster_sizes": [
{
"size_width": 30,
"size_height": 30,
"formats": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"size": 30
}
],
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"tags": [
""
],
"icon_id": 233366,
"vector_sizes": [
{
"size_width": 60,
"size_height": 60,
"formats": [
{
"identifier": "outline",
"name": "Outline"
}
],
"target_sizes": [
{
"0": 30,
"1": 60,
"2": 120,
"3": 180,
"4": 240,
"5": 480
}
],
"size": 60
}
],
"is_premium": true,
"published_at": "2014-01-24T12:00:14.811Z",
"containers": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"type": "vector",
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"temp": "wefwef",
"primiti": null
}
{icon set identifier}
/iconsProvides a list of all icons in an icon set sorted descendingly by the popularity of the icons.
Path variables
Request parameters
Number of icon sets to include in the result.
Icon ID of the last icon received. If empty, the count most popular icons are returned.
Responses
Body
GET https://api.iconfinder.com/v2/iconsets/3258/icons HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": 1,
"icons": {
"raster_sizes": [
{
"size_width": 30,
"size_height": 30,
"formats": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"size": 30
}
],
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"tags": [
""
],
"icon_id": 233366,
"vector_sizes": [
{
"size_width": 60,
"size_height": 60,
"formats": [
{
"identifier": "outline",
"name": "Outline"
}
],
"target_sizes": [
{
"0": 30,
"1": 60,
"2": 120,
"3": 180,
"4": 240,
"5": 480
}
],
"size": 60
}
],
"is_premium": true,
"published_at": "2014-01-24T12:00:14.811Z",
"containers": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"type": "vector",
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"temp": "wefwef",
"primiti": null
}
}
Search through icons by various criteria. The returned list of icons is ordered descendingly by popularity.
Request parameters
Search query
Result offset. Starts from 0, resulting in the first count icons being returned.
Minimum icon size to include in search result.
Maximum icon size to include in search result.
icon category
icon style
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
curl -X POST "https://api.iconfinder.com/v2/icons/search?query=cat&offset=1&category=internet"
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": "442",
"icons": {
"raster_sizes": [
{
"size_width": 30,
"size_height": 30,
"formats": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"size": 30
}
],
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"tags": [
""
],
"icon_id": 233366,
"vector_sizes": [
{
"size_width": 60,
"size_height": 60,
"formats": [
{
"identifier": "outline",
"name": "Outline"
}
],
"target_sizes": [
{
"0": 30,
"1": 60,
"2": 120,
"3": 180,
"4": 240,
"5": 480
}
],
"size": 60
}
],
"is_premium": true,
"published_at": "2014-01-24T12:00:14.811Z",
"containers": [
{
"preview_url": "https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png",
"download_url": "/icons/233366/formats/png/30/download",
"format": "png"
}
],
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"type": "vector",
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"temp": "wefwef",
"primiti": null
}
}
List all public icon sets in descending order of when they were published.
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
GET https://api.iconfinder.com/v2/iconsets HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": "",
"iconsets": [
{
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"icons_count": 50,
"author": {
"username": "webalys",
"user_id": 40097,
"name": "Vincent Le Moign",
"iconsets_count": 74,
"company": "Webalys",
"is_designer": true,
"location": "Hong Kong",
"social_twitter": "webalys",
"social_dribbble": "webalys",
"website_url": "http://www.webalys.com/"
},
"is_premium": true,
"published_at": "2014-05-29T11:38:43.852Z",
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"identifier": "coloricons-5",
"type": "vector",
"iconset_id": 5411,
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"name": "Coloricons 5"
}
]
}
{style identifier}
/iconsetsList public icon sets of a specific style in descending order of when they were published.
Path variables
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
{category identifier}
/iconsetsList public icon sets in a category in descending order of when they were published.
Path variables
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
{userid or username}
/iconsetsList all public icon sets owned by a specific user in descending order of when they were published.
Path variables
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
GET https://api.iconfinder.com/v2/v2/users/%username%/iconsets HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"total_count": "",
"iconsets": [
{
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"icons_count": 50,
"author": {
"username": "webalys",
"user_id": 40097,
"name": "Vincent Le Moign",
"iconsets_count": 74,
"company": "Webalys",
"is_designer": true,
"location": "Hong Kong",
"social_twitter": "webalys",
"social_dribbble": "webalys",
"website_url": "http://www.webalys.com/"
},
"is_premium": true,
"published_at": "2014-05-29T11:38:43.852Z",
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"identifier": "coloricons-5",
"type": "vector",
"iconset_id": 5411,
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"name": "Coloricons 5"
}
]
}
{author id}
/iconsetsList all public icon sets owned by a specific author in descending order of when they were published.
Path variables
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
List all public icon sets owned by the authenticated user in descending order of when they were published.
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Filter premium icon sets.
or empty value Include all icon sets no matter if they are premium or not.
or false
Only include icon sets that are not premium, ie. may require purchasing a license for specific use cases but are not sold directly on the Iconfinder marketplace.
or true
Only include premium icon sets, that are sold directly on the Iconfinder marketplace.
Filter vector icon sets.
or empty value Include all icon sets no matter if they are vector or raster icon sets.
or false
Only include raster icon sets in the result.
1
or true
Only include vector icon sets in the result.
Filter by license scope.
Include all icon sets no matter the license
Only include icon sets that can be used commercially, but may require attribution or be restricted by other licensing concerns
Only include icon sets that be used commercially without any attribution requirements
Responses
Body
GET https://api.iconfinder.com/v2/user/iconsets HTTP/1.1
HTTP/1.1 200 OK
{icon set id or identifier}
Get details about a specific icon set.
Path variables
Responses
Body
GET https://api.iconfinder.com/v2/iconsets/cat-power-premium HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"styles": [
{
"identifier": "outline",
"name": "Outline"
}
],
"icons_count": 50,
"author": {
"username": "webalys",
"user_id": 40097,
"name": "Vincent Le Moign",
"iconsets_count": 74,
"company": "Webalys",
"is_designer": true,
"location": "Hong Kong",
"social_twitter": "webalys",
"social_dribbble": "webalys",
"website_url": "http://www.webalys.com/"
},
"is_premium": true,
"published_at": "2014-05-29T11:38:43.852Z",
"prices": [
{
"currency": "USD",
"price": 1,
"license": {
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
}
],
"identifier": "coloricons-5",
"type": "vector",
"iconset_id": 5411,
"categories": [
{
"identifier": "outline",
"name": "Outline"
}
],
"name": "Coloricons 5"
}
{license id}
Get details about a specific license by its unique ID.
Path variables
Responses
Body
GET https://api.iconfinder.com/v2/licenses/71 HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"url": "https://www.iconfinder.com/licenses/basic",
"license_id": 71,
"name": "Basic license",
"scope": "free"
}
Icons – like any other pieces of design – have very distinct styles and follow trends. Therefore, icons and icon sets on Iconfinder are assigned at least one of a set of predefined styles to make it easier for users to find icons and icon sets that will fit their style needs for a given use case.
i
Styles on Iconfinder are identified in the API by their unique, humanly readable identifier
rather than a numerical ID.
List all styles sorted ascendingly by their identifier.
Request parameters
Number of icon sets to include in the result.
identifier
of the last entity received. If empty, the count
first categories are returned.
Responses
Body
GET https://api.iconfinder.com/v2/styles HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"styles": [
{
"identifier": "3d",
"name": "3D"
},
{
"identifier": "cartoon",
"name": "Cartoon"
},
{
"identifier": "flat",
"name": "Flat"
},
{
"identifier": "glyph",
"name": "Glyph"
},
{
"identifier": "handdrawn",
"name": "Handdrawn"
},
{
"identifier": "outline",
"name": "Outline"
},
{
"identifier": "photorealistic",
"name": "Photorealistic"
},
{
"identifier": "pixel",
"name": "Pixel"
},
{
"identifier": "smooth",
"name": "Smooth"
}
],
"total_count": 9
}
{style identifier}
Get details about a specific style identified by its identifier
.
Path variables
Responses
Body
GET https://api.iconfinder.com/v2/styles/flat HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"identifier" : "flat",
"name" : "Flat"
}
{userid or username}
Get details about a specific user.
Path variables
Responses
Body
GET https://api.iconfinder.com/v2/users/webalys HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
{
"username" : "webalys",
"user_id" : 40097,
"name" : "Vincent Le Moign",
"iconsets_count" : 74,
"company" : "Webalys",
"is_designer" : true,
"location" : "Hong Kong",
"social_twitter" : "webalys",
"social_dribbble" : "webalys",
"website_url" : "http://www.webalys.com/"
}
The request was malformed.
The request was malformed. The query parameter
parameter
contains an invalid value.
Body
Invalid credentials were used to authenticate the request.
Body
Permission to the requested resource was denied. This often means that a request should have been authenticated but wasn’t. dispatched to clean up the mess immediately!
Body
The authentication used does not have the required permissions to access the requested resource. Make sure the authentication was performed with the necessary scope.
Body
The premium resource you’re trying to access has not been purchased by the authenticated user.
Body
The requested resource does not exist or is not publicly available.
Body
API request rate limit exceeded. See rate limiting
.
Body
An internal server error occured. This shouldn’t happen, and robots will be dispatched to deal with it immediately.
Body
Concurrent editing
Body
See Format Model bold
interest
test enums
[See docs](doc://Data transmission sdfwef)
ewf
Response wrapper object
Data container
ewfwef
value sescription!