search_icons
Search for icons by term, slug, or filters like color, shape, and type. Define order, page, and results per page to retrieve relevant icon data in JSON format.
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.
- filters[color]: Filter by color.
- filters[shape]: Filter by shape.
- filters[period]: Filter by period.
- filters[free_svg]: Filter by free svg, for free or premium item or all for both
- filters[icon_type][]: Filter of available icon types.
- thumbnail_size: Size of the thumbnail. If the size is not specified, the API will return 128 as a default size.
Responses:
- 200 (Success): OK Response
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 400: Bad Request - The server could not understand the request due to invalid syntax.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 404: Not Found - The server can not find the requested resource.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
- 500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type:
application/json
- Response Properties:
- Example:
- Content-Type:
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. | |
family-id | No | Icon family id. | |
filters[color] | No | Filter by color. | |
filters[free_svg] | No | Filter by free svg, for free or premium item or all for both | |
filters[icon_type][] | No | Filter of available icon types. | |
filters[period] | No | Filter by period. | |
filters[shape] | No | Filter by shape. | |
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 |
page | No | Page number. It must be greater than 0. | |
per_page | No | Results per page. It must be greater than 0. | |
slug | No | Search by slug | |
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 | |
thumbnail_size | No | Size of the thumbnail. If the size is not specified, the API will return 128 as a default size. |