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/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:
1
var
requestOptions
=
{
2
method
:
'GET'
,
3
redirect
:
'follow'
4
}
;
5
6
fetch
(
"http://localhost:41595/api/item/list?orderBy=-RESOLUTION&limit=10&ext=svg&name=character&folders=KB90R2VNPHH3V&tags=test,test2"
,
requestOptions
)
7
.
then
(
response
=>
response
.
json
(
)
)
8
.
then
(
result
=>
console
.
log
(
result
)
)
9
.
catch
(
error
=>
console
.
log
(
'error'
,
error
)
)
;
Copied!
Results Returned:
1
{
2
"status"
:
"success"
,
3
"data"
:
[
4
{
5
"id"
:
"KB91GNOPDDVTH"
,
6
"name"
:
"running-man"
,
7
"size"
:
36382
,
8
"ext"
:
"svg"
,
9
"tags"
:
[
]
,
10
"folders"
:
[
11
"KB90QZMU641LI"
12
]
,
13
"isDeleted"
:
false
,
14
"url"
:
"https://cn.eagle.cool/extensions"
,
15
"annotation"
:
""
,
16
"modificationTime"
:
1591774540009
,
17
"height"
:
166
,
18
"width"
:
203
,
19
"lastModified"
:
1591774540171
,
20
"palettes"
:
[
21
{
22
"color"
:
[
23
236
,
24
240
,
25
242
26
]
,
27
"ratio"
:
44
28
}
,
29
{
30
"color"
:
[
31
66
,
32
141
,
33
250
34
]
,
35
"ratio"
:
30
36
}
,
37
{
38
"color"
:
[
39
32
,
40
40
,
41
72
42
]
,
43
"ratio"
:
9
44
}
,
45
{
46
"color"
:
[
47
233
,
48
167
,
49
20
50
]
,
51
"ratio"
:
5
52
}
,
53
{
54
"color"
:
[
55
84
,
56
76
,
57
132
58
]
,
59
"ratio"
:
4.65
60
}
,
61
{
62
"color"
:
[
63
134
,
64
188
,
65
244
66
]
,
67
"ratio"
:
3.1
68
}
,
69
{
70
"color"
:
[
71
245
,
72
208
,
73
159
74
]
,
75
"ratio"
:
1.11
76
}
,
77
{
78
"color"
:
[
79
36
,
80
204
,
81
252
82
]
,
83
"ratio"
:
1.11
84
}
,
85
{
86
"color"
:
[
87
20
,
88
126
,
89
158
90
]
,
91
"ratio"
:
0.66
92
}
93
]
94
}
,
95
{
96
"id"
:
"KB91IN6THODMA"
,
97
"name"
:
"running-man"
,
98
"size"
:
36382
,
99
"ext"
:
"svg"
,
100
"tags"
:
[
]
,
101
"folders"
:
[
102
"KB90R2VNPHH3V"
103
]
,
104
"isDeleted"
:
false
,
105
"url"
:
"https://cn.eagle.cool/extensions"
,
106
"annotation"
:
""
,
107
"modificationTime"
:
1591774632677
,
108
"height"
:
166
,
109
"width"
:
203
,
110
"lastModified"
:
1591774632941
,
111
"palettes"
:
[
112
{
113
"color"
:
[
114
236
,
115
240
,
116
242
117
]
,
118
"ratio"
:
44
119
}
,
120
{
121
"color"
:
[
122
66
,
123
141
,
124
250
125
]
,
126
"ratio"
:
30
127
}
,
128
{
129
"color"
:
[
130
32
,
131
40
,
132
72
133
]
,
134
"ratio"
:
9
135
}
,
136
{
137
"color"
:
[
138
233
,
139
167
,
140
20
141
]
,
142
"ratio"
:
5
143
}
,
144
{
145
"color"
:
[
146
84
,
147
76
,
148
132
149
]
,
150
"ratio"
:
4.65
151
}
,
152
{
153
"color"
:
[
154
134
,
155
188
,
156
244
157
]
,
158
"ratio"
:
3.1
159
}
,
160
{
161
"color"
:
[
162
245
,
163
208
,
164
159
165
]
,
166
"ratio"
:
1.11
167
}
,
168
{
169
"color"
:
[
170
36
,
171
204
,
172
252
173
]
,
174
"ratio"
:
1.11
175
}
,
176
{
177
"color"
:
[
178
20
,
179
126
,
180
158
181
]
,
182
"ratio"
:
0.66
183
}
184
]
185
}
,
186
{
187
"id"
:
"KB91IUWS7VJVF"
,
188
"name"
:
"running-man"
,
189
"size"
:
36382
,
190
"ext"
:
"svg"
,
191
"tags"
:
[
]
,
192
"folders"
:
[
193
"KB90QZMU641LI"
194
]
,
195
"isDeleted"
:
false
,
196
"url"
:
"https://cn.eagle.cool/extensions"
,
197
"annotation"
:
""
,
198
"modificationTime"
:
1591774642684
,
199
"height"
:
166
,
200
"width"
:
203
,
201
"lastModified"
:
1591774643006
,
202
"palettes"
:
[
203
{
204
"color"
:
[
205
236
,
206
240
,
207
242
208
]
,
209
"ratio"
:
44
210
}
,
211
{
212
"color"
:
[
213
66
,
214
141
,
215
250
216
]
,
217
"ratio"
:
30
218
}
,
219
{
220
"color"
:
[
221
32
,
222
40
,
223
72
224
]
,
225
"ratio"
:
9
226
}
,
227
{
228
"color"
:
[
229
233
,
230
167
,
231
20
232
]
,
233
"ratio"
:
5
234
}
,
235
{
236
"color"
:
[
237
84
,
238
76
,
239
132
240
]
,
241
"ratio"
:
4.65
242
}
,
243
{
244
"color"
:
[
245
134
,
246
188
,
247
244
248
]
,
249
"ratio"
:
3.1
250
}
,
251
{
252
"color"
:
[
253
245
,
254
208
,
255
159
256
]
,
257
"ratio"
:
1.11
258
}
,
259
{
260
"color"
:
[
261
36
,
262
204
,
263
252
264
]
,
265
"ratio"
:
1.11
266
}
,
267
{
268
"color"
:
[
269
20
,
270
126
,
271
158
272
]
,
273
"ratio"
:
0.66
274
}
275
]
276
}
277
]
278
}
Copied!
Item - Previous
/api/item/thumbnail
Next - Item
/api/item/refreshPalette
Last modified
9mo ago
Copy link