Skip to content

Enchanting, Farming, Soulbound networth support | Bingo Profile, Calendar & Auctions Endpoints | Updated Docs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 50 commits into
base: master
Choose a base branch
from
Open

Enchanting, Farming, Soulbound networth support | Bingo Profile, Calendar & Auctions Endpoints | Updated Docs #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
ec35d0d
Added description to Fetchur items
DuckySoLucky Aug 11, 2022
2e7b603
Update
DuckySoLucky Aug 12, 2022
cc2a6b4
Merge branch 'Altpapier:master' into master
DuckySoLucky Aug 12, 2022
47d3e90
Update README.md
DuckySoLucky Aug 12, 2022
4dd8838
lilyWeight 2.7.0
DuckySoLucky Aug 12, 2022
8bda1d6
Added Enchanting tag, added belts to the Farming tag. Added Auto pet …
DuckySoLucky Aug 16, 2022
438c5b7
fix(trapper_quest.last_task_time)
DuckySoLucky Aug 16, 2022
e99138d
Added `bingo` Endpoint
DuckySoLucky Aug 17, 2022
4bac193
Merge branch 'master' of https://github.com/DuckySoLucky/SkyHelperAPI
DuckySoLucky Aug 17, 2022
069e302
`Calendar` Endpoint
DuckySoLucky Aug 17, 2022
27b02dd
Merge branch 'master' of https://github.com/DuckySoLucky/SkyHelperAPI
DuckySoLucky Aug 17, 2022
3f3c9ff
`Calendar` Endpoint
DuckySoLucky Aug 17, 2022
a41ee32
`mayor` Endpoint
DuckySoLucky Aug 17, 2022
15dced9
Update `README.md`
DuckySoLucky Aug 17, 2022
8fa06e3
`Auctions` Endpoint
DuckySoLucky Aug 18, 2022
29fe9b4
MattTheCuber's change & removed commented code
DuckySoLucky Aug 18, 2022
7ceb2d3
New Format
DuckySoLucky Aug 18, 2022
402d8bb
`Auctionhouse` Endpoint
DuckySoLucky Aug 19, 2022
5b6a310
Merge branch 'master' of https://github.com/DuckySoLucky/SkyHelperAPI
DuckySoLucky Aug 19, 2022
1b5ba10
`Auctionhouse` Endpoint
DuckySoLucky Aug 19, 2022
c804613
`Auctionhouse` Endpoint
DuckySoLucky Aug 19, 2022
f227797
fix(typo)
DuckySoLucky Aug 19, 2022
1f2edeb
Revert `auctionHouse` Endpoint
DuckySoLucky Aug 21, 2022
a6d39ba
Merged some stuff so no conflicts, added soulbound networth
DuckySoLucky Aug 25, 2022
e0c0491
fix(soulbound, all items had soulbound tag)
DuckySoLucky Aug 29, 2022
5571917
fix(undefined gemstone values)
DuckySoLucky Aug 29, 2022
5fabbad
fix(pets data, merged with Matt's changes)
DuckySoLucky Sep 1, 2022
4f92aad
fix(enderDragon pet)
DuckySoLucky Sep 1, 2022
a1d7060
fix(updated skill exp pets, added more symbols)
DuckySoLucky Sep 1, 2022
54bbf9f
fix(typo)
DuckySoLucky Sep 1, 2022
ae87590
fix(more pet changes)
DuckySoLucky Sep 1, 2022
f82c7c3
fix(PET_SKIN_BAL_INFERNO)
DuckySoLucky Sep 1, 2022
1a39113
fix(calendar changes)
DuckySoLucky Sep 1, 2022
fb960e0
fix(bingo endpoint)
DuckySoLucky Sep 1, 2022
5ed738d
fix(bingo endpoint)
DuckySoLucky Sep 1, 2022
6c7a6b1
Merge branch 'master' of https://github.com/DuckySoLucky/skyhelperAPI
DuckySoLucky Sep 1, 2022
b6700e3
Merge with `2ee1b02` (MattTheCuber's nw changes)
DuckySoLucky Sep 2, 2022
6c7d069
Cleaned some parts of code, updated nw
DuckySoLucky Sep 2, 2022
fb32b64
Optimized some parts of code
DuckySoLucky Sep 2, 2022
e5e2e20
fix
DuckySoLucky Sep 2, 2022
9ebff60
fix(farming formatting)
DuckySoLucky Sep 2, 2022
5127e16
Active auctions data, reverted mayor endpoint
DuckySoLucky Sep 2, 2022
a8814e0
Revert UUID convertion
DuckySoLucky Sep 2, 2022
803cd30
Merge branch 'master' into master
DuckySoLucky Sep 2, 2022
a3064d3
feat: more data about talismans, fixed MM
DuckySoLucky Sep 3, 2022
cdbf6d6
fix
DuckySoLucky Sep 3, 2022
d16a4d3
MattTheCuber's request
DuckySoLucky Sep 3, 2022
3a3dcee
feat(accessories): chumming talisman
DuckySoLucky Sep 7, 2022
005f8ed
Update talismans.js
DuckySoLucky Nov 19, 2022
3b652b5
fix: typo
DuckySoLucky Nov 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 59 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Node.js >= 14
2. Install all dependencies using NPM by going into the `SkyHelperAPI` folder
`npm install`

3. Set up the environment variables
3. Set up the [environment variables](#Environment-Variables)

4. Start the API using `node .` or `npm start`

Expand All @@ -39,19 +39,70 @@ The API automatically updates upon starting. If you wish to not want that, chang

### `GET` /v1/profile/:user/:profile

### `GET` /v1/items/:user

### `GET` /v1/items/:user/:profile

### `GET` /v1/auctions/:user

### `GET` /v1/bingo/:user

### `GET` /v1/calendar

### `GET` /v1/fetchur

| Parameter | Description |
| --------- | ------------------------------------------ |
| user | This can be the UUID of a user or the name |
| profile | This can be the users profile id or name |
| Parameter | Description |
| ------------- | --------------------------------------------- |
| user | This can be the UUID of a user or the name |
| profile | This can be the users profile id or name |

# Features:

| Feature | Description | Endpoint |
| -------------- | ----------------------------------------------------------------------- | ---------------------- |
| skills | Get a player's skills | profile/profiles |
| networth | Get a player's networth including all information about the calculation | profile/profiles |
| weight | Get a player's Senither and Lily weight | profile/profiles |
| dungeons | Get a player's dungeons stats | profile/profiles |
| bestiary | Get a player's bestiary | profile/profiles |
| crimson | Get player's Crimson Isle data | profile/profiles |
| trophy_fish | Get player's trophy fishing caches and information | profile/profiles |
| enchanting | Get a player's enchanting stats including experimentations | profile/profiles |
| farming | Get a player's farming stats including Jacob's contests | profile/profiles |
| mining | Get a player's mining stats including HotM tree and forge | profile/profiles |
| slayer | Get a player's slayer stats | profile/profiles |
| milestones | Get a player's pet milestones (rock / dolphin) | profile/profiles |
| missing | Get a player's missing talismans including their price | profile/profiles |
| kills | Get a player's most killed mobs | profile/profiles |
| deaths | Get a player's deaths | profile/profiles |
| armor | Get a player's armor | profile/profiles/items |
| equipment | Get a player's equipment | profile/profiles/items |
| pets | Get a player's pets | profile/profiles |
| talismans | Get a player's talismans | profile/profiles |
| collections | Get a player's collections | profile/profiles |
| minions | Get a player's minions | profile/profiles |
| cakebag | Get a player's new year cake editions | profile/profiles |
| backpack | Get player's backpacks | items |
| quiver | Get player's quiver | items |
| talisman bag | Get player's talisman bag | items |
| backpack icons | Get data about player's backpacks | items |
| ender chest | Get player's ender chest | items |
| potion bag | Get player's potion bag | items |
| fishing bag | Get player's fishing bag | items |
| personal vault | Get player's personal vault | items |
| inventory | Get player's inventory | items |
| candy bag | Get player's candy bag | items |
| items | Check what item fetchur wants today | fetchur |
| auctions | Get a player's active and ended auctions and information about them | auctions |
| bingo | Get a player's bingo profile and progress | bingo |
| calendar | Get Skyblock's calendar including all events | calendar |

**Documentation**: https://api.altpapier.dev

# Credit:

- https://github.com/zt3h/MaroAPI
- https://github.com/zt3h/MaroAPI

- https://github.com/Senither/hypixel-skyblock-facade
- https://github.com/Senither/hypixel-skyblock-facade

- https://github.com/SkyCryptWebsite/SkyCrypt
- https://github.com/SkyCryptWebsite/SkyCrypt
Loading