Skip to content

ginorey/itstimeAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

itsTimeAPI

Free Open Source UFC API [NO LONGER WORKS]
Explore the docs »

View Documentation · Report Bug · Request Feature

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

About The Project

Free Open Source UFC API.

This is an ongoing project, therefore everything is subject to change. Currently you will be able to interface with the API and retrieve fighter data. Check the roadmap below for further features.

This repository holds the code that runs www.itsTimeAPI.com and its API. You can use this API for free, no email or API key required.

The links to retrieve data is held in a private repository elsewhere.

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

The only prerequisite is to install Python. Once you have Python installed we will install all of the requirements below.

Installation

  1. Clone the repo
    git clone https://github.com/ginorey/itstimeAPI
  2. CD into the directory
    cd itstimeAPI/
    
  3. Install Required Packages
    pip install -r requirements.txt
  4. Host Locally
    flask run
  5. Check Documentation for how to interact with API.

Heads Up!!

  • Since you are running locally make sure to use your local ip instead of the site address.
  • You will only be able to have access to our sample data. For full access please use our API.

Instead of this:

curl "https://itstimeapi.com/api/allfighters"

Try:

curl "localhost:5000/api/allfighters"

Run in Postman

(back to top)

Roadmap

  • Add Each Fighters Fights
  • Fix Documentation Formatting
  • Add Data Pagination
  • Update Documentation to show Pagination
  • Add Fighter ID Queries
  • Update Documentation to show FIghter ID Queries
  • Add Further Languages to Documentation
    • Python
    • Ruby
    • Javascript
  • Add UFC Events

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 is greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to give the project a star!

Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Gino Rey - LinkedIn - gino.rey@outlook.com

If you want a copy of the raw data please email me at gino.rey@outlook.com

Personal Site - Link

Discord: Gino "Genebean" Rey#8091

(back to top)

About

🥊 Open Source UFC API 🥊

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published