mashurex / FantasyDataAPI

API for FantasyData, Real time fantasy football data feeds for your website or mobile app. Forked from Gridiron Guru.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FantasyDataAPI PHP Client wrapper

PHP Client Wrapper for FantasyData, a Real time fantasy football data API providing feeds for your website or mobile app. This is a fork from the original Gridiron Guru GitHub project that has been updated to work with the v2 NFL FantasyData APIs and add support for updated and new API request methods.

Requirements

This module requires the use of Composer, you will find additional software requirements in the packaged composer.json file.

In addition, you will need to obtain an api key from the FantasyData Portal. The service offers a Free Trial as well as a Developer subscription for those getting started.

Usage

Using the library requires only an API key

  $client = new FantasyDataAPI\Client( "Your FantasyData API key" );
  $result = $client->Timeframes(['Type' => Timeframes\Type::KEY_CURRENT]);

Installing the library with Composer

To easily include the FantasyDataAPI into your project, you should be using Composer. To do so, add lines similar to the following to your project's composer.json file.

"require": {
    "php": ">=5.4",
    "curvesoftware/gridiron-guru-fantasy-data-api" : "2.*",
},

"repositories": [ {
    "type": "vcs",
    "url": "https://github.com/mashurex/FantasyDataAPI"
}],

Open Source

This project is built on top of a number of open source projects, but I wanted to specifically call out and thank the Guzzle project. Guzzle is a PHP HTTP client and webservice framework for building RESTful web service clients.

Documentation

All documentation can be found in the doc folder.

Contributing

LICENSE

This module is licensed using the BSD 2-Clause License:

Copyright (c) 2014 Robert Gunnar Johnson Jr.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

About

API for FantasyData, Real time fantasy football data feeds for your website or mobile app. Forked from Gridiron Guru.

License:Apache License 2.0


Languages

Language:PHP 100.0%