• Reference API Versions
  • Reference Changelog
  • Reference How We Version
  • API Versions

    v1 (latest version)

    Date Live: November 23, 2022, 8:28 am GMT

    Initial API Release.

    View v1 docs


    Oct 27, 2022

    Deprecating X-Ratelimit headers

    How We Version

    Latest API Version: v1

    Our aim with is to offer developers the most powerful and flexible mod API available. This means continually evolving and improving based on your requirements and pushing changes when required. The majority of these changes will be non-breaking and deployed immediately, however there will be times when breaking changes are needed. To ensure your implementations are not affected by the changes, we have architectured a versioning system that aims to maintain backwards compatibility and allow you to upgrade your implementation at a time that suits.

    How We Handle Versioning

    Upon first look, our implementation is consistent with many other REST API's, where you have a version specified in the URL and can change that value as required. The API follows this convention - however, we don't treat our versions as 'major' and instead we release a new version each time breaking changes are made. This allows us to release updates as frequently as is deemed required, with no impact on existing API consumers. Documentation is also preserved for past versions, so whilst we recommend you use the latest version of the API, we will always aim to support legacy versions.

    Versioning Format Convention

    For the initial release of the API, v1 is a valid format and version. Future releases will continue to follow this convention, by incrementing the version number, i.e. v[0-9]+

    Version Examples

    Version Requests

    Example cURL request
    curl -X GET

    When you make a request, setting the version of is a requirement as it forms part of the URL required to make a successful request.

    Handling invalid versions

    When making requests to the API, you need to be sure you know what functionality is available to you and what you can expect the API to do under every situation. With that said, and in the interest of being as explicit as possible if you supply a version in the URL of your request that is not listed in the changelog below - a 404 Not Found will be returned in the form of the Error Object.

    What are breaking changes

    The benefit of the approach we have taken to versioning, is it allows us to push breaking changes and continually improve the API without impacting your application until you update. To clarify, for the API the following are what constitutes as breaking changes:

    Non-Breaking (not covered in changelog) Breaking Changes
    Adding new fields to an object Modifying or removing a field in an object
    Adding new events Modifying or removing an endpoint's path
    Adding new objects to a response Modifying any HTTP code that could returned by a request
    Adding new headers to a request/response Modifying any HTTP error code that could returned by any endpoint
    Changing the ordering of items in a response Modifying or removing any request/response header

    Changes that are non-breaking will continue to be delivered to you regardless of which API version you are using, and documentation for every version will continue to be updated to reflect these changes. Only breaking changes described above will fall under this versioning system.