Skip to content

ln2r/jinsoyun-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jinsoyun Bot Data API Endpoint

API for jinsoyun Discord bot with the same name.

Features

  • Daily and Weekly challenges data
  • Charater data
  • Hourly market data

Installation / Getting Started

Url Endpoints

  • Challanges data (Daily, Weekly)
    • /challenges all challenges data
    • /challenges/:query specific data (example: /challenges/monday)
  • Character data
    • /character/:region/:query specified character data (example: /character/na/wquin hollow)
  • Market data
    • /market/:region/:query specified item data
  • Event data
    • /event all event data

Requirements:

How-to:

  • Configuration located in .env file Example

    • MONGODB_URL = your mongodb connection url
    • API_PORT = your desired port for your api
    • BNS_CHALLENGES_URL = this url points to hongmoon-archives list of challanges pages, best to not change it.
    • BNS_NEWS_URL = this url points to Blade & Soul news page, best to not change it.
    • CHALLENGES_EXPIRE = max time to update challenges data (currently set to 1 week in ms)
    • CHARACTER_EXPIRE = max time to update character data (currently set to 1 hour in ms)
    • EVENT_EXPIRE = max time to update event data (currently set to 1 week in ms)
  • Open Node.js command prompt and navigate to your root directory.

  • Do npm update to get app depencies.

  • Do node index.js to run the api.

Credits

  • Challenges data obtained from Hongmoon Archives
  • Market data obtained from Silver BNS API
  • Character data obtained from Blade and Soul character information page.
  • Event data obtained from Blade and Soul news page.

Contact

  • Discord: ln2r#1691

License

Code of this project is licensed under MIT license