General information

These pages will house the documentation of endpoints under DecAPI.
This is currently work in progress and incomplete, which means that some endpoints lack documentation or may not be fully documented.
If you would like to contribute, take a look at the GitHub repository for this documentation.

Default options & results

These are options or results that will be the default, unless the notes about the endpoint mention otherwise.

  • The base URL for all endpoints is http://beta.decapi.me or https://beta.decapi.me.
  • HTTP requests are supported, but HTTPS (TLS 1.x) is encouraged.
  • The default HTTP method supported is GET.
  • Responses are Content-Type: text/plain.
  • For endpoints that mention JSON support without any further information, send Accept: application/json in the request header to receive the response as JSON instead.
  • Parameters are always required.
  • Query strings are never required.
  • Parameter/query string examples may be surrounded by "curly brackets", for example: {USERNAME}. These should be omitted in the actual requests.