API Reference

This page contains a brief overview of the entire BCID API.

Caution

This page documents API endpoints that are not in production yet but will be included in the pending rewrite.

Internationalisation (i18n)

ByeCorps ID supports various languages. If you want to translate BCID, please check out our Weblate project.

Languages

GET https://id.byecorps.com/api/i18n/languages

Note

This endpoint is intended for the language switcher on the website. It does not support setting a language for a specific ID.

Returns the list of languages BCID is currently set up to support alongside the current language for this session.

{
    "response": {
        "success": true,
        "status_code": 200
    },
    "body": {
        "current": "en_UWU",
        "languages": [
            {
                "code": "en",
                "name": "English (Traditional)",
                "flag": "uk"
            },
            {
                "code": "en_US",
                "name": "English (Simplified)",
                "flag": "usa"
            }
        ]
    }
}

Misc

These items don’t fit into the other categories.

Status

GET https://id.byecorps.com/api/status

Used to check for uptime on the server, and returns the time of the request.

{
    "response": {
        "success": true,
        "status_code": 200
    },
    "body": {
        "message": "Science compels us to explode the sun!",
        "time": 1720279822
    }
}