GithubHelp home page GithubHelp logo

khuxbot-api's Introduction

khuxbot.com API Documentation

API documentation for the most recent version of khuxbot

For more information on returned data + a few more examples, visite the main docs (this will be more frequently updated) khuxbot

Version 2

Version 1 of the API is depreciated and will no longer be supported/updated.

Usage

The endpoint for retrieving data is: https://www.khuxbot.com/api/v2/get

It is recommended you change the content type header to json with Content-Type: application/json

The post request body must be in JSON. The following paragraths will outline which fields can be used

Filter

You can specify how to filter the data to your liking.

Example: {filter:{"hits":8,"direction":"upright"}}

You can find a full list of filters here

Integer Filtering

It should also be noted that all keys which accept integer values also accept a min and max key object

Example {"filter":{"hits":{"max":3}}

This will retrieve all medals which deal at most 3 hits

Min and Max are Inclusive

If you use {"min":3, "max":4} it will return all medals which are 3 or 4 in value

Format

You can change which fields you want returend by adding the format key. The value must be an array of strings

Example: {"format":["name", "direction", "rarity"]}

Buff

You can also filter by which buff each medal provides

The buff value must be an object with either the "include" key or "exclude" key (or both)

You can find a full list of buff names here

Dynamic Spriteshets

The API now supports the generation of dynamic spritesheets which depend on which query you use.

By adding the {"type":"spritesheet"} key to the object, the server will create a custom spritesheet depending on which medals were returned.

The first time you run your query, it may take some time (Tests determine about 1-2 minutes for 200 medals) but later queries will be milliseconds.

khuxbot-api's People

Contributors

leftn avatar

Watchers

 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.