https://github.com/tricked-dev/hykey

https://github.com/tricked-dev/hykey

axum hypixel hypixel-api hypixel-proxy rust

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tricked-dev/hykey
• Owner: Tricked-dev
• License: apache-2.0
• Created: 2023-02-09T16:23:40.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-09T21:19:35.000Z (over 2 years ago)
• Last Synced: 2025-01-16T10:17:17.640Z (5 months ago)
• Topics: axum, hypixel, hypixel-api, hypixel-proxy, rust
• Language: Rust
• Homepage:
• Size: 37.1 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HyKey

A hypixel api proxy that caches to redis and handles rate limits.

## features

- Caches to redis

  - it returns the cached data of a endpoint for 60 seconds

  - it also returns the cached data if the ratelimit is hit to prevent 429s

- Handles rate limits

- Removes the need for api keys

## Public instance

- [hy.tricked.dev](https://hy.tricked.dev)

  - please dont break or abuse it lol the key only has a 60 requests per minute limit

## Setup

You need to have a redis server running on your machine. I recommend using dragonflydb the docker-compose file in this repository will start a redis server for you.

```

Usage: hykey [OPTIONS] --api-key 

Options:

  -a, --api-key           [env: API_KEY=]

  -k, --key-limit       [env: KEY_LIMIT=] [default: 60]

  -r, --redis-url       [env: REDIS_URL=] [default: redis://127.0.0.1/]

  -b, --bind-addr       [env: BIND_ADDR=] [default: 0.0.0.0]

  -p, --bind-port       [env: BIND_PORT=] [default: 4000]

  -u, --hypixel-api   [env: HYPIXEL_API=] [default: https://api.hypixel.net]

  -h, --help                       Print help

```