Eagle API Document
Search…
Eagle API Document
Overview
Application
/api/application/info
Folder
/api/folder/create
/api/folder/rename
/api/folder/update
/api/folder/list
/api/folder/listRecent
Item
/api/item/addFromURL
/api/item/addFromURLs
/api/item/addFromPath
/api/item/addFromPaths
/api/item/addBookmark
/api/item/info
/api/item/thumbnail
/api/item/list
/api/item/moveToTrash
/api/item/refreshPalette
/api/item/refreshThumbnail
/api/item/update
Library
/api/library/info
/api/library/history
/api/library/switch
Examples
Using Eagle API with Tampermonkey
Changelog
Powered By GitBook
/api/item/list
GET Get items that match the filter condition.
​
Parameter
Description
limit
The number of items to be displayed. the default number is 200
orderBy
The sorting order.CREATEDATE , FILESIZE , NAME , RESOLUTION , add a minus sign for descending order: -FILESIZE
keyword
Filter by the keyword
ext
Filter by the extension type, e.g.: jpg , png
tags
Filter by tags. Use , to divide different tags. E.g.: Design, Poster
folders
Filter by Folders. Use , to divide folder IDs. E.g.: KAY6NTU6UYI5Q,KBJ8Z60O88VMG
Sample Code:
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
​
fetch("http://localhost:41595/api/item/list?orderBy=-RESOLUTION&limit=10&ext=svg&name=character&folders=KB90R2VNPHH3V&tags=test,test2", requestOptions)
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.log('error', error));
Results Returned:
{
"status": "success",
"data": [
{
"id": "KB91GNOPDDVTH",
"name": "running-man",
"size": 36382,
"ext": "svg",
"tags": [],
"folders": [
"KB90QZMU641LI"
],
"isDeleted": false,
"url": "https://cn.eagle.cool/extensions",
"annotation": "",
"modificationTime": 1591774540009,
"height": 166,
"width": 203,
"lastModified": 1591774540171,
"palettes": [
{
"color": [
236,
240,
242
],
"ratio": 44
},
{
"color": [
66,
141,
250
],
"ratio": 30
},
{
"color": [
32,
40,
72
],
"ratio": 9
},
{
"color": [
233,
167,
20
],
"ratio": 5
},
{
"color": [
84,
76,
132
],
"ratio": 4.65
},
{
"color": [
134,
188,
244
],
"ratio": 3.1
},
{
"color": [
245,
208,
159
],
"ratio": 1.11
},
{
"color": [
36,
204,
252
],
"ratio": 1.11
},
{
"color": [
20,
126,
158
],
"ratio": 0.66
}
]
},
{
"id": "KB91IN6THODMA",
"name": "running-man",
"size": 36382,
"ext": "svg",
"tags": [],
"folders": [
"KB90R2VNPHH3V"
],
"isDeleted": false,
"url": "https://cn.eagle.cool/extensions",
"annotation": "",
"modificationTime": 1591774632677,
"height": 166,
"width": 203,
"lastModified": 1591774632941,
"palettes": [
{
"color": [
236,
240,
242
],
"ratio": 44
},
{
"color": [
66,
141,
250
],
"ratio": 30
},
{
"color": [
32,
40,
72
],
"ratio": 9
},
{
"color": [
233,
167,
20
],
"ratio": 5
},
{
"color": [
84,
76,
132
],
"ratio": 4.65
},
{
"color": [
134,
188,
244
],
"ratio": 3.1
},
{
"color": [
245,
208,
159
],
"ratio": 1.11
},
{
"color": [
36,
204,
252
],
"ratio": 1.11
},
{
"color": [
20,
126,
158
],
"ratio": 0.66
}
]
},
{
"id": "KB91IUWS7VJVF",
"name": "running-man",
"size": 36382,
"ext": "svg",
"tags": [],
"folders": [
"KB90QZMU641LI"
],
"isDeleted": false,
"url": "https://cn.eagle.cool/extensions",
"annotation": "",
"modificationTime": 1591774642684,
"height": 166,
"width": 203,
"lastModified": 1591774643006,
"palettes": [
{
"color": [
236,
240,
242
],
"ratio": 44
},
{
"color": [
66,
141,
250
],
"ratio": 30
},
{
"color": [
32,
40,
72
],
"ratio": 9
},
{
"color": [
233,
167,
20
],
"ratio": 5
},
{
"color": [
84,
76,
132
],
"ratio": 4.65
},
{
"color": [
134,
188,
244
],
"ratio": 3.1
},
{
"color": [
245,
208,
159
],
"ratio": 1.11
},
{
"color": [
36,
204,
252
],
"ratio": 1.11
},
{
"color": [
20,
126,
158
],
"ratio": 0.66
}
]
}
]
}
​
Item - Previous
/api/item/thumbnail
Next - Item
/api/item/moveToTrash
Last modified 1yr ago
Copy link