test

Parameters
Responses
200 bad_request

The request was malformed.

Body
Examples
200 invalid_<parameter>

The request was malformed. The query parameter parameter contains an invalid value.

200 bad_credentials

Invalid credentials were used to authenticate the request.

200 permission_denied

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!

200 insufficient_permissions

The authentication used does not have the required permissions to access the requested resource. Make sure the authentication was performed with the necessary scope.

200 not_purchased

The premium resource you're trying to access has not been purchased by the authenticated user.

200 not_found

The requested resource does not exist or is not publicly available.

200 rate_limit_exceeded

API request rate limit exceeded. See rate limiting.

200 server_error

An internal server error occured. This shouldn't happen, and robots will be dispatched to deal with it immediately.

Operations
GET /oauth2/authorize
GET /oauth2/token
GET /authors/{author id}
GET /categories
GET /categories/{category identifier}
GET /iconsets/{icon set identifier}/icons
GET /icons/{icon id}
POST /icons/search
GET /styles/{style identifier}/iconsets
GET /categories/{category identifier}/iconsets
GET /v2/users/{userid or username}/iconsets
GET /authors/{author id}/iconsets
GET /iconsets/{icon set id or identifier}
GET /licenses/{license id}
GET /styles
GET /styles/{style identifier}
GET /users/{userid or username}
Begin the authorization flow
GET /oauth2/authorize

The method is used to begin the authorization flow

Request parameters

client_id
string optional

your application's client ID.

response_type
string required

Response type. Must be code for web application registration.

scope
string optional

Optional comma separated list of scopes. See scopes for more details.

state
string optional

Optional random string used to protect against cross site request forgery attacks.

Responses

200 200

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.

Obtain access token
GET /oauth2/token

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

client_id
string required

Your application's client ID.

client_secret
string required

Your application's client secret.

code
string required

The intermediate code received from Iconfinder. The result of Begin the authorization flow

grant_type
string required

Grant type. Must be authorization_code to indicate that the token is granted based on an authorization code.

Responses

200 200

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
Object
access_token
string
Example:
mUZrfE9MJySA1YTyGl9HsMjIypWNtl9jqjpfqxMKakdV00Fkh6C38gZkztrtCzWS
token_type
string
Example:
Bearer
Get author details
GET /authors/{author id}

Get details about a specific author identified by a unique ID.

Path variables

author id
string required

Author ID

Request body

Responses

200 200

OK

List all categories
GET /categories

List all categories sorted ascendingly by their identifier.

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

Responses

200 200

OK

Body
Object
total_count
number double
Example:
40
categories
Get category details
GET /categories/{category identifier}

t details about a specific category identified by its identifier.

Path variables

category identifier
string required

Responses

200 200

OK

Body
List all icons in an icon set
GET /iconsets/{icon set identifier}/icons

Provides a list of all icons in an icon set sorted descendingly by the popularity of the icons.

Path variables

icon set identifier
string required

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
integer optional

Icon ID of the last icon received. If empty, the count most popular icons are returned.

Responses

200 200

OK

Body
Object
total_count
number double
Example:
1
icons
Get icon details
GET /icons/{icon id}

Get details about a specific icon.

Path variables

icon id
string required

Responses

200 200

OK

Body
Search for icons
POST /icons/search

Search through icons by various criteria. The returned list of icons is ordered descendingly by popularity.

Request parameters

query
string required

Search query

offset
number optional

Result offset. Starts from 0, resulting in the first count icons being returned.

Min:0
size_minimum
number optional

Minimum icon size to include in search result.

Default:
0
size_maximum
number optional

Maximum icon size to include in search result.

Default:
512
category
string optional

icon category

style
string optional

icon style

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
Example:
442
icons
List all public icon sets
GET /iconsets

List all public icon sets in descending order of when they were published.

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
List icon sets of a specific style
GET /styles/{style identifier}/iconsets

List public icon sets of a specific style in descending order of when they were published.

Path variables

style identifier
string required

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
List icon sets in a category
GET /categories/{category identifier}/iconsets

List public icon sets in a category in descending order of when they were published.

Path variables

category identifier
string required

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
List a user's icon sets
GET /v2/users/{userid or username}/iconsets

List all public icon sets owned by a specific user in descending order of when they were published.

Path variables

userid or username
string required

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
List an author's icon sets
GET /authors/{author id}/iconsets

List all public icon sets owned by a specific author in descending order of when they were published.

Path variables

author id
string required

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
List an authenticated user's icon sets
GET /user/iconsets

List all public icon sets owned by the authenticated user in descending order of when they were published.

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

premium
string optional

Filter premium icon sets.

Enumeration:
all
0
1
vector
string optional

Filter vector icon sets.

Enumeration:
all
0
1
license
string optional

Filter by license scope.

Enumeration:
none
commercial
commercial-nonattribution

Responses

200 200

OK

Body
Object
total_count
string
iconsets
Array of Iconset
Get icon set details
GET /iconsets/{icon set id or identifier}

Get details about a specific icon set.

Path variables

icon set id or identifier
string required

Responses

200 200

OK

Body
Get license details
GET /licenses/{license id}

Get details about a specific license by its unique ID.

Path variables

license id
string required

Responses

200 200

OK

Body
List all styles
GET /styles

List all styles sorted ascendingly by their identifier.

Request parameters

count
integer optional

Number of icon sets to include in the result.

Min:1 Max:100
Default:
100
after
string optional

identifier of the last entity received. If empty, the count first categories are returned.

Responses

200 200

OK

Body
Object
total_count
number double
Example:
9
styles
Object
identifier
string
Example:
3d
name
string
Example:
3D
Get style details
GET /styles/{style identifier}

Get details about a specific style identified by its identifier.

Path variables

style identifier
string required

Responses

200 200

OK

Body
Object
identifier
string
Example:
flat
name
string
Example:
Flat
Get user details
GET /users/{userid or username}

Get details about a specific user.

Path variables

userid or username
string required

Responses

200 200

OK

Body
Type Definitions
Author

See Format Model bold

Object
website_url
string
Example:
http://www.everaldo.com/
name
string
Example:
Everaldo Coelho
author_id
number double
Example:
2
iconsets_count
number double
Example:
12
Category
Object
identifier
string
Example:
halloween
name
string
Example:
Halloween
Format
Object
preview_url
string
Example:
https://cdn1.iconfinder.com/data/icons/streamline-business-finance/60/cell-0-12-30.png
download_url
string
Example:
/icons/233366/formats/png/30/download
format
string
Example:
png
Types: Icon
IdAndName

Name - Description pair

Object
identifier
string
Example:
outline
name
string
Example:
Outline
Types: Icon Iconset
License
Object
license_id
number double
Example:
71
scope
string
Example:
free
name
string
Example:
Basic license
url
string
Example:
https://www.iconfinder.com/licenses/basic
Types: Price
Price
Object
license
price
number double
Example:
1
currency
string
Example:
USD
Types: Icon Iconset
Icon
Object
temp

test enums

primiti
Object
vector_sizes
Array
Object
formats
Array of IdAndName
size
number double
Example:
60
size_height
number double
Example:
60
size_width
number double
Example:
60
target_sizes
Array
Object
0
number double
Example:
30
1
number double
Example:
60
2
number double
Example:
120
3
number double
Example:
180
4
number double
Example:
240
5
number double
Example:
480
icon_id
number double
Example:
233366
type
string
Example:
vector
tags
Array of string
Example:
interest
raster_sizes
Array
Object
formats
Array of Format
size
number double
Example:
30
size_height
number double
Example:
30
size_width
number double
Example:
30
is_premium
boolean
Example:
true
styles
Array of IdAndName
containers
Array of Format
categories
Array of IdAndName
published_at
string
Example:
2014-01-24T12:00:14.811Z
prices
Array of Price
Iconset
Object
identifier
string
Example:
coloricons-5
is_premium
boolean
Example:
true
author
name
string
Example:
Coloricons 5
iconset_id
number double
Example:
5411
styles
Array of IdAndName
icons_count
number double
Example:
50
categories
Array of IdAndName
published_at
string
Example:
2014-05-29T11:38:43.852Z
prices
Array of Price
type
string
Example:
vector
User
Object
is_designer
boolean
Example:
true
social_twitter
string
Example:
webalys
website_url
string
Example:
http://www.webalys.com/
user_id
number double
Example:
40097
social_dribbble
string
Example:
webalys
name
string
Example:
Vincent Le Moign
company
string
Example:
Webalys
location
string
Example:
Hong Kong
iconsets_count
number double
Example:
74
username
string
Example:
webalys
Types: Iconset
SearchforiconsRequest

ewf

Object
in_reply_to_status_id_str
Object
in_reply_to_status_id
Object
possibly_sensitive
boolean
Example:
false
coordinates
Object
truncated
boolean
Example:
false
created_at
string
Example:
Wed Aug 29 17:12:58 +0000 2012
in_reply_to_user_id_str
Object
source
string
Example:
<a href="http://sites.google.com/site/yorufukurou/" rel="nofollow">YoruFukurou</a>
retweet_count
number double
Example:
121
retweeted
boolean
Example:
false
geo
Object
in_reply_to_screen_name
Object
entities
Object
id_str
string
Example:
240859602684612608
in_reply_to_user_id
Object
contributors
Object
text
string
Example:
Introducing the Twitter Certified Products Program: https://t.co/MjJ8xAnT
id
number double
Example:
240859602684612600
place
Object
user
Object
favorited
boolean
Example:
false
Error model
Object
code
string
Example:
not_found
message
string
Example:
Not found
Test enum

ewfwef

string
Enumeration:
wefwef
Types: Icon