README.md

HSR-API

A fan-made Rest API that gets character info from the game Honkai Star Rail by miHoYo/HoYoverse.
Honkai Star Rail API

Technologies Used

• Node.js
• Express.js
• PostgreSQL
• Vercel (for deployment)

API Endpoints

• GET https://hsr-api.vercel.app/api/v1/characters: Get all characters.
• GET https://hsr-api.vercel.app/api/v1/characters/date: Get all characters sorted by date.
• GET https://hsr-api.vercel.app/api/v1/characters/:id: Get a character by ID.
• GET https://hsr-api.vercel.app/api/v1/characters/:name: Get a character by name.
• GET https://hsr-api.vercel.app/api/v1/characters/element/:element: Get characters by element.
• GET https://hsr-api.vercel.app/api/v1/characters/path/:path: Get characters by path name.
• GET https://hsr-api.vercel.app/api/v1/characters/rarity/:rarity: Get characters by rarity(4 or 5).

Local Development

1. Clone the repository:

   git clone https://github.com/ajcastan0103/HSR-API.git
   

2. Install dependencies:

   npm install express pl node nodemon
   

3. Set up your local PostgreSQL database and update the connection details in the configuration files.

4. Run the development server:

   npm run dev
   

5. Access the API at http://localhost:3000.

References

• HoYoverse Website All characters made from the database are all properties by HoYoverse. This is a non-profit Rest API
• Honkai Star Rail Fandom Wiki
  • Used for obtaining image link addresses for the API.