Home A - Z
Page Index

An Otter Wiki

Blame

ae9550 DonovanDMC 2026-01-17 00:50:17
1 
# Pools
2
3
Search pools with tags.
4
5
<hr>
6
7
## Search Pools
8
> <code><span style="color: rgb(52, 141, 248);">GET</span></code> `https://pools.e621.church/json`
9
10
::: none
11
# Query Parameters
12
| Name | Type | Description |
13
| ------------------- | ------- | ---------------------------------------------------------------------------------- |
14
| limit | Number | The maximum number of results to return. Between `0` and `320`, defaults to `100`. |
15
| page | Number | The page of results to get. |
16
| cover | Boolean | If cover data should be included. Defaults to false. |
17
| id | Number | ID of the pool. |
18
| name_matches | String | Name of the pool. |
19
| description_matches | String | Description of the pool. |
20
| creator_id | Number | ID of the pool's creator. |
21
| creator_name | String | Name of the pool's creator. |
22
| is_active | Boolean | If the pool is active. |
23
| category | String | `collection`, `series` |
24
| order | String | `name`, `created_at`, `post_count`, `id_asc`, `id_desc` |
25
| tags | String | A space separated set of strings.[^1] |
26
:::
27
28
::: success
29
# 200 OK: Success
30
```json
31
{
32
"pools": [
33
{
34
"id": 0,
35
"name": "NAME",
36
"created_at": "0000-00-00T00:00:00.000",
37
"updated_at": "0000-00-00T00:00:00.000",
38
"creator_id": 0,
39
"description": "",
40
"is_active": true,
41
"category": "series",
42
"post_ids": [
43
13
44
],
45
"tag_string": "tagme"
46
}
47
],
48
"total": 0
49
}
50
```
51
:::
52
53
::: success
54
# 200 OK: Success (With Cover)
55
```json
56
{
57
"pools": [
58
{
59
"id": 0,
60
"name": "NAME",
61
"created_at": "0000-00-00T00:00:00.000",
62
"updated_at": "0000-00-00T00:00:00.000",
63
"creator_id": 0,
64
"description": "",
65
"is_active": true,
66
"category": "series",
67
"post_ids": [
68
13
69
],
70
"tag_string": "tagme"
71
"cover": {
72
// raw post data from e621
73
"post": {
74
"id": 0,
75
"created_at": "0000-00-00T00:00:00.000",
76
"updated_at": "0000-00-00T00:00:00.000",
77
"file": {
78
"width": 0,
79
"height": 0,
80
"ext": "png",
81
"size": 0,
82
"md5": "00000000000000000000000000000000",
83
"url": "https://static1.e621.net/data/00/00/00000000000000000000000000000000.jpg"
84
},
85
"preview": {
86
"width": 0,
87
"height": 0,
88
"url": "https://static1.e621.net/data/preview/00/00/00000000000000000000000000000000.jpg"
89
},
90
"sample": {
91
"has": true,
92
"height": 0,
93
"width": 0,
94
"url": "https://static1.e621.net/data/sample/00/00/00000000000000000000000000000000.jpg",
95
"alternates": {}
96
},
97
"score": {
98
"up": 0,
99
"down": 0,
100
"total": 0
101
},
102
"tags": {
103
"general": [],
104
"artist": [],
105
"contributor": [],
106
"copyright": [],
107
"character": [],
108
"species": [],
109
"invalid": [],
110
"meta": [],
111
"lore": []
112
},
113
"locked_tags": [],
114
"change_seq": 0,
115
"flags": {
116
"pending": false,
117
"flagged": false,
118
"note_locked": false,
119
"status_locked": false,
120
"rating_locked": false,
121
"deleted": false
122
},
123
"rating": "s",
124
"fav_count": 0,
125
"sources": [],
126
"pools": [
127
0
128
],
129
"relationships": {
130
"parent_id": null,
131
"has_children": false,
132
"has_active_children": false,
133
"children": []
134
},
135
"approver_id": null,
136
"uploader_id": 0,
137
"description": "",
138
"comment_count": 0,
139
"is_favorited": false,
140
"has_notes": false,
141
"duration": null
142
},
b9f688 DonovanDMC 2026-01-17 00:50:28
143
// intended to be used to construct ui elements
ae9550 DonovanDMC 2026-01-17 00:50:17
144
"data": {
145
"html_id": "post_0",
146
"html_class": [
147
"thumbnail",
148
"pending",
149
"rating-safe",
150
"blacklistable"
151
],
152
"html_data": {
153
"id": 0,
154
"flags": "",
155
"tags": "tagme",
156
"rating": "s",
157
"file_ext": "png",
158
"width": 0,
159
"height": 0,
160
"size": 0,
161
"created_at": "0000-00-00T00:00:00.000",
162
"uploader": null,
163
"uploader_id": 0,
164
"score": 0,
165
"fav_count": 0,
166
"is_favorited": false,
167
"pools": [
168
0
169
],
170
"md5": "00000000000000000000000000000000",
171
"preview_url": "https://static1.e621.net/data/preview/00/00/00000000000000000000000000000000.jpg",
172
"large_url": "https://static1.e621.net/data/sample/00/00/00000000000000000000000000000000.jpg",
173
"file_url": "https://static1.e621.net/data/00/00/00000000000000000000000000000000.png",
174
"preview_width": 0,
175
"preview_height": 0
176
},
177
"html_tooltip": "Rating: s\nID: 0\nDate: 0000-00-00 00:00:00\nStatus: active\nScore: 0\n\ntagme",
178
"file_url": "https://static1.e621.net/data/sample/00/00/00000000000000000000000000000000.png"
179
}
180
}
181
}
182
],
183
"total": 0
184
}
185
```
186
:::
187
188
[^1]: Metatags and groups are not supported. `-` and `~` are supported. Aliases are resolved.