Skip to content

etr-dev/UFC-API

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

UFC Webscraping API

A webscraper that retrieves and sends data about upcoming UFC Events through a REST api!
Explore the docs »

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

About The Project

Product Name Screen Shot

After searching the internet I was unable to find any free MMA/UFC APIs that displayed any betting odds, event details, etc. that were public. Any APIs that relayed this data was blocked behind extremely expensive paywalls meant to be bought by big companies. I wanted to make my own API to correct this issue.

Why is this project important:

  • It pulls data directly from the official UFC website dynamically so it will stay in service even if I stop updating it.
  • Plans to maybe host the API through my own server eventually
  • This is 100% free and can be ran on local machines at no cost 😄

This is part of the backend for my Discord sports betting bot. You can view my repo BetBot to look more into that.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

Getting Started

To get started clone the repo to your local machine and begin installing it's dependencies. Since the node_modules folder is not included in the repo you will need to install the dependencies using node.

Prerequisites

To run this app you will need to install nodejs

Installation

  1. Clone the repo
    git clone https://github.com/erobin27/UFC-API.git
  2. Install NPM packages
    npm install
  3. run the file index.js with node
     node ./server/index.js

(back to top)

Usage

I plan to use this API to create discord bots that can use the betting odds for UFC fights. This will be useful for sports discord servers, MMA servers, and for fun projects.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Dynamically return next UFC Event details
  • Return all upcoming UFC Events
  • [] Get Winners of fights
  • [] Get Event by URL
  • [] API Key Generation
  • [] Host on dedicated server

See the open issues for a full list of proposed features (and known issues).

(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 GNU General Public License v3.0. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/erobin27/UFC-API

(back to top)

Acknowledgments

Credits

(back to top)

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published