/discord-api-spec

A human and machine readable Discord API Specification.

Mozilla Public License 2.0MPL-2.0

This repository is archived. See Discussions for more information.

Discord API Spec

Discord does NOT provide an API Specification. This repository aims to provide a human and machine readable Discord API Specification. The json folder contains valid JSON while submodule folders refer to programming language object-definition libraries.

How is it Created?

Read Contributing for more information or to contribute to the specification.

What can I do with this?

A machine readable specification will allow you to generate language types (i.e Go Structs) and other related code programmatically. This makes creating and updating a feature-complete API Wrapper Library low-effort and simple.

What is the alternative?

The current alternative Discord provides is to use an outdated contributor-led documentation. Discord API documentation does not provide JSON responses, and there is no guarantee that its Object tables are up-to-date nor standardized.

License

The Mozilla Public License 2.0 requires preservation of copyright and license notices (where the source is distributed). Publicly distributed-works that modify this project must open source the modified project (but the larger work that contains it may remain proprietary). For more information, read the MPL 2.0 FAQ.