You need an API key to access all of the APIs. You could contact me to obtain one.
Citing the name of my website - HyMinions, and including a link to HyMinions in your own application is appreciated, but not necessary.
The documentation is brief, contact me if anything is unclear to you. Thank you.
GET /api/minions/
Your input should be in the form of a query string, for example /api/minions?key=RANDOM&name=KidProf
Refer to the documentation of the minions page if you are not sure what some of the settings below do.
key
(REQUIRED): Your API keyname
: Minecraft Name for tier estimateprofile
: Profile number (0 represents the first profile, 1 represents the second...)slots
: Number of minion slots for tier estimate (It defaults to 23 minion slots when slots
, name
and tierType
are not present)tierType
,tier
: Set all minions to a specific tier. To do so, set tier
to a number between 1 to 12. (12 means max level), and tierType
to 0.fuel
: Fuel level of minions (in percentage) (default: 25)offlineTimeUnit
: 0 for hours, 1 for days (default: hours)offlineTime
: Offline time in hours (default: 24)soulflow
: 1 when soulflow is used (default: 0)superCompactor
: 3 for Dwarven Super Compactor, 2 for Super Compactor, 1 for Compactor, 0 for none (default: 3)diamondSpreading
: 1 when diamond spreading is used (default: 1)noCrafting
: 1 when no crafting (default: 0)showDetails
: 1 for showing details (default: 1)sellingTo
: 1 for max profit, 0 for NPC only (default: 1)sellingMethod
: Selling method in the bazaar, 1 for sell instantly, 0 for sell offer (default: 1)tax
: Tax in percentage (default: 1.125)A JSON will be returned
Refer to the documentation of the minions page if you are not sure what some of the outputs below are. There are more outputs over there for HyMinions internal use only and of no use, so you could safely ignore unmentioned fields.
status
: Will give success
when there is no error, and error
when there is.errorMsg
: A string describing the error when status
is error
.settings
: The parameters it has used. They should match your inputs and default values specified above.minions
: An array containing all information you need on minions profit. Each array element corresponds to a minion. It is sorted in descending order of totalProfit
name
: Name of the miniontierDelay
: Seconds between each action of a minion, it is an array, the i th element of the array corresponds to the tier delay of tier i+1tier
: Tier of the minion (according to your settings)fuel
: Fuel of the minion (according to your settings)hasDiamondSpreading
: Whether the minion has diamond spreading (according to your settings, and whether there is enough minion slots)outputProducts
: Raw products the minion generates, an element of the array corresponds to each output product (as a side note, products
is for HyMinions internal use only, which can be ignored)name
: Name of the product numberOfItems
: Number of products it generates in the duration you specified in your settingsunitPrice
: Unit price of the product in stringprofitPerItem
: numberOfItems
*unitPrice
in floating pointtotalProfit
: Total profit in floating point totalProfitText
: Total profit in stringtools
: Minion upgrades usedDocumentation coming soon.
GET /api/minionscost/
Documentation coming soon.
GET /api/forge/