@vermaysha/hoyolab-api

HoYoLab API - TypeScript/JavaScript HoYoLab API

GitHub Test Action Status Coverage Total Downloads LICENSE

Latest Version on Packagist GitHub package.json version GitHub Release Date - Published_At node-current

Its unofficial HoYoLab API Wrapper for getting hoyoverse some in-game data, including Genshin Impact, Honkai Impact 3rd.

# Install

For NPM
npm install @vermaysha/hoyolab-api

For Yarn
yarn install @vermaysha/hoyolab-api

*Note: This library only support ESM Mode

# Features

# HoYoLab API

Features Status
Displays a list of owned HoYoVerse game accounts ✔️
Displays the exploration history of the HoYoVerse game account that is owned according to the selected game ✔️

# Genshin Impact API

Features Status
Get detailed information of the selected account, including character, statistics and exploration history ✔️
Get daily login information on the hoyolab page ✔️
Get prize list information for daily login ✔️
Make claims on daily login rewards ✔️
Gets a full list of acquired characters, including weapons and artifacts used and constellations that have been acquired ✔️
Get a list of daily resources including the daily resin that has been obtained, the status of transformation tools and teapot coins ✔️
Get the history of obtaining primogems and mora through the Diary feature ✔️
Obtain a complete history of the results of the current and previous Spiral Abyss challenge ✔️
Claim the redeem code provided ✔️
  1. To begin, login with your HoYoLab (opens new window) Account or from Battlepass (opens new window).
  2. Type java in the address bar followed by the script down below.
  3. script:check = document.cookie.includes('ltoken') && document.cookie.includes('ltuid') || alert('Please logout and log back in before trying again, cookie is currently expired/invalid!'); cookie = document.cookie; check && document.write(`<p>${cookie}</p><br><button onclick="navigator.clipboard.writeText('${cookie}')">Click here to copy!</button><br>`)
  4. Once you've successfully ran the script, click the Click here to copy! button to copy the cookie.
  5. Finally, you can copy your cookie

# Documentation

view - Documentation (opens new window)

# License

@vermaysha/hoyolab-api Copyright (C) 2022 Ashary Vermaysha

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA