https://github.com/jonasgeiler/Iconmonstr-API
An unofficial API to access icons from iconmonstr.com
https://github.com/jonasgeiler/Iconmonstr-API
api collection collections crawler eps font icon icon-font iconmonstr iconmonstr-api icons image images png psd scraper svg unofficial vector vector-graphics
Last synced: 7 months ago
JSON representation
An unofficial API to access icons from iconmonstr.com
- Host: GitHub
- URL: https://github.com/jonasgeiler/Iconmonstr-API
- Owner: jonasgeiler
- License: mit
- Created: 2019-03-05T20:29:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-28T14:38:34.000Z (about 6 years ago)
- Last Synced: 2025-03-07T16:54:28.200Z (7 months ago)
- Topics: api, collection, collections, crawler, eps, font, icon, icon-font, iconmonstr, iconmonstr-api, icons, image, images, png, psd, scraper, svg, unofficial, vector, vector-graphics
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iconmonstr API
This is an unofficial API for iconmonstr.com!
Fetch icons, collections and other directly from their website.
This page crawls all data from iconmonstr.com, no database is used.
That's why the requests can take some time occasionally.
The API was made in PHP 7 with the limonade.php framework.
## Installation
If you don't want to use my free-hosted API, you can install it by yourself.
All you need is PHP 7! (other versions not tested - might work)
There's no configuration or anything needed. Just upload the whole repo onto your server!
## Todo
- [ ] Better error messages
- [ ] Search for collections
- [ ] png support for icons (costumizing and coloring images and getting their download link)
## API
Please note that the api is not fully RESTful!
- Icons
- [GET /icons/search/](#get-iconssearch)
- [GET /icons/popular/](#get-iconspopular)
- [GET /icons/new/](#get-iconsnew)
- [GET /icons/:slug/](#get-iconsslug)
- Categories
- [GET /categories/](#get-categories)
- [GET /categories/:slug/](#get-categoryslug)
- Collections
- [GET /collections/](#get-collections)
- [GET /collections/:slug/](#get-collectionsslug)
- Icon Requests
- [GET /icon-requests/](#get-icon-requests)
- [GET /icon-requests/:slug/](#get-icon-requestsslug)
### GET /icons/search/
> Get icons by search query
#### Resource URL
`https://iconmonstr-api.2ix.at/icons/search/`
#### Parameters
Parameter | Description
--------- | -----------
**query**
*required* | Search query.
**Example Values**: `Arrow`
**filter**
*optional* | Icon Filter (`all`, `fill`, `bold` or `thin` - defaults to `all`).
**Example Value**: `fill`
**page**
*optional* | The page to retrieve (defaults to `1`).
**Example Value**: `2`
#### Example Request
##### Request URL:
GET `https://iconmonstr-api.2ix.at/icons/search?query=Arrow&filter=fill`
##### Response:
```javascript
{
"success": true, // False if an error occurred (to be done)
"pages": 2, // Amount of pages
"icons": [
{
"slug": "cursor-11-svg", // The slug of the icon (useful for urls)
"previewImage": "https://cdns.iconmonstr.com/wp-content/assets/preview/2013/96/iconmonstr-cursor-11.png", // Preview image of the icon
"name": "Arrow 80", // Name of the icon
"likes": 2812 // Amount of likes
},
...
]
}
```
### GET /icons/popular/
> Get popular icons
#### Resource URL
`https://iconmonstr-api.2ix.at/icons/popular/`
#### Parameters
Parameter | Description
--------- | -----------
**page**
*optional* | The page to retrieve (defaults to `1`).
**Example Value**: `12`
#### Example Request
##### Request URL:
GET `https://iconmonstr-api.2ix.at/icons/popular?page=12`
##### Response:
```javascript
{
"success": true, // False if an error occurred (to be done)
"pages": 75, // Amount of pages
"icons": [
{
"slug": "lock-21-svg", // The slug of the icon (useful for urls)
"previewImage": "https://cdns.iconmonstr.com/wp-content/assets/preview/2012/96/iconmonstr-lock-21.png", // Preview image of the icon
"name": "Lock 21", // Name of the icon
"likes": 7887 // Amount of likes
},
...
]
}
```
### GET /icons/new/
> Get new icons
#### Resource URL
`https://iconmonstr-api.2ix.at/icons/new/`
#### Parameters
Parameter | Description
--------- | -----------
**page**
*optional* | The page to retrieve (defaults to `1`).
**Example Value**: `3`
**filter**
*optional* | Icon Filter (`all`, `fill-bold` or `thin` - defaults to `all`).
**Example Value**: `thin`
> Note that other than at the `/icons/search` endpoint, there's only a `fill-bold` (no `fill` or `bold` by it's own)
#### Example Request
##### Request URL:
GET `https://iconmonstr-api.2ix.at/icons/new?page=3&filter=thin`
##### Response:
```javascript
{
"success": true, // False if an error occurred (to be done)
"pages": 4, // Amount of pages
"icons": [
{
"slug": "video-thin-svg", // The slug of the icon (useful for urls)
"previewImage": "https://cdns.iconmonstr.com/wp-content/assets/preview/2018/96/iconmonstr-video-thin.png", // Preview image of the icon
"name": "Video", // Name of the icon
"dateInfo": {
"raw": "9 months ago", // The raw date string
"count": "9", // The count of the time unit
"unit": "month", // The time unit (second/minute/day/week/month/year)
"plural": true // Whether the unit is in plural or not (month/months)
}
},
...
]
}
```
### GET /icons/:slug/
> Get a specific icon
#### Resource URL
`https://iconmonstr-api.2ix.at/icons/:slug/`
#### Parameters
Parameter | Description
--------- | -----------
**slug**
*required* | The URL-friendly name of the icon.
**Example Value**: `github-1`
**fileType**
*optional* | The file type of the icon (`svg`, `eps`, `psd` or, if available, `font` - defaults to `svg`).
**Example Value**: `svg`
#### Example Request
##### Request URL:
GET `https://iconmonstr-api.2ix.at/icons/github-1?fileType=svg`
##### Response:
```javascript
{
"success": true, // False if an error occurred (to be done)
"icon": {
"slug": "github-1", // The slug of the icon (useful for urls)
"url": "https://iconmonstr.com/github-1-svg", // URL of the icon
"availableFileTypes": [ // Available file types for the fileType parameter
"svg",
"eps",
"psd",
"png", // NOT YET IMPLEMENTED!!!
"font"
],
"name": "Github 1", // Name of the icon
"previewImage": "https://cdns.iconmonstr.com/wp-content/assets/preview/2012/240/iconmonstr-github-1.png", // Preview image of the icon
"downloadLink": "https://iconmonstr.com/?s2member_file_download_key=b4c27b8119dec7660f7f2adb48227cdc&s2member_file_download=2012/svg/iconmonstr-github-1.svg", // URL to download the icon
"embedCode": "", // Embed code of the icon (only for svg file type)
"similar": [ // Similar icons
"github-4",
"github-2",
"github-3",
"github-5"
],
"tags": [ // Icon tags (useful for search)
"brand",
"github",
"logo",
"multiservice",
"social"
],
"collection": "github" // The collection the icon is in
}
}
```