npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

aping-plugin-footballdata

v0.5.6

Published

FootballData plugin for apiNG

Downloads

13

Readme

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-footballdata is a football-data.org API plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. ACCESS TOKEN
    1. Generate your access_token
    2. Insert your access_token into aping-config.js
  3. USAGE
    1. Models
    2. Request

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

II. Include file

Include aping-plugin-footballdata.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-footballdata/dist/aping-plugin-footballdata.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-footballdata/dist/aping-plugin-footballdata.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/aping.plugin-footballdata/latest/aping-plugin-footballdata.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-footballdata.min.js"></script>

III. Add dependency

Add the module jtt_aping_footballdata as a dependency to your app module:

angular.module('app', ['jtt_aping', 'jtt_aping_footballdata']);

IV. Add the plugin

Add the plugin's directive aping-footballdata="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/fixture.html"
    model="fbd-fixture"
    aping-footballdata="[{'leagueId':394, 'matchday':5}]">
</aping>

2. ACCESS TOKEN

I. Generate your api_key

II. Insert your api_key into aping-config.js

Create and open js/apiNG/aping-config.js in your application folder. It should be look like this snippet:

angular.module('jtt_aping').config(['$provide', function ($provide) {
    $provide.value("apingDefaultSettings", {
        apingApiKeys : {
            footballdata: [
                {'api_key':'<YOUR_FOOTBALLDATA_API_KEY>'}
            ],
            //...
        }
    });
}]);

:warning: Replace <YOUR_FOOTBALLDATA_API_KEY> with your footballdata api_key

3. USAGE

I. Models

Supported apiNG models

| model | content | support | |----------|---------|---------| | fbd-team | teams from football-data.org | full | | fbd-league | leagues from football-data.org | full | | fbd-player | players from football-data.org | full | | fbd-fixture | fixtures from football-data.org | full | | fbd-table | tables from football-data.org | full |

support:

  • full: the source platform provides a full list with usable results
  • partly: the source platfrom provides just partly usable results

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Request Team by teamId

| parameter | sample | description | optional | |----------|---------|---------|---------|---------| | teamId | 5 | footballdata-org id of the team | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'teamId':'5'}]
  • [{'teamId':'18'}, {'teamId':'7'}]

Request Teams by leagueId

| parameter | sample | description | optional | |----------|---------|---------|---------| | leagueId | 394 | footballdata-org id of the league | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'leagueId':'394'}]
  • [{'leagueId':'398'}, {'leagueId':'400'}]

Request Players by teamId

| parameter | sample | description | optional | |----------|---------|---------|---------| | teamId | 5 | footballdata-org id of the team | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'teamId':'5'}]
  • [{'teamId':'18'}, {'teamId':'7'}]

Request League by id

| parameter | sample | description | optional | |----------|---------|---------|---------| | leagueId | 394 | footballdata-org id of the league | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'leagueId':'394'}]
  • [{'leagueId':'398'}, {'leagueId':'400'}]

Request Leagues by year

| parameter | sample | description | optional | |----------|---------|---------|---------| | year | 2015 | year of the league. use $CURRENT for the current year | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'year':'2015'}]
  • [{'year':'$CURRENT'}, {'year':'2013'}]

Request Table by leagueId

| parameter | sample | description | optional | |----------|---------|---------|---------| | leagueId | 394 | footballdata-org id of the league | no | | matchday | 3 | The current/last matchday is taken per default | yes | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'leagueId':'394', 'matchday':4}]
  • [{'leagueId':'398'}, {'leagueId':'400'}]

Request Fixture by fixtureId

| parameter | sample | description | optional | |----------|---------|---------|---------| | fixtureId | 131257 | footballdata-org id of the fixture | no | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'fixtureId':'131257'}]
  • [{'fixtureId':'131096'}, {'fixtureId':'131089'}]

Request Fixtures by leagueId

| parameter | sample | description | optional | |----------|---------|---------|---------| | leagueId | 394 | footballdata-org id of the league | no | | matchday | 3 | The current/last matchday is taken per default | yes | | timeFrame | p7 | The value of the timeFrame argument must start with either 'p' for past or 'n' for next. It is followed by a number in the range 1-99. | yes |

Samples:

  • [{'leagueId':'394', 'matchday':4}]
  • [{'leagueId':'398'}, {'leagueId':'400'}]

Request Fixtures by timeFrame

| parameter | sample | description | optional | |----------|---------|---------|---------| | timeFrame | p7 | The value of the timeFrame argument must start with either 'p' for past or 'n' for next. It is followed by a number in the range 1-99. | no | | protocol | https | used protocol (http, https, auto) | yes |

Sample:

  • [{'timeFrame':'p7'}]

Request Fixtures by teamId

| parameter | sample | description | optional | |----------|---------|---------|---------| | teamId | 394 | footballdata-org id of the team | no | | timeFrame | p7 | The value of the timeFrame argument must start with either 'p' for past or 'n' for next. It is followed by a number in the range 1-99. | yes | | venue | home | Valid values: home and away. Default is unset. | yes | | protocol | https | used protocol (http, https, auto) | yes |

Samples:

  • [{'teamId':'5', 'timeFrame':'p8', 'venue':'home'}]
  • [{'teamId':'18'}, {'teamId':'7'}]

Licence

MIT