Help ∴ Web Service API ∴ Introduction to our RESTful WebService API

Our a REST WebService/API is:

Mostly open (no login or API key required)
Free, including for commercial use (terms and conditions apply)
Browsable (you can try it on your browser)
Intuitive and easy to use: just add an api/ prefix to the URL path of a website page to reach its API counterpart (may not work for all pages).

If you have any problems, suggestions, criticisms or whatever, we have a Developers channel in our Discord server - feel free to drop by and share your thoughts with us.

Documentation

Currently, there's very little documentation about the API. Your best choices are sending us a message on our discord, using our contact form or just trying to figure it out yourself.

If you choose the latter approach, please use the sandbox server in order to avoid unnecessary load in the production server.

Authentication

Most of the API does not require authentication and can be readily accessed by anyone. All open endpoints are read-only.

The exception are user-related endpoints, which also allows writing information to the user's profile. These require an AuthToken obtained by logging in using the user's username and password: API Authentication.

Sandbox Server

The sandbox server is a test ground for developers, both our team and external developers interested integrating our systems with their own.

It exists as a means to let developers freely mess around the APIs without worrying about vandalizing data in the production server or producing excessive requests.

Just a heads-up: we occasionally wipe the sandbox server, as well as perform various tests on it, so any data might be deleted at any time, and the server might arbitrarily become unavailable at times.

If you don't feel like creating an account, you can also use the demo user for testing purposes. The username is demo and the password is demo. The user is deleted and recreated every day at midnight UTC.

Next
WebService API Quick Start

Code	Result
New Line: Add a new line by ending the previousone with 2 spaces Line One Line Two	Line One Line Two
Paragraph: Add a paragraph by having 1 or more empty lines between text Paragraph One Paragraph Two	Paragraph One Paragraph Two
Headers: # Header ## Smaller Header ... ###### Smallest header	Header Smaller Header ... Smallest header
bold	bold
italic	italic
__underline__	underline
~~strikethrough~~	~~strikethrough~~
`inline-code / highlight`	inline-code / highlight
\|\|spoilers\|\|	spoilers
Block of code: ``` function code: return true; ```	`function code: return true;`
Quotes: > I am a blockquote! > > New lines need an empty line between them!	I am a blockquote! New lines need an empty line between them!
Bulleted lists use asterisks for items: * Item 1 * Item 2	Item 1 Item 2
Numbered list use 1. for items: 1. Item A 1. Item B	Item A Item B
---
Links: [I am a link, not a Zelda](https://vgjournal.net/)	I am a link, not a Zelda
There is also support for definition lists: Term 1 : Term 1 definition : Another definition for Term 1 Term 2 : Term 2 definition	Term 1 Term 1 definition Another definition for Term 1 Term 2 Term 2 definition
Footnotes: Title[^title-reference] [^title-reference]: This is an example footnote * Footnotes are not displayed in previews	Title¹ This is an example footnote ↩

Documentation

Authentication

Sandbox Server

Header

Smaller Header

Smallest header