Public API Beta

HAL has a public API that you may use to add antispam features to your own bot.

Access to this API does not grant developers the ability to ban anyone – it is simply a mechanism that white-labelled bots can use to introduce a strong layer of security to their groups.

The API always responds with JSON, containing status and message keys at the bare minimum, unless the response status code is not 200 OK.

Note that this API is rate-limited. Exceeding any limits will result in HTTP 429 errors. Additionally, this API is currently in testing. Whilst in this phase, limits are static, and cannot be changed. When this API reaches General Availability (GA), limits will be adjusted for developers that acquire an API token from us.

Endpoints

The following endpoints are available at the base host https://api.hal.chat: