/joe-api-v2

APIs to get TVL, APR, APY and much for for Trader Jor Protocol. Docs at - https://documenter.getpostman.com/view/13371978/UVeDs7Pt

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Trader Joe API v2

API for Trader Joe to calculate TVL, APR, APY and much more
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Poster Image

This is a project submission for Moralis + Avalanche Hackathon. The task was to create a set of APIs to calculate APY, APR ,and TVL for Trader Joe's Platform. The joe-api-v2 has following features -

  • Versioning support currently has v1 and v2 API paths.
  • Backward compatible with joe-api. All the joe-api APIs are available at https://joe-api-v2.herokuapp.com/v1/.
  • All the new APIs are available at - https://joe-api-v2.herokuapp.com/v2/.
  • Awesome API documentation available here - Postman Documentation
  • Always returns a json object in response.
  • Have rate limiting configuration. Each user/IP can make 1000 API calls in 15 mins.
  • Implemented caching to provide a blazing-fast response.
  • The cache is auto-updated once the data is expired by timely jobs.
  • Build with typescript for a better developer experience.
  • Has a great logging feature to debug the production app.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Nodejs (14.x or higher)

  • yarn

    npm install --global yarn

Installation

  1. Clone the repo

    git clone https://github.com/viral-sangani/joe-api-v2

  2. Install NPM packages

    yarn

(back to top)

Usage

  1. Start the API server

    yarn start

  2. Refer documentation for testing endpoints

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Viral Sangani - @viral_sangani - viral.sangani2011@gmail.com

Project Link: https://github.com/viral-sangani/joe-api-v2

(back to top)

Acknowledgments

List of resources I find helpful and would like to give credit to.

(back to top)