pruk-sr / hoyoapi

HoYoAPI is an unofficial API Wrapper library developed to facilitate communication with the official HoYoLab API.

HoYoAPI - TypeScript/JavaScript HoYoAPI

This is a NodeJS library designed as a connector to the Official HoYoLab API, commonly accessed by browsers easily and quickly. This library supports both ESM and CJS, but can only be used in NodeJS environments starting from version 8.17 and above.

Install

For NPM
npm install hoyoapi

For Yarn
yarn install hoyoapi

Features

Features	Genshin Impact	Honkai Impact	Honkai Star Rails
Daily Check-In	✅	✅	✅
Redeem	✅	✅	✅
Battle Chronicles	✅	✅	✅
Diary	✅	❌	❌
Daily Note	✅	❌	✅
TCG	✅	❌	❌

How to obtain HoYoLab Cookie

1. To begin, login with your HoYoLab Account or from Battlepass.
2. Type java in the address bar followed by the script down below.

3. script: (function(){if(document.cookie.includes('ltoken')&&document.cookie.includes('ltuid')){const e=document.createElement('input');e.value=document.cookie,document.body.appendChild(e),e.focus(),e.select();var t=document.execCommand('copy');document.body.removeChild(e),t?alert('HoYoLAB cookie copied to clipboard'):prompt('Failed to copy cookie. Manually copy the cookie below:\n\n',e.value)}else alert('Please logout and log back in. Cookie is expired/invalid!')})();

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

About a cookieTokenV2

cookieTokenV2 can be obtained on the redeem code page of each game, for example, Genshin Impact Gift. However, it is important to note that cookieTokenV2 has a short expiration time, so if it has expired, it needs to be manually refreshed. It has been observed that every few days, when logging in to the game Hoyoverse, it always requests reauthentication first.

Documentation

License

MIT License

Copyright (c) 2023 Ashary Vermaysha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.