search_icons

Search and retrieve icons using specific parameters like term, slug, or filters. Customize results by setting page size, ordering, thumbnail dimensions, or icon family.

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/json
- Response 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/json
- Response Properties:
- Example:

{
  "message": "message"
}

401: Unauthorized - The client must authenticate itself to get the requested response.
- Content-Type: application/json
- Response Properties:
- Example:

{
  "message": "message"
}

404: Not Found - The server can not find the requested resource.
- Content-Type: application/json
- Response Properties:
- Example:

{
  "message": "message"
}

500: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
- Content-Type: application/json
- Response 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.
`family-id`	No	Icon family id.
`filters`	No	Filter parameters for icons
`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.

Input Schema (JSON Schema)

{
  "properties": {
    "Accept-Language": {
      "description": "Specifies the search query language using the ISO 639-1 (2-letter\nlanguage code) and the ISO 3166-1 (2-letter country code) for language variants.\nThe API will use \"en-US\" as a default language for processing if a code is not\nprovided, or does not exist.\n",
      "type": "string"
    },
    "family-id": {
      "description": "Icon family id.",
      "minimum": 1,
      "type": "integer"
    },
    "filters": {
      "description": "Filter parameters for icons",
      "properties": {
        "color": {
          "description": "Filter by color.",
          "enum": [
            "gradient",
            "solid-black",
            "multicolor",
            "azure",
            "black",
            "blue",
            "chartreuse",
            "cyan",
            "gray",
            "green",
            "orange",
            "red",
            "rose",
            "spring-green",
            "violet",
            "white",
            "yellow"
          ],
          "example": "red",
          "type": "string"
        },
        "free_svg": {
          "default": "all",
          "description": "Filter by free svg, for free or premium item or all for both",
          "enum": [
            "all",
            "free",
            "premium"
          ],
          "example": "free",
          "type": "string"
        },
        "icon_type": {
          "description": "Filter of available icon types.",
          "example": [
            "standard",
            "sticker"
          ],
          "items": {
            "enum": [
              "standard",
              "animated",
              "sticker",
              "uicon"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "period": {
          "default": "all",
          "description": "Filter by period.",
          "enum": [
            "three-months",
            "six-months",
            "one-year",
            "all"
          ],
          "example": "all",
          "type": "string"
        },
        "shape": {
          "description": "Filter by shape.",
          "enum": [
            "outline",
            "fill",
            "lineal-color",
            "hand-drawn"
          ],
          "example": "outline",
          "type": "string"
        }
      },
      "type": "object"
    },
    "order": {
      "default": "relevance",
      "description": "Define order of results.\n- Note: If the term or slug parameter is used, the order will be the similarity of the search.\n",
      "enum": [
        "relevance",
        "recent"
      ],
      "type": "string"
    },
    "page": {
      "description": "Page number. It must be greater than 0.",
      "type": "integer"
    },
    "per_page": {
      "description": "Results per page. It must be greater than 0.",
      "type": "integer"
    },
    "slug": {
      "description": "Search by slug",
      "type": "string"
    },
    "term": {
      "description": "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",
      "type": "string"
    },
    "thumbnail_size": {
      "description": "Size of the thumbnail. \nIf the size is not specified, the API will return 128 as a default size.\n",
      "type": "string"
    }
  },
  "required": [],
  "type": "object"
}

Freepik FastMCP Toolkit

search_icons

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Freepik FastMCP Toolkit

Related Tools

MCP directory API