Skip to content

Latest commit

 

History

History
70 lines (60 loc) · 4.42 KB

README.md

File metadata and controls

70 lines (60 loc) · 4.42 KB
Raw

Rust Query API

downloads license license

A versatile API facade for the Hypixel Auction API written in Rust. The entire auction house is fetched with NBT parsing and inserted into a PostgreSQL database in about 1-5 seconds every minute with low memory usage (varies depending on enabled features, network speed, hardware, and latency of the Hypixel API)! You can query by auction UUID, auctioneer, end time, item name, item tier, item id, price, enchants, bin and bids. You can sort by the item's bin / starting price. You can track the average price of each unique pet-level-rarity combination. You can track the lowest prices of all bins. It also can track new bins that are at least one million lower than previous bins. It can track the average auction and average bin prices and sales for up to seven days with custom 'averaging methods'.

Set Up

Prerequisites

Steps

  • Clone the repository
  • Rename the .example_env file to .env and fill out required fields OR set required fields using environment variables
  • Run cargo run --release (may take some time to build)
  • Use the API!

Configuration Fields or Environment Variables

  • BASE_URL: Base address to bind to (e.g. 0.0.0.0)
  • PORT: Port to bind to (e.g. 8000)
    • Online hosts will automatically set this
  • API_KEY: Optional key needed to access this API (NOT a Hypixel API key)
  • ADMIN_API_KEY: Optional admin key required to use raw SQL parameters (defaults to the API_KEY)
  • POSTGRES_URL: Full URL of a PostgreSQL database (should look like postgres://[user]:[password]@[host]:[port]/[dbname])
  • WEBHOOK_URL: Optional Discord webhook URL for logging
  • FEATURES: Features (QUERY, PETS, LOWESTBIN, UNDERBIN, AVERAGE_AUCTION, AVERAGE_BIN) you want enabled separated with a '+'
  • DEBUG: If the API should log to files and stdout (defaults to false)

Usage

Endpoints

  • /query
  • /pets
  • /lowestbin
  • /underbin
  • /average_auction
  • /average_bin
  • /average

Docs & Examples

  • See docs and examples here

Free Hosting

Deploy On Railway

Deploy on Railway

Deploy On Gigalixir

Steps to deploy on Gigalixir:

  1. Clone repository
  2. Install gigalixir CLI: pip3 install gigalixir
  3. Sign up: gigalixir signup
  4. Create app: gigalixir create -n NAME
  5. Set environment variables: gigalixir config:set key=value
  6. Deploy app: git push gigalixir
  7. Acess at https://NAME.gigalixirapp.com/

Free PostgreSQL Datbase

The free tier of Supabase is a great option with with plenty of storage and good performance.

Todo

  • Better documentation & more examples
  • Improve underbin