search_icons
Search and filter icons from Freepik's library by term, slug, family, color, shape, and other criteria to find visual assets for projects.
Instructions
Get a list of icons based on the provided parameters and ordering criteria.
Query Parameters:
term: Search term. If only term comes, it is searched for term, if only slug comes, it is searched for slug and if both come, it is searched for slug
slug: Search by slug
page: Page number. It must be greater than 0.
per_page: Results per page. It must be greater than 0.
family-id: Icon family id.
order: Define order of results.
Note: If the term or slug parameter is used, the order will be the similarity of the search.
thumbnail_size: Size of the thumbnail. If the size is not specified, the API will return 128 as a default size.
filters: Filter parameters for icons
Responses:
200 (Success): OK Response
Content-Type:
application/jsonResponse Properties:
Example:
{
"data": [
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library",
"tags": [
{
"name": "Dog",
"slug": "dog"
},
{
"name": "Dog",
"slug": "dog"
}
]
},
{
"free_svg": true,
"created": "2023-03-07T23:05:26Z",
"author": {
"assets": 0,
"name": "John Doe",
"id": 2147483647,
"avatar": "https://avatar.cdnpk.net/61668527-220726032514.jpg",
"slug": "merry-christmas"
},
"name": "a woman reads a book in a tablet sits in the luxurious back of the library",
"style": {
"name": "Meticulous Yellow shadow",
"id": 50
},
"id": 52912,
"family": {
"total": 1200,
"name": "Outline",
"id": 1
},
"thumbnails": [
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
},
{
"width": 512,
"url": "https://v4.cdnpk.net/videvo_files/video/free/video0485/thumbnails/_import_61a866e2519c71.61070863_large.png",
"height": 512
}
],
"slug": "a-woman-reads-a-book-in-a-tablet-sits-in-the-luxurious-back-of-the-library",
"tags": [
{
"name": "Dog",
"slug": "dog"
},
{
"name": "Dog",
"slug": "dog"
}
]
}
],
"meta": {
"pagination": {
"per_page": 1,
"total": 1,
"last_page": 1,
"current_page": 1
}
}
}400: Bad Request - The server could not understand the request due to invalid syntax.
Content-Type:
application/jsonResponse Properties:
Example:
{
"message": "message"
}401: Unauthorized - The client must authenticate itself to get the requested response.
Content-Type:
application/jsonResponse Properties:
Example:
{
"message": "message"
}404: Not Found - The server can not find the requested resource.
Content-Type:
application/jsonResponse Properties:
Example:
{
"message": "message"
}500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
Content-Type:
application/jsonResponse Properties:
Example:
{
"message": "Internal Server Error"
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Accept-Language | No | Specifies the search query language using the ISO 639-1 (2-letter language code) and the ISO 3166-1 (2-letter country code) for language variants. The API will use "en-US" as a default language for processing if a code is not provided, or does not exist. | |
| term | No | Search term. If only term comes, it is searched for term, if only slug comes, it is searched for slug and if both come, it is searched for slug | |
| slug | No | Search by slug | |
| page | No | Page number. It must be greater than 0. | |
| per_page | No | Results per page. It must be greater than 0. | |
| family-id | No | Icon family id. | |
| order | No | Define order of results. - Note: If the term or slug parameter is used, the order will be the similarity of the search. | relevance |
| thumbnail_size | No | Size of the thumbnail. If the size is not specified, the API will return 128 as a default size. | |
| filters | No | Filter parameters for icons |