Icons

Search and filter icons by specified order

Get a list of icons based on the provided parameters and ordering criteria.

get/v1/icons

Request

  • Base URL: https://api.magnific.com
  • URL: https://api.magnific.com/v1/icons
  • Auth: API key in header x-magnific-api-key

Query parameters

termstring

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

slugstring

Search by slug

pageinteger

Page number. It must be greater than 0.

per_pageinteger

Results per page. It must be greater than 0.

family-idinteger

Icon family id.

order'relevance' | 'recent'

Define order of results.

  • Note: If the term or slug parameter is used, the order will be the similarity of the search.
thumbnail_sizestring

Size of the thumbnail. If the size is not specified, the API will return 128 as a default size.

color'gradient' | 'solid-black' | 'multicolor' | 'azure' | 'black' | 'blue' | 'chartreuse' | 'cyan' | 'gray' | 'green' | 'orange' | 'red' | 'rose' | 'spring-green' | 'violet' | 'white' | 'yellow'

Filter by color.

shape'outline' | 'fill' | 'lineal-color' | 'hand-drawn'

Filter by shape.

period'three-months' | 'six-months' | 'one-year' | 'all'

Filter by period.

free_svg'all' | 'free' | 'premium'

Filter by free svg, for free or premium item or all for both

icon_typestring[]

Filter of available icon types.

Filter parameters for icons

{
  "color": "red",
  "shape": "outline",
  "period": "all",
  "free_svg": "free",
  "icon_type": [
    "standard",
    "sticker"
  ]
}

Headers

Accept-Languagestring

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.

Response

OK Response

Example response

{
  "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
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.