summaryrefslogtreecommitdiff
path: root/docs/api/gelbooru-howto-api.html
blob: b150bad7ba59975387a245c04d270cd43ea08696 (plain) (blame)
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
<!DOCTYPE html><html lang="en">
	<head>
		<meta charset="UTF-8">
		<title>howto:api - Wiki  | Gelbooru - Anime Art & Hentai Gallery - Free to Explore</title>
		<link rel="stylesheet preload" href="https://gelbooru.com//bootstrap.css">
		<link rel="stylesheet preload" type="text/css" media="screen" href="https://gelbooru.com//responsive.css?81" title="default" />
		
		
		<link rel="stylesheet preload" type="text/css" media="screen" href="https://gelbooru.com//css/jquery-ui.css?81" title="default" />
		<link rel="stylesheet preload" type="text/css" href="https://gelbooru.com//css/jquery-ui.icon-font.min.css?81"/> 
		<meta name="adsbytrafficjunkycontext" data-invocation-type="publisher" data-spot-new="true" data-site-id="444001" data-site="Gelbooru" data-platform="desktop">
<link rel="SHORTCUT ICON" href="favicon.png" />
		<meta name="keywords" content="anime, doujinshi, hentai, porn, sex, japanese hentai, anime hentai, rule34, rule 34, imageboard" />
		<meta name="description" content="Browse millions of anime, manga, and video game themed images on Gelbooru. Discover art with detailed tags. Contains explicit hentai content. " />
		<meta name="rating" content="adult" />

		<meta name="viewport" content="width=device-width, initial-scale=1.0">
		<link rel="search" type="application/opensearchdescription+xml" title="Gelbooru.com: Coded by Geltas" href="gelbooru.xml" />
		
		<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
		<script src="https://gelbooru.com//script/miscJs.js?1"></script>
		<script src="https://gelbooru.com//script/jquery-hotkeys.js?1"></script>

		<script src="https://gelbooru.com//script/tryt.js"></script>
		<script src="https://gelbooru.com//autoDebug.js"></script>
	</head>
	<style>
	 .mn-container-adsby_position_bottom-right {
		 display: none;
	 }
	</style>
	<body>
	
		
		<div class="container-fluid">
			<nav class="navbar navbar-default">
				<div class="navbar-header">
					<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
					  <span class="sr-only">Toggle navigation</span>
					  <span class="icon-bar"></span>
					  <span class="icon-bar"></span>
					  <span class="icon-bar"></span>
					</button>
					<a class="navbar-brand" href="https://gelbooru.com/"></a>
				</div>
				<div id="navbar" class="navbar-collapse collapse">
					<ul class="nav navbar-nav">
						<li><a href="https://gelbooru.com/index.php?page=account&amp;s=home">Settings</a></li>
						<li><a href="https://gelbooru.com/index.php?page=post&amp;s=list&amp;tags=all">Posts</a></li>
						<li><a href="https://gelbooru.com/index.php?page=comment&amp;s=list">Comments</a></li>
						<li class="active strong"><a href="https://gelbooru.com/index.php?page=wiki&amp;s=list">Wiki</a></li>
						<li><a href="https://gelbooru.com/index.php?page=tags&amp;s=list">Tags</a></li>
						<li><a href="https://gelbooru.com/index.php?page=pool&amp;s=list">Pools</a></li>
						<li><a href="https://gelbooru.com/index.php?page=forum&amp;s=list">Forum</a></li>
						<li><a href="https://gelbooru.com/index.php?page=tracker&amp;s=list">Trac</a></li>
						<li><a class="ui-icon ui-icon-lightbulb" href="javascript:;" onclick="darkModeToggle(); return false;" style="color: #ffff00; font-size: 20px; margin: 7px 5px 7px 15px;"></a></li>
						
					</ul>
				</div>
			</nav>
		<nav class="navbar navbar-default" id="submenu">
						<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar2" aria-expanded="false" aria-controls="navbar">
						  <span class="sr-only">Toggle navigation</span>
						  <span class="icon-bar"></span>
						  <span class="icon-bar"></span>
						  <span class="icon-bar"></span>
						</button>
			<div id="navbar2" class="navbar-collapse collapse">
		<ul class="nav navbar-nav"><li><a href="index.php?page=wiki&amp;s=create"><b>Create</b></a></li>
	<li><a href="index.php?page=wiki&amp;s=list">List</a></li><li><a href="index.php?page=wiki&amp;s=edit&amp;id=18780">Edit</a></li><li><a href="index.php?page=wiki&amp;s=history&amp;id=18780">History</a></li><li><a href="index.php?page=wiki&amp;s=manage&amp;action=delete&amp;id=18780" onclick="javascript: return confirm('Are you sure you wish to delete this wiki entry?');">Delete</a></li><li><a href="index.php?page=wiki&amp;s=manage&amp;action=lock&amp;id=18780">Lock</a></li></ul></div></nav></div><div class="alert alert-warning small" style="padding: 10px 15px 10px 15px; font-size: 11px;" id="motd">
			<i><b>Notice</b></i>: <a href="https://twitter.com/gelbooru/status/1577845556273102848" style="color: #ffff00; font-weight: bold;" target="_blank">My personal stance on AI generated artwork. Retweet and share if you agree. Let us discuss, and not immediately scream bloody murder.</a>
		</div>
		<div style="display: none; padding: 0px 15px 0px 15px;" id="motdspacer">&nbsp;</div>
	<div class="padding15">
	<div id="long-notice"></div><div id="notice" style="display: none;"></div>
		<div class="alert alert-success" role="alert"  style="display: none;"><center><a href="index.php?page=gmail">You have mail</a></center></div>
	<script type="text/javascript">
		if($.cookie('motd') == 1)
		{
			$("#motd").hide();
			$("#motdspacer").show();
		}

		function darkModeToggle()
		{
			if ($.cookie('dark_mode') == 1 )
			{
				$.removeCookie("dark_mode");
			}
			else
			{
				$.cookie("dark_mode", 1, { expires : 365 });
			}
			location.reload();
		}
	</script>

	
		<script src="https://gelbooru.com//script/application3.js?62"></script>
		<script src="https://gelbooru.com//script/license.30.js"></script>
			
		<div class="row">
		<div class="col-xs-12">
			<form action="?page=wiki&amp;s=list" method="post">
				<div class="row">
					<div class="col-xs-12">
						<input id="tags-search" name="search" style="padding: 7px; width: calc(100% - 125px);" type="text" value="" placeholder="Ex: blue_sky cloud 1girl"/>
						<input name="commit" class="new_secondary_search" type="submit" value="Search" />
					</div>
				</div>
			</form>
		</div>
	</div>
	<br />
	
	
	<table cellspacing="0" cellpadding="0" style="width: 100%; padding: 0px; margin: 0px;"><tr><td style="vertical-align: top; padding-right: 20px; text-align: justify; border-right: 3px solid #f7f7f7;">
	<h2 style="display: inline;">Now Viewing: howto:api</h2><br /><span><b>Tag type: None</b></span><br /><br />
	<h1>Api Basics Documentation</h1><br />You should never receive an error unless the server is overloaded or the search dies.<br /><br /><h2>Authentication</h2><br />We will occasionally require authentication to access our API and throttle access to our API. This is to mitigate abusive behavior.<br /><br /><b>&amp;api_key=API_KEY_HERE&amp;user_id=USER_ID_HERE</b><br /><br /><b>API_KEY_HERE</b> Your API Key which is accessible within your account options page.<br /><b>USER_ID_HERE</b> Your user ID, which is accessible on the account options/profile page.<br /><br />Your requests will not be limited if you have contributed to the Patreon in the past.<br /><br /><h2>Posts List</h2><br /><br />Url for API access: <b>/index.php?page=dapi&amp;s=post&amp;q=index</b><br /><br /><b>limit</b> How many posts you want to retrieve. There is a default limit of 100 posts per request.<br /><b>pid</b> The page number.<br /><b>tags</b> The tags to search for. Any tag combination that works on the web site will work here. This includes all the meta-tags. See <a href="index.php?page=wiki&amp;s=list&amp;search=howto:search">howto:search</a> and <a href="index.php?page=wiki&amp;s=list&amp;search=howto:cheatsheet">howto:cheatsheet</a> for more information.<br /><b>cid</b> Change ID of the post. This is in Unix time so there are likely others with the same value if updated at the same time.<br /><b>id</b> The post id.<br /><b>json</b> Set to 1 for JSON formatted response.<br /><br /><h2>Tag List</h2><br /><br />Url for API access: <b>/index.php?page=dapi&amp;s=tag&amp;q=index</b><br /><br /><b>id</b> The tag&#039;s id in the database. This is useful to grab a specific tag if you already know this value.<br /><b>limit</b> How many tags you want to retrieve. There is a default limit of 100 per request.<br /><b>after_id</b> Grab tags whose ID is greater than this value.<br /><b>name</b> Find tag information based on this value.<br /><b>names</b> Separated by spaces, get multiple results to tags you specify if it exists. (schoolgirl moon cat)<br /><b>name_pattern</b> A wildcard search for your query using LIKE. Use _ for single character wildcards or % for multi-character wildcards. (%choolgirl% would act as *choolgirl* wildcard search.) <br /><b>json</b> Set to 1 for JSON formatted response.<br /><b>order</b> Order by field specified (ASC or DESC)<br /><b>orderby</b> Order by a field. <br />- date<br />- count<br />- name<br /><br /><h2>User List</h2><br /><br />Url for API access: <b>/index.php?page=dapi&amp;s=user&amp;q=index</b><br /><br /><b>limit</b> How many posts you want to retrieve. There is a default limit of 100 posts per request.<br /><b>pid</b> The page number.<br /><b>name</b> The username to search for<br /><b>name_pattern</b> The username to search for, using a wildcard search.<br /><b>json</b> Set to 1 for JSON formatted response.<br /><br /><br /><h2>Comments List</h2><br /><br />Url for API access: <b>/index.php?page=dapi&amp;s=comment&amp;q=index</b><br /><br /><b>post_id The id number of the comment to retrieve.</b><br /><br /><br /><h2>Deleted Images</h2><br /><br />Url for API access: <b>/index.php?page=dapi&amp;s=post&amp;q=index&amp;deleted=show</b><br /><br /><b>last_id</b> A numerical value. Will return everything above this number.<br /><br /><br /><br /><br />
	<b>Other Wiki Information</b><br /><br />
	<div style="padding: 10px; background: #e9f3ff; border: 1px solid #cee3ff">Last updated: 02/22/22 4:17 PM by <a href="index.php?page=account&amp;s=profile&amp;id=1">lozertuser</a></div><div style="padding: 10px; background: #f7fbff; text-align: center;"><img src="layout/icons/lock.png" alt="lock" style="margin-top: -3px;" /> This entry is locked and can not be edited.</div><br /><br />
	</td>
	<td style="width: 50%; vertical-align: top;"><b>There are no images associated with this wiki entry.</b></td></tr></table><br /><br />
	<br /></div></body></html>