We try to maintain comprehensive and up-to-date documentation for various chan APIs. Typically a chan's in-house documentation is outdated and lacking examples, which forces developers to waste time figuring out how it really works. We are here to change that.
Each API title is also a link to our documentation on it, and the priority shields (TODO: Create small wiki page about them) will lead you to the site's original documentation.
- 420chan's API
- Closed source.
- Their documentation is detailed and lists example responses for each of their endpoints. It is good enough at the moment, but we should still have some documentation here for it in the future.
- Currently only being used by 420chan (420chan.org).
- 4chan's API
- Closed source (leaked sometime between 2007-2010 and in 2014 (2012?) though).
- While it does have some documentation, it's only for its
postobject. It lists multiple endpoints without going into detail about them, and doesn't seem to be updated very often. - Currently only being used by 4chan (4chan.org).
- Lynxchan's API
- Open source.
- The documentation is good, but a little disorganized. Certainly better than 4chan and vichan though.
- Currently being used by these sites.
- vichan's API
- Open source.
- This has the same pitfalls of 4chan's API documentation because it's literally just a slightly modified fork of theirs. The lack of frequent updates is less important here though as we can at least tell when vichan's API changes because it's open source.
- Currently being used by:
We have IRC channels to discuss pretty much anything related to chan APIs (and development in general):
#chandocs @ irc.rizon.net (webchat)
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0).
A Markdown version of the license is available in LICENSE.md in the root directory of this repository courtesy of GitHub user idleberg's project.