E621 Api Docs Open Source Project (2024)

A NOTE

e621 is currently changing their API standards. I'll be updating this as changes come in. This repo needs some updates for sure.

Changes

There are several changes to the API:

The URLs, paths and returned fields have changed.When updating posts, PATCH is used instead of POST.When removing favorites/votes/etc posts, DELETE is used instead of POST.The login parameters are now login for your username and api_key for the API key.You can also login with HTTP Basic Auth, which should be used instead of putting the login parameters in the URL of GET requests.

:label: About

"e621 offers a simple API to make scripting easy. All you need is a way to GET and POST to URLs. The ability to parse JSON or XML 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."

This is a repository for a better set of documentation for the site e621. If you're here, you know what this site is for.

The official documentation is available here, but it does not go very in depth on GET/POST endpoints and how they differ. Also some information is incorrect. This documentation is derived from the official API documentation but presented in a different and more in-depth manor.

Any general information will be available on this page. if you want to get more information on any specific endpoint, look in the docs/ folder of this repo.

:bulb: The Basics

The e621 API uses the two main HTTP REST methods, GET and POST. This is how you interact with the API, through REST URL endpoints. Any time you are retrieving data from the API you are using GET, any time your are giving the API information you are using POST.

e621 treats REST URLs as functions, so when you are GETting data, you pass your desired options after the base URL (separated by a ?).

A basic example looks like this:

https://e621.net/post/index.json?limit=10

:pencil2: Breaking down the URL

If you've dealt with REST APIs before this should seem familiar, if not here's a breakdown: The base URL will always be https://e621.net/, the next part of the URL post indicates the base endpoint we want to access. Changing this to something like artist would make all artist endpoints available to us.

The next part of the URL index is considered the 'action'. In this case the index action retrieves an index of posts.

After that, the .json part of the URL tells e621 that we want a JSON message returned, as opposed to XML. Both JSON and XML are available but some endpoints are only available in one or the other.

Lastly are your parameters. These change depending on the 'action' you are performing but the allow you to specify the type of data you are receiving from the API. In this case limit=10 is our parameter. This limits the response from e621 to 10 posts being returned.

:wrench: JSONP Support

The API does support JSONP. To use JSONP, append &callback=mycallbackfunction to your request. The resulting JSON will be encapsulated into a call to mycallbackfunction.

:mag: Example

/blip/index.json?callback=mycallbackfunction

would return a response like:

mycallbackfunction([{"user":"A User","response":null,"body":"Blip one","user_id":1,"id":1}])

:computer: Using cURL

If you are using cURL or something similar, you may experience failurs on your HTTP requests. The API declares this to be a problem with SSL. If this is the case, you will need to point cURL to a trusted certificate to compare the remote site's (e621.net) certificate with. You can get the certificate here. After you have the cert downloaded, you can point cURL to it like so:

curl_setopt($ch, CURLOPT_CAINFO, "/server_dir/apache/cacert.pem");

:exclamation: User-Agent Requirements

Making any requests to the e621 API requires a user-agent string. Making this something helpful like your username + project can help e621 get in touch with you if issues arise. (EX: my-username/myproject-1.0).

:exclamation: Rate limiting

:speech_balloon: Response Types

The type of response you get from e621 depends on the type of endpoint you requested (XML or JSON).

Any API calls that are modifying data (POST and some special GETs) will return a response like this:

{success: false, reason: "duplicate"}

For XML the response looks like this:

<?xml version="1.0" encoding="UTF-8"?><response success="false" reason="duplicate"/>

e621 also uses standard HTTP responses as well as some custom responses, listed below.

:unlock: Logging In

Some API actions (Mostly POSTs) will require you to have an e621 account and log in through the API to complete actions as yourself.

You must supply these parameters in your form headers even if you are sending a GET request. If you don't know what they are, check out POSTing-to-e621 in the docs/ folder.

The required form headers parameters look like this for logging in:

{ // ... form: { login: "YOUR_E621_USER_NAME", password_hash: "YOUR_API_KEY" }}

The example here is for Node.js's request library but this should be pretty easy to implement in your favorite language.

Every time you are making a GET/POST call to the API you must supply your information within the form header..

NOTE: To enable API access, you must go to your account settings and generate an API key. After you have enabled API access and generated an API key at least once, you can use the below URL to get your password_hash.

https://e621.net/user/login.json?name=USERNAME_HERE&password=PASSWORD_HERE

:clipboard: Available Base Endpoints

Posts

Refer to Posts in the docs/ folder.

Tags

Refer to Tags in the docs/ folder.

Aliases

Refer to Aliases in the docs/ folder.

Implications

Refer to Implications in the docs/ folder.

Artists

Refer to Artists in the docs/ folder.

Comments

Refer to Comments in the docs/ folder.

Blips

Refer to Blips in the docs/ folder.

Wiki

Refer to Wiki in the docs/ folder.

Notes

Refer to Notes in the docs/ folder.

Users

Refer to Users in the docs/ folder.

User Records

Refer to User-Records in the docs/ folder.

Dmail

Refer to Dmail in the docs/ folder.

Forum

Refer to Forum in the docs/ folder.

Pools

Refer to Pools in the docs/ folder.

Sets

Refer to Sets in the docs/ folder.

Favorites

Refer to Favorites in the docs/ folder.

Tag History

Refer to Tag-History in the docs/ folder.

Flag History

Refer to Flag-History in the docs/ folder.

Tickets

:boom: Errors?

:yum: Contributing

:heart: Donating

Like what I do?

Though just documentation, this project is licensed under the MIT License - see the LICENSE file for details.