Coder Social home page Coder Social logo

api-football-wrapper's Introduction

Api-football-wrapper

An unofficial wrapper for Api-football & Api-Sports! (Work in progress)
Explore official api docs »

Usage example · Report Bug · Request Feature

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

There are several examples, for the major programming languages, which illustrate an example call for the use of the API of the api-football.com service within the official documentation.

The creation of this project was born from the need to:

  • Simplify the use of this service
  • Format the information coming from the requests simplifying the management

This project aims to allow the easy use of the information requested and received through this service and the implementation in other projects.

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Add Maven dependency in your project
    <dependency>
         <groupId>it.gbale.apisports.apifootball</groupId>
         <artifactId>apisports-apifootball</artifactId>
         <version>1.0</version>
    </dependency>

Installation

  1. Get a free or paid API Key at https://www.api-football.com/sports for more information see https://www.api-football.com/documentation-v3#section/Authentication
  2. Create an instance of ApiSports and insert your token
     ApiFootball apiFootball = new ApiFootball("Token");   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Example Section

(back to top)

Roadmap

  • Support endpoints API-FOOTBALL
  • Support endpoints API-BASKETBALL
  • Support endpoints API-BASEBALL
  • Support endpoints API-FORMULA-1
  • Support endpoints API-HANDBALL
  • Support endpoints API-HOCKEY
  • Support endpoints API-NBA
  • Support endpoints API-AMERICAN-FOOTBALL
  • Support endpoints API-RUGBY
  • Support endpoints API-VOLLEYBALL

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

(back to top)

License

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

(back to top)

api-football-wrapper's People

Contributors

baledevit avatar

Watchers

 avatar

api-football-wrapper's Issues

Release V1.0.0

Expected Behavior

Release first version

  • Version: 1.0
  • Maven Central
  • Gradle Central

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.