1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
|
<!DOCTYPE html>
<html class="action-help action-help-show hide-advanced-editing">
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<title>yande.re</title>
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="top" title="yande.re" href="/">
<script type="text/javascript">
var css = ".javascript-hide { display: none !important; }";
var style = document.createElement("style"); style.type = "text/css";
if(style.styleSheet) // IE
style.styleSheet.cssText = css;
else
style.appendChild(document.createTextNode(css));
document.getElementsByTagName("head")[0].appendChild(style);
</script>
<link rel="alternate" type="application/atom+xml" title="ATOM" href="https://yande.re/post/atom?tags=" />
<link rel="stylesheet" href="https://assets.yande.re/assets/application-c99e88fb51193c7d2860b6be344dbb89c941621f4de743808386a02fad731e9f.css" />
<script id="user-blacklisted-tags" type="application/json">
["extreme_content","loli","rating:e"]
</script>
<script type="text/javascript">
window.locale = {
current: "en",
default: "en",
}
</script>
<script src="https://assets.yande.re/assets/application_classic-af217df13af5cc821755e06a0c0e7e9a0d348191b6a3615c43b38dd35d5ed690.js"></script>
<script src="https://assets.yande.re/assets/application-2b7282301e5a28ca19c05e3429b9340e65851a96d0444f6335540b21be25fc4e.jsout"></script>
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="yande.re" />
<meta name="csrf-param" content="authenticity_token" />
<meta name="csrf-token" content="brOyd639quBvmJK8Z-z3F3687F1npB2lE7IM_O4tkqpUKJVDVYVSlBLyJOEDsteXiBHYijDa9OfzYvWZMzu06g" />
<meta name="juicyads-site-verification" content="a42ccc8181bc457cfad43695b47609d8">
<meta name="clckd" content="ca7848b3d8df49a04183874ab5d60e23" />
<style>#blacklisted-sidebar{display:none !important;}</style></head>
<body>
<div class="overlay-notice-container" id="notice-container" style="display: none;">
<table cellspacing=0 cellpadding=0> <tbody>
<tr> <td>
<div id="notice">
</div>
</td> </tr>
</tbody> </table>
</div>
<div id="news-ticker" style="" data-date="20201219">
<ul>
<li>Try clearing out cookies of you have problem logging in/out.</li>
</ul>
<a href="#" class="close-link">Close</a>
</div>
<div id="header">
<div id="title"><h2 id="site-title"><a href="https://yande.re"><img alt="yande.re" id="logo" src="https://assets.yande.re/assets/logo_small-418e8d5ec0229f274edebe4af43b01aa29ed83b715991ba14bb41ba06b5b57b5.png" width="484" height="75" /></a><span></span></h2></div>
<div class="clearfix" id="main-menu" data-controller="help">
<ul>
<li class="user"><a href="/user/home">My Account</a>
<a class="submenu-button" href="#">■</a>
<ul class="submenu">
<li><a id="login-link" class="login-button" href="/user/login">Login</a></li>
<li><a href="/user/signup"><span class="translation_missing" title="translation missing: en.layouts.menu.account.register">Register</span></a></li>
<li><a href="/user/reset_password">Reset Password</a></li>
</ul>
</li>
<li class="post"><a href="/post">Posts</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/post" accept-charset="UTF-8" method="get">
<input type="text" name="tags" /><br />
<input type="submit" value="Search Posts" data-disable-with="Search Posts" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/post">View Posts</a></li>
<li><a class="search-link" href="/post">Search Posts</a></li>
<li><a href="/post/upload">Upload</a></li>
<li><a href="/post?tags=order%3Arandom">Random</a></li>
<li><a href="/post/popular_recent">Popular</a></li>
<li><a href="/post/similar">Image Search</a></li>
<li><a href="/history">History</a></li>
</ul>
</li>
<li class="comment"><a id="comments-link" href="/comment">Comments</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/comment/search" accept-charset="UTF-8" method="get">
<input type="text" name="query" /><br />
<input type="submit" value="Search Comments" data-disable-with="Search Comments" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/comment">View Comments</a></li>
<li><a class="search-link" href="/comment/search">Search Comments</a></li>
</ul>
</li>
<li class="note"><a href="/note">Notes</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/note/search" accept-charset="UTF-8" method="get">
<input type="text" name="query" /><br />
<input type="submit" value="Search Notes" data-disable-with="Search Notes" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/note">View Notes</a></li>
<li><a class="search-link" href="/note/search">Search Notes</a></li>
<li><a href="/post?tags=translation_request">Requests</a></li>
</ul>
</li>
<li class="artist"><a href="/artist?order=date">Artists</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/artist" accept-charset="UTF-8" method="get">
<input type="text" name="name" /><br />
<input type="submit" value="Search Artists" data-disable-with="Search Artists" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/artist">View Artists</a></li>
<li><a class="search-link" href="/artist">Search Artists</a></li>
<li><a href="/artist/create">Create</a></li>
</ul>
</li>
<li class="tag"><a href="/tag?order=date">Tags</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/tag" accept-charset="UTF-8" method="get">
<input type="text" name="name" /><br />
<input type="submit" value="Search Tags" data-disable-with="Search Tags" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/tag">View Tags</a></li>
<li><a class="search-link" href="/tag">Search Tags</a></li>
<li><a href="/tag/popular_by_day">Popular</a></li>
<li><a href="/tag_alias">Aliases</a></li>
<li><a href="/tag_implication">Implications</a></li>
</ul>
</li>
<li class="pool"><a href="/pool">Pools</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/pool" accept-charset="UTF-8" method="get">
<input type="text" name="query" /><br />
<input type="submit" value="Search Pools" data-disable-with="Search Pools" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/pool">View Pools</a></li>
<li><a class="search-link" href="/pool">Search Pools</a></li>
<li><a href="/pool/create">Create New Pool</a></li>
</ul>
</li>
<li class="wiki"><a href="/wiki/show?title=help%3Ahome">Wiki</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/wiki" accept-charset="UTF-8" method="get">
<input type="text" name="query" /><br />
<input type="submit" value="Search Wiki" data-disable-with="Search Wiki" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/wiki">View Wiki Index</a></li>
<li><a class="search-link" href="/wiki">Search Wiki</a></li>
<li><a href="/wiki/add">Create New Page</a></li>
</ul>
</li>
<li class="forum"><a id="forum-link" href="/forum">Forum</a>
<a class="submenu-button" href="#">■</a>
<ul class="search-box">
<li>
<div>
<form action="/forum/search" accept-charset="UTF-8" method="get">
<input type="text" name="query" /><br />
<input type="submit" value="Search Forums" data-disable-with="Search Forums" />
</form> </div>
</li>
</ul>
<ul class="submenu">
<li><a href="/forum">View Topics</a></li>
<li><a class="search-link" href="/forum">Search Forums</a></li>
<li><a href="/forum/new">New Topic</a></li>
<li><a id="forum-mark-all-read" style="display: none;" href="/forum/mark_all_read">Mark All Read</a></li>
<li class="forum-items-start"><span class="separator"></span></li>
</ul>
</li>
<li class="help"><a href="/help">Help</a>
<a class="submenu-button" href="#">■</a>
<ul class="submenu">
<li><a class="help-item post" href="/help/posts">Post Help</a>
<li><a class="help-item comment" href="/help/comments">Comment Help</a>
<li><a class="help-item note" href="/help/notes">Note Help</a>
<li><a class="help-item artist" href="/help/artists">Artist Help</a>
<li><a class="help-item tag" href="/help/tags">Tag Help</a>
<li><a class="help-item pool" href="/help/pools">Pool Help</a>
<li><a class="help-item wiki" href="/help/wiki">Wiki Help</a>
<li><a class="help-item forum" href="/help/forum">Forum Help</a>
<li><a href="/help">Site Help</a></li>
</ul>
</li>
<li class="static"><a href="/static/more">More »</a>
</li>
<li class="has-mail">
<a id="has-mail-notice" href="/dmail/inbox">New Mail</a>
</li>
</ul>
</div>
<script id="forum-posts-latest" type="application/json">
[{"id":10470,"pages":19,"title":"How would you improve yande.re","updated_at":"2026-02-08T16:55:22.707Z"},{"id":31550,"pages":6,"title":"Why I get 100 KB/s download speed from this site again?","updated_at":"2026-02-07T22:41:55.114Z"},{"id":34774,"pages":1,"title":"Delete my account","updated_at":"2026-02-06T14:25:57.670Z"},{"id":34773,"pages":1,"title":"Password forgotten","updated_at":"2026-02-04T00:29:33.710Z"},{"id":10136,"pages":62,"title":"进站必读 (兼讨论帖)","updated_at":"2026-02-01T08:17:28.064Z"},{"id":34766,"pages":1,"title":"I want to delete my account.","updated_at":"2026-01-31T22:33:14.560Z"},{"id":34762,"pages":1,"title":"Post deleted, how can I get it back?","updated_at":"2026-01-29T05:18:27.245Z"},{"id":34743,"pages":1,"title":"The administrator can answer when he sees it.","updated_at":"2026-01-28T16:30:19.010Z"},{"id":10527,"pages":208,"title":"Scans of tutorial books","updated_at":"2026-01-15T17:31:33.909Z"},{"id":34745,"pages":1,"title":"Uploads of Images with Minor Variations","updated_at":"2025-12-24T03:34:55.661Z"}]
</script>
<script id="forum-post-last-read-at" type="application/json">
"2026-02-24T02:21:14.336+09:00"
</script>
</div>
<div id="login-background" style="display: none;"> </div>
<div id="login-container" style="display: none;">
<div id="login-container-inner">
<div id="login-container-with-tabs">
<div>
<ul class="flat-list login-tabs" id="login-tabs">
<li id="tab-login"><a href="#">Login</a></li>
<li id="tab-reset"><a href="#">Reset Password</a></li>
</ul>
</div>
<div id="login" style="position: relative;">
<p id="tab-login-text" class="tab-header-text">
Please log in. To create a new account, enter the name and password you want to use.
</p>
<p id="tab-reset-text" class="tab-header-text">
If you supplied an email address when you signed up or added a email later, you can have your password reset.
</p>
<form id="login-popup" action="/user/authenticate" accept-charset="UTF-8" method="post"><input type="hidden" name="authenticity_token" value="Fw7qvP1N-YXWBJXshpnCJd9OUS9qPv-gXXcwa27HpjvOOee9DsYayq0PspH9UfYUgaCkgHT3dmcNr8Nf9wFZaA" autocomplete="off" />
<div style="position: absolute; top: 0; right: 0;">
<a href="#" id="login-popup-cancel" style="font-size: 1.2em; padding: 2px;">ⓧ</a>
</div>
<table class="form" style="width: 80%; max-width: 30em; margin-bottom: .5em; margin-left: auto; margin-right: auto;">
<tr>
<th style="width: 8em"><label class="block" for="login-popup-username">Name</label></th>
<td style="width: 10em" align=left><input id="login-popup-username" name="username" type="text" style="width: 100%;"></td>
</tr>
<tr id="login-popup-email-box">
<th><label class="block" for="login-popup-email">Email</label></th>
<td align=left><input id="login-popup-email" name="email" type="text" style="width: 100%;"></td>
</tr>
<tr id="login-popup-password-box">
<th><label class="block" for="login-popup-password">Password</label></th>
<td align=left><input id="login-popup-password" name="password" type="password" style="width: 100%;"></td>
</tr>
<tr id="login-popup-password-confirm-box" style="display: none;">
<th><label class="block" for="login-popup-password-confirm">Confirm Password</label></th>
<td align=left><input id="login-popup-password-confirm" name="password-confirm" type="password" style="width: 100%;"></td>
</tr>
<tr>
<th style="background: none;"></th>
<td align=left>
</td>
</tr>
</table>
<a href="#" id="login-popup-submit" style="margin-bottom: 1em; margin-left: auto; margin-right: auto;">Login</a>
</form>
<div id="login-popup-notices" class="login-popup-notice">
<span id="login-popup-login-confirm-password">
This user name doesn't exist. If you want to create a new account, just verify your password and log in.
</span>
<span id="login-popup-login-user-exists">
This user name exists. If you want to create a new account, please choose a different name.
</span>
<span id="login-popup-reset-user-exists">
Enter the current email address you have registered in your profile. You'll get an email containing your new password.
</span>
<span id="login-popup-reset-user-has-no-email">
You have no email address in your profile, so you can't have your password reset.
</span>
<span id="login-popup-reset-successful">
Password reset. Check your email in a few minutes
</span>
<span id="login-popup-reset-unknown-user">
That account does not exist.
</span>
<span id="login-popup-reset-blank">
</span>
<span id="login-popup-reset-user-email-incorrect">
The email address specified is not registered with this account.
</span>
<span id="login-popup-reset-user-email-invalid">
Delivery to this email address has failed.
</span>
<span id="login-popup-message">
</span>
</div>
</div>
</div>
</div>
</div>
<script type="text/javascript">document.observe("dom:loaded", function() { User.init(); });</script>
<!--[if lt IE 7]>
<div style="display: none;" id="old-browser">Your browser is very old, and this site will not display properly.
Please consider upgrading to a more recent web browser:
<a href="http://www.mozilla.com/firefox/">Firefox</a>,
<a href="http://www.opera.com/">Opera</a>,
<a href="http://www.microsoft.com/windows/internet-explorer/download-ie.aspx">Internet Explorer</a>.
<div style="text-align: right;" id="old-browser-hide">
<a href="#" onclick='$("old-browser").hide(); Cookie.put("hide-ie-nag", "1");'>(hide this message)</a>
</div>
</div>
<![endif]-->
<div class="overlay-notice-container" id="notice-container" style="display: none;">
<table cellspacing=0 cellpadding=0> <tbody>
<tr> <td>
<div id="notice">
</div>
</td> </tr>
</tbody> </table>
</div>
<div class="blocked" id="block-reason" style="display: none;">
</div>
<div id="content">
<div class="help">
<h1>Help: API 1.13.0+update.3</h1>
<div class="section">
<p>Moebooru offers API which is mostly compatible with Danbooru API (version 1.13.0) to make scripting easy. All you need is a way to <a href="http://en.wikipedia.org/wiki/HTTP_GET#Request_methods">GET and POST</a> to <a href="http://en.wikipedia.org/wiki/Uniform_Resource_Locator">URLs</a>. The ability to parse <a href="http://en.wikipedia.org/wiki/Xml">XML</a> or <a href="http://en.wikipedia.org/wiki/Json">JSON</a> responses is nice, but not critical. The simplicity of the API means you can write scripts using JavaScript, Perl, Python, Ruby, even shell languages like bash or tcsh.</p>
<p style="text-align: center;"><a href="#changelog">Change Log</a> | <a href="#posts">Posts</a> | <a href="#tags">Tags</a> | <a href="#artists">Artists</a> | <a href="#comments">Comments</a> | <a href="#wiki">Wiki</a> | <a href="#notes">Notes</a> | <a href="#users">Users</a> | <a href="#forum">Forum</a> | <a href="#pools">Pools</a></p>
</div>
<div class="section">
<div class="section">
<h2>Basics</h2>
<p>HTTP defines two request methods: GET and POST. You'll be using these two methods to interact with the Danbooru API. Most API calls that change the state of the database (like creating, updating, or deleting something) require an HTTP POST call. API calls that only retrieve data can typically be done with an HTTP GET call.</p>
<p>In the Danbooru API, a URL is analogous to a function name. You pass in the function parameters as a query string. Here's an extremely simple example: <a class="code" href="/post.xml?limit=1" target="_blank">/post.xml?limit=1</a>.</p>
<p>The <code>post</code> part indicates the controller we're working with. In this case it's posts. <code>index</code> describes the action. Here we're retrieving a list of posts. Finally, the <code>xml</code> part describes what format we want the response in. You can specify <code>.xml</code> for XML responses, <code>.json</code> for JSON responses, and nothing at all for HTML responses.</p>
</div>
<div class="section">
<h4>Responses</h4>
<p>All API calls that change state will return a single element response (for XML calls). They are formatted like this:</p>
<div class="code">
<?xml version="1.0" encoding="UTF-8"?><br>
<response success="false" reason="duplicate"/>
</div>
<p>For JSON responses, they'll look like this:</p>
<div class="code">
{success: false, reason: "duplicate"}
</div>
<p>While you can usually determine success or failure based on the response object, you can also figure out what happened based on the HTTP status code. In addition to the standard ones, Danbooru uses some custom status codes in the 4xx and 5xx range.</p>
<table>
<thead>
<tr>
<th>Status Code</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td>200 OK</td>
<td>Request was successful</td>
</tr>
<tr>
<td>403 Forbidden</td>
<td>Access denied</td>
</tr>
<tr>
<td>404 Not Found</td>
<td>Not found</td>
</tr>
<tr>
<td>420 Invalid Record</td>
<td>Record could not be saved</td>
</tr>
<tr>
<td>421 User Throttled</td>
<td>User is throttled, try again later</td>
</tr>
<tr>
<td>422 Locked</td>
<td>The resource is locked and cannot be modified</td>
</tr>
<tr>
<td>423 Already Exists</td>
<td>Resource already exists</td>
</tr>
<tr>
<td>424 Invalid Parameters</td>
<td>The given parameters were invalid</td>
</tr>
<tr>
<td>500 Internal Server Error</td>
<td>Some unknown error occurred on the server</td>
</tr>
<tr>
<td>503 Service Unavailable</td>
<td>Server cannot currently handle the request, try again later</td>
</tr>
</tbody>
</table>
</div>
<div class="section">
<h4>JSON Responses</h4>
<p>While you will probably want to work with XML in the majority of cases, if you're writing something in Javascript then the JSON responses may be preferable. They are much faster to parse and there's less code to write to get your data structure:</p>
<div class="code">
var data = JSON.parse(responseText)<br>
alert(data.response)
</div>
</div>
<div class="section">
<h4>Logging In</h4>
<p>Some actions may require you to log in. For any action you can always specify two parameters to identify yourself:</p>
<ul>
<li><strong>login</strong> Your login name.</li>
<li><strong>password_hash</strong> Your SHA1 hashed password. Simply hashing your plain password will NOT work since Danbooru salts its passwords. The actual string that is hashed is "choujin-steiner--<em>your-password</em>--".</li>
</ul>
<p>Please be aware of the security risks involved in sending your password through an unencrypted channel. Although your password will be hashed, it is still theoretically possible for someone to steal your account by creating a fake cookie based on your hashed password.</p>
</div>
</div>
<div class="section">
<a name="posts"></a>
<h2>Posts</h2>
<div class="section">
<h4>List</h4>
<p>The base URL is /post.xml.</p>
<ul>
<li><strong>limit</strong> How many posts you want to retrieve. There is a hard limit of 100 posts per request.</li>
<li><strong>page</strong> The page number.</li>
<li><strong>tags</strong> The tags to search for. Any tag combination that works on the web site will work here. This includes all the meta-tags.</li>
</ul>
</div>
<div class="section">
<h4>Create</h4>
<p>The base URL is /post/create.xml. There are only two mandatory fields: you need to supply the tags, and you need to supply the file, either through a multipart form or through a source URL.</p>
<ul>
<li><strong>post[tags]</strong> A space delimited list of tags.</li>
<li><strong>post[file]</strong> The file data encoded as a multipart form.</li>
<li><strong>post[rating]</strong> The rating for the post. Can be: safe, questionable, or explicit.</li>
<li><strong>post[source]</strong> If this is a URL, Danbooru will download the file.</li>
<li><strong>post[is_rating_locked]</strong> Set to true to prevent others from changing the rating.</li>
<li><strong>post[is_note_locked]</strong> Set to true to prevent others from adding notes.</li>
<li><strong>post[parent_id]</strong> The ID of the parent post.</li>
<li><strong>md5</strong> Supply an MD5 if you want Danbooru to verify the file after uploading. If the MD5 doesn't match, the post is destroyed.</li>
</ul>
<p>If the call fails, the following response reasons are possible:</p>
<ul>
<li><strong>MD5 mismatch</strong> This means you supplied an MD5 parameter and what Danbooru got doesn't match. Try uploading the file again.</li>
<li><strong>duplicate</strong> This post already exists in Danbooru (based on the MD5 hash). An additional attribute called <code>location</code> will be set, pointing to the (relative) URL of the original post.</li>
<li><strong><em>other</em></strong> Any other error will have its error message printed.</li>
</ul>
<p>If the post upload succeeded, you'll get an attribute called <code>location</code> in the response pointing to the relative URL of your newly uploaded post.</p>
</div>
<div class="section">
<h4>Update</h4>
<p>The base URL is /post/update.xml. Only the <code>id</code> parameter is required. Leave the other parameters blank if you don't want to change them.</p>
<ul>
<li><strong>id</strong> The id number of the post to update.</li>
<li><strong>post[tags]</strong> A space delimited list of tags.</li>
<li><strong>post[file]</strong> The file data encoded as a multipart form.</li>
<li><strong>post[rating]</strong> The rating for the post. Can be: safe, questionable, or explicit.</li>
<li><strong>post[source]</strong> If this is a URL, Danbooru will download the file.</li>
<li><strong>post[is_rating_locked]</strong> Set to true to prevent others from changing the rating.</li>
<li><strong>post[is_note_locked]</strong> Set to true to prevent others from adding notes.</li>
<li><strong>post[parent_id]</strong> The ID of the parent post.</li>
</ul>
</div>
<div class="section">
<h4>Destroy</h4>
<p>You must be logged in to use this action. You must also be the user who uploaded the post (or you must be a moderator).</p>
<ul>
<li><strong>id</strong> The id number of the post to delete.</li>
</ul>
</div>
<div class="section">
<h4>Revert Tags</h4>
<p>This action reverts a post to a previous set of tags. The base URL is /post/revert_tags.xml.</p>
<ul>
<li><strong>id</strong> The post id number to update.</li>
<li><strong>history_id</strong> The id number of the tag history.</li>
</ul>
</div>
<div class="section">
<h4>Vote</h4>
<p>This action lets you vote for a post. You can only vote once per post per IP address. The base URL is /post/vote.xml.</p>
<ul>
<li><strong>id</strong> The post id number to update.</li>
<li><strong>score</strong> Set to <code>1</code> to vote up and <code>-1</code> to vote down. All other values will be ignored.</li>
</ul>
<p>If the call did not succeed, the following reasons are possible:</p>
<ul>
<li><strong>already voted</strong> You have already voted for this post.</li>
<li><strong>invalid score</strong> You have supplied an invalid score.</li>
</ul>
</div>
</div>
<div class="section">
<a name="tags"></a>
<h2>Tags</h2>
<div class="section">
<h4>List</h4>
<p>The base URL is /tag.xml.</p>
<ul>
<li><strong>limit</strong> How many tags to retrieve. Setting this to 0 will return every tag.</li>
<li><strong>page</strong> The page number.</li>
<li><strong>order</strong> Can be <code>date</code>, <code>count</code>, or <code>name</code>.</li>
<li><strong>id</strong> The id number of the tag.</li>
<li><strong>after_id</strong> Return all tags that have an id number greater than this.</li>
<li><strong>name</strong> The exact name of the tag.</li>
<li><strong>name_pattern</strong> Search for any tag that has this parameter in its name.</li>
</ul>
</div>
<div class="section">
<h4>Update</h4>
<p>The base URL is /tag/update.xml.</p>
<ul>
<li><strong>name</strong> The name of the tag to update.</li>
<li><strong>tag[tag_type]</strong> The tag type. General: 0, artist: 1, copyright: 3, character: 4.</li>
<li><strong>tag[is_ambiguous]</strong> Whether or not this tag is ambiguous. Use 1 for true and 0 for false.</li>
</ul>
</div>
<div class="section">
<h4>Related</h4>
<p>The base URL is /tag/related.xml.</p>
<ul>
<li><strong>tags</strong> The tag names to query.</li>
<li><strong>type</strong> Restrict results to this tag type (can be <code>general</code>, <code>artist</code>, <code>copyright</code>, or <code>character</code>).</li>
</ul>
</div>
</div>
<div class="section">
<a name="artists"></a>
<h2>Artists</h2>
<div class="section">
<h4>List</h4>
<p>The base URL is /artist.xml.</p>
<ul>
<li><strong>name</strong> The name (or a fragment of the name) of the artist.</li>
<li><strong>order</strong> Can be <code>date</code> or <code>name</code>.</li>
<li><strong>page</strong> The page number.</li>
</ul>
</div>
<div class="section">
<h4>Create</h4>
<p>The base URL is /artist/create.xml.</p>
<ul>
<li><strong>artist[name]</strong> The artist's name.</li>
<li><strong>artist[urls]</strong> A list of URLs associated with the artist, whitespace delimited.</li>
<li><strong>artist[alias]</strong> The artist that this artist is an alias for. Simply enter the alias artist's name.</li>
<li><strong>artist[group]</strong> The group or cicle that this artist is a member of. Simply enter the group's name.</li>
</ul>
</div>
<div class="section">
<h4>Update</h4>
<p>The base URL is /artist/update.xml. Only the <strong>id</strong> parameter is required. The other parameters are optional.</p>
<ul>
<li><strong>id</strong> The id of thr artist to update.</li>
<li><strong>artist[name]</strong> The artist's name.</li>
<li><strong>artist[urls]</strong> A list of URLs associated with the artist, whitespace delimited.</li>
<li><strong>artist[alias]</strong> The artist that this artist is an alias for. Simply enter the alias artist's name.</li>
<li><strong>artist[group]</strong> The group or cicle that this artist is a member of. Simply enter the group's name.</li>
</ul>
</div>
<div class="section">
<h4>Destroy</h4>
<p>The base URL is /artist/destroy.xml. You must be logged in to delete artists.</p>
<ul>
<li><strong>id</strong> The id of the artist to destroy.</li>
</ul>
</div>
</div>
<div class="section">
<a name="comments"></a>
<h2>Comments</h2>
<div class="section">
<h4>Show</h4>
<p>The base URL is /comment/show.xml. This retrieves a single comment.</p>
<ul>
<li><strong>id</strong> The id number of the comment to retrieve.</li>
</ul>
</div>
<div class="section">
<h4>Create</h4>
<p>The base URL is /comment/create.xml.</p>
<ul>
<li><strong>comment[anonymous]</strong> Set to 1 if you want to post this comment anonymously.</li>
<li><strong>comment[post_id]</strong> The post id number to which you are responding.</li>
<li><strong>comment[body]</strong> The body of the comment.</li>
</ul>
</div>
<div class="section">
<h4>Destroy</h4>
<p>The base url is /comment/destroy.xml. You must be logged in to use this action. You must also be the owner of the comment, or you must be a moderator.</p>
<ul>
<li><strong>id</strong> The id number of the comment to delete.</li>
</ul>
</div>
</div>
<div class="section">
<a name="wiki"></a>
<h2>Wiki</h2>
<p>All titles must be exact (but case and whitespace don't matter).</p>
<div class="section">
<h4>List</h4>
<p>The base URL is /wiki.xml. This retrieves a list of every wiki page.</p>
<ul>
<li><strong>order</strong> How you want the pages ordered. Can be: <code>title</code>, <code>date</code>.</li>
<li><strong>limit</strong> The number of pages to retrieve.</li>
<li><strong>page</strong> The page number.</li>
<li><strong>query</strong> A word or phrase to search for.</li>
</ul>
</div>
<div class="section">
<h4>Create</h4>
<p>The base URL is /wiki/create.xml.</p>
<ul>
<li><strong>wiki_page[title]</strong> The title of the wiki page.</li>
<li><strong>wiki_page[body]</strong> The body of the wiki page.</li>
</ul>
</div>
<div class="section">
<h4>Update</h4>
<p>The base URL is /wiki/update.xml. Potential error reasons: "Page is locked"</p>
<ul>
<li><strong>title</strong> The title of the wiki page to update.</li>
<li><strong>wiki_page[title]</strong> The new title of the wiki page.</li>
<li><strong>wiki_page[body]</strong> The new body of the wiki page.</li>
</ul>
</div>
<div class="section">
<h4>Show</h4>
<p>The base URL is /wiki/show.xml. Potential error reasons: "artist type"</p>
<ul>
<li><strong>title</strong> The title of the wiki page to retrieve.</li>
<li><strong>version</strong> The version of the page to retrieve.</li>
</ul>
</div>
<div class="section">
<h4>Destroy</h4>
<p>The base URL is /wiki/destroy.xml. You must be logged in as a moderator to use this action.</p>
<ul>
<li><strong>title</strong> The title of the page to delete.</li>
</ul>
</div>
<div class="section">
<h4>Lock</h4>
<p>The base URL is /wiki/lock.xml. You must be logged in as a moderator to use this action.</p>
<ul>
<li><strong>title</strong> The title of the page to lock.</li>
</ul>
</div>
<div class="section">
<h4>Unlock</h4>
<p>The base URL is /wiki/unlock.xml. You must be logged in as a moderator to use this action.</p>
<ul>
<li><strong>title</strong> The title of the page to unlock.</li>
</ul>
</div>
<div class="section">
<h4>Revert</h4>
<p>The base URL is /wiki/revert.xml. Potential error reasons: "Page is locked"</p>
<ul>
<li><strong>title</strong> The title of the wiki page to update.</li>
<li><strong>version</strong> The version to revert to.</li>
</ul>
</div>
<div class="section">
<h4>History</h4>
<p>The base URL is /wiki/history.xml.</p>
<ul>
<li><strong>title</strong> The title of the wiki page to retrieve versions for.</li>
</ul>
</div>
</div>
<div class="section">
<a name="notes"></a>
<h2>Notes</h2>
<div class="section">
<h4>List</h4>
<p>The base URL is /note.xml.</p>
<ul>
<li><strong>post_id</strong> The post id number to retrieve notes for.</li>
</ul>
</div>
<div class="section">
<h4>Search</h4>
<p>The base URL is /note/search.xml.</p>
<ul>
<li><strong>query</strong> A word or phrase to search for.</li>
</ul>
</div>
<div class="section">
<h4>History</h4>
<p>The base URL is /note/history.xml. You can either specify <code>id</code>, <code>post_id</code>, or nothing. Specifying nothing will give you a list of every note verison.</p>
<ul>
<li><strong>limit</strong> How many versions to retrieve.</li>
<li><strong>page</strong> The offset.</li>
<li><strong>post_id</strong> The post id number to retrieve note versions for.</li>
<li><strong>id</strong> The note id number to retrieve versions for.</li>
</ul>
</div>
<div class="section">
<h4>Revert</h4>
<p>The base URL is /note/revert.xml. Potential error reasons: "Post is locked"</p>
<ul>
<li><strong>id</strong> The note id to update.</li>
<li><strong>version</strong> The version to revert to.</li>
</ul>
</div>
<div class="section">
<h4>Create/Update</h4>
<p>The base URL is /note/update.xml. Notes differ from the other controllers in that the interface for creation and updates is the same. If you supply an <code>id</code> parameter, then Danbooru will assume you're updating an existing note. Otherwise, it will create a new note. Potential error reasons: "Post is locked"</p>
<ul>
<li><strong>id</strong> If you are updating a note, this is the note id number to update.</li>
<li><strong>note[post_id]</strong> The post id number this note belongs to.</li>
<li><strong>note[x]</strong> The x coordinate of the note.</li>
<li><strong>note[y]</strong> The y coordinate of the note.</li>
<li><strong>note[width]</strong> The width of the note.</li>
<li><strong>note[height]</strong> The height of the note.</li>
<li><strong>note[is_active]</strong> Whether or not the note is visible. Set to 1 for active, 0 for inactive.</li>
<li><strong>note[body]</strong> The note message.</li>
</ul>
</div>
</div>
<div class="section">
<a name="users"></a>
<h2>Users</h2>
<div class="section">
<h4>Search</h4>
<p>The base URL is /user.xml. If you don't specify any parameters you'll get a listing of all users.</p>
<ul>
<li><strong>id</strong> The id number of the user.</li>
<li><strong>name</strong> The name of the user.</li>
</ul>
</div>
</div>
<div class="section">
<a name="forum"></a>
<h2>Forum</h2>
<div class="section">
<h4>List</h4>
<p>The base URL is /forum.xml. If you don't specify any parameters you'll get a list of all the parent topics.</p>
<ul>
<li><strong>parent_id</strong> The parent ID number. You'll return all the responses to that forum post.</li>
</ul>
</div>
</div>
<div class="section">
<a name="pools"></a>
<h2>Pools</h2>
<div class="section">
<h4>List Pools</h4>
<p>The base URL is /pool.xml. If you don't specify any parameters you'll get a list of all pools.</p>
<ul>
<li><strong>query</strong> The title.</li>
<li><strong>page</strong> The page.</li>
</ul>
</div>
<div class="section">
<h4>List Posts</h4>
<p>The base URL is /pool/show.xml. If you don't specify any parameters you'll get a list of all pools.</p>
<ul>
<li><strong>id</strong> The pool id number.</li>
<li><strong>page</strong> The page.</li>
</ul>
</div>
<div class="section">
<h4>Update</h4>
<p>The base URL is /pool/update.xml.</p>
<ul>
<li><strong>id</strong> The pool id number.</li>
<li><strong>pool[name]</strong> The name.</li>
<li><strong>pool[is_public]</strong> 1 or 0, whether or not the pool is public.</li>
<li><strong>pool[description]</strong> A description of the pool.</li>
</ul>
</div>
<div class="section">
<h4>Create</h4>
<p>The base URL is /pool/create.xml.</p>
<ul>
<li><strong>pool[name]</strong> The name.</li>
<li><strong>pool[is_public]</strong> 1 or 0, whether or not the pool is public.</li>
<li><strong>pool[description]</strong> A description of the pool.</li>
</ul>
</div>
<div class="section">
<h4>Destroy</h4>
<p>The base URL is /pool/destroy.xml.</p>
<ul>
<li><strong>id</strong> The pool id number.</li>
</ul>
</div>
<div class="section">
<h4>Add Post</h4>
<p>The base URL is /pool/add_post.xml. Potential error reasons: "Post already exists", "access denied"</p>
<ul>
<li><strong>pool_id</strong> The pool to add the post to.</li>
<li><strong>post_id</strong> The post to add.</li>
</ul>
</div>
<div class="section">
<h4>Remove Post</h4>
<p>The base URL is /pool/remove_post.xml. Potential error reasons: "access denied"</p>
<ul>
<li><strong>pool_id</strong> The pool to remove the post from.</li>
<li><strong>post_id</strong> The post to remove.</li>
</ul>
</div>
</div>
<div class="section">
<a name="favorites"></a>
<h2>Favorites</h2>
<div class="section">
<h4>List Users</h4>
<p>The base URL is /favorite/list_users.json. There is no XML API for this action.</p>
<ul>
<li><strong>id</strong> The post id.</li>
</ul>
</div>
</div>
<div class="section">
<a name="changelog"></a>
<h2>Change Log</h2>
<div class="section">
<h4>2.0.0</h4>
<ul>
<li>Removed <code>blacklist_tags</code> from user object (never documented)</li>
<li>XML tag for user API has been changed from <code>post</code> to <code>user</code></li>
</ul>
<h4>1.13.0+update.3</h4>
<ul>
<li>Removed /index from API URLs</li>
</ul>
<h4>1.13.0+update.2</h4>
<ul>
<li>Readd favorite/list_users API</li>
</ul>
<h4>1.13.0+update.1</h4>
<ul>
<li>Added documentation for pools</li>
</ul>
<h4>1.13.0</h4>
<ul>
<li>Changed interface for artists to use new URL system</li>
<li>JSON requests now end in a .json suffix</li>
<li>Renamed some error reason messages</li>
<li>Removed comment/index from API</li>
<li>Removed url and md5 parameters from artist search (can just pass the URL or MD5 hash to the name parameter)</li>
</ul>
</div>
<div class="section">
<h4>1.8.1</h4>
<ul>
<li>Removed post[is_flagged] attribute</li>
</ul>
</div>
</div>
</div>
<div class="footer">
<ul class="flat-list" id="subnavbar">
<li><a href="/help">Help</a></li>
</ul>
</div>
</div>
<script type="text/javascript">
InitTextAreas();
Post.InitBrowserLinks();
if(TagCompletion)
TagCompletion.init(8384);
</script>
<!--[if lt IE 7]>
<script type="text/javascript">
if(Cookie.get("hide-ie-nag") != "1")
$("old-browser").show();
</script>
<![endif]-->
<form>
<select name="locale">
<option value="de" >
Deutsch
</option>
<option value="en" selected>
English
</option>
<option value="es" >
español
</option>
<option value="ja" >
日本語
</option>
<option value="ru" >
русский
</option>
<option value="zh_CN" >
简体中文
</option>
<option value="zh_TW" >
繁體中文（台灣）
</option>
</select>
<button type='submit'>
Select
</button>
</form>
</body>
</html>
|