Giter Club home page Giter Club logo

hykey's Introduction

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

Setup

Docker: ghcr.io/leon-th/hykey

Docker Compose: docker-compose up -d


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 <API_KEY>

Options:
  -a, --api-key <API_KEY>          [env: API_KEY=]
  -k, --key-limit <KEY_LIMIT>      [env: KEY_LIMIT=] [default: 60]
  -r, --redis-url <REDIS_URL>      [env: REDIS_URL=] [default: redis://127.0.0.1/]
  -b, --bind-addr <BIND_ADDR>      [env: BIND_ADDR=] [default: 0.0.0.0]
  -p, --bind-port <BIND_PORT>      [env: BIND_PORT=] [default: 4000]
  -u, --hypixel-api <HYPIXEL_API>  [env: HYPIXEL_API=] [default: https://api.hypixel.net]
  -h, --help                       Print help

hykey's People

Contributors

tricked-dev avatar leon-th avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.