mueslimak3r / api

Effortlessly use Helldivers 2 data in your apps, with the democratically approved HellHub API. 🌎

Home Page:https://documenter.getpostman.com/view/33840175/2sA35Bd54w

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HellHub Logo

The Official API For The Community Driven HellHub App.

Written 100% in TypeScript, running on Bun. Pulls data from the official game API and simplifies the data structure.


Postman CodeQL Tests

What is the HellHub API?

The HellHub API is a community-driven project that strives to provide easy access to the Helldivers 2 data. This project is part of the HellHub Collective.

Getting started

To start using the HellHub API, you can use the following base for your requests:

https://api-hellhub-collective.koyeb.app/api

Followed by the endpoint you want to access. Our data is updated every minute. For more information on the available endpoints, check out the postman collection.

Fair usage

To Enforce fair usage, we have implemented a rate limiter. The HellHub API has a rate limit of 200 requests per minute. To avoid hitting rate limits in your clients check the following headers in your response:

  • X-Rate-Remaining: The number of requests remaining.
  • X-Rate-Limit: The maximum number of requests per minute.
  • X-Rate-Reset: The time at which the current rate limit resets.
  • X-Rate-Count: The number of requests made in the current minute.

We reserve the right to block any IP address that uses the API in a way that is not fair to other users, or that is trying to abuse the system.

Disclaimer

The unofficial game API was not explicitly made usable by Arrowhead Game Studios for third parties and thus may be subject to change at any time. This project will be updated to reflect any changes to the data source.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Effortlessly use Helldivers 2 data in your apps, with the democratically approved HellHub API. 🌎

https://documenter.getpostman.com/view/33840175/2sA35Bd54w

License:MIT License


Languages

Language:TypeScript 97.7%Language:Dockerfile 2.1%Language:JavaScript 0.2%