Skip to content

Latest commit

 

History

History
196 lines (165 loc) · 7.07 KB

README.md

File metadata and controls

196 lines (165 loc) · 7.07 KB
Raw

angular-footballdata-api-factory is an angularjs module with a football-data.org api factory.

npm version Bower version

Author: Jonathan Hornung (JohnnyTheTank)

Usage

  1. Install via either bower, npm or downloaded files:

    1. bower install --save angular-footballdata-api-factory
    2. npm install --save angular-footballdata-api-factory
    3. download angular-footballdata-api-factory.zip

  2. Include dependencies in your HTML.

    1. When using bower:
    <script src="bower_components/angular-footballdata-api-factory/dist/angular-footballdata-api-factory.min.js"></script>
    1. When using npm:
    <script src="node_modules/angular-footballdata-api-factory/dist/angular-footballdata-api-factory.min.js"></script>
    1. when using downloaded files
    <script src="angular-footballdata-api-factory.min.js"></script>

  3. Add jtt_footballdata to your application's module dependencies.

  4. Use the factory footballdataFactory

factory methods

getSeason

//Show one Season
footballdataFactory.getSeason({
    id: '<SEASON_ID>',
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getSeasons

//List all available soccer seasons
footballdataFactory.getSeasons({
    season: '<SEASON>',       // (optional) Default is the current year (4 digit), e.g: '2015'
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getTeam

//Show one team.
footballdataFactory.getTeam({
    id: '<TEAM_ID>',
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getTeams

//List all teams for a certain soccerseason
footballdataFactory.getTeamsBySeason({
    id: '<SEASON_ID>',
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getPlayers

//Show all players for a certain team.
footballdataFactory.getPlayersByTeam({
    id: '<TEAM_ID>',
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getLeagueTable

//Show League Table / current standing.
footballdataFactory.getLeagueTableBySeason({
    id: '<SEASON_ID>',
    matchday: '<MATCHDAY>',   // (optional) The current/last matchday is taken per default
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getFixture

//Show one fixture.
footballdataFactory.getFixture({
    id: '<FIXTURE_ID>',
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getFixtures

//List fixtures across a set of soccerseasons.
footballdataFactory.getFixtures({
    timeFrame: '<TIMEFRAME>', // (optional) 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.
    league: '<LEAGUE_CODE>',  // (optional) A (list of, comma separated) league-code(s). Default is unset. Get all league codes at http://api.football-data.org/docs/latest/index.html
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});
//List all fixtures for a certain soccerseason.
footballdataFactory.getFixturesBySeason({
    id: '<SEASON_ID>',
    timeFrame: '<TIMEFRAME>', // (optional) 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.
    matchday: '<MATCHDAY>',   // (optional) The current/last matchday is taken per default
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});
//Show all fixtures for a certain team.
footballdataFactory.getFixturesByTeam({
    id: '<TEAM_ID>',
    season: '<SEASON>',       // (optional) Defaults to the current year, given as 4 digit like '2015'
    timeFrame: '<TIMEFRAME>', // (optional) 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.
    venue: '<VENUE>',         // (optional) Valid values: `home` and `away`. Default is unset.
    protocol: '<PROTOCOL>', // (optional) 'http', 'https', 'auto'
    apiKey: '<YOUR_API_KEY>', // Register for a free api key: http://api.football-data.org/register
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

football-data.org JSON API

More angular-api-factories

bandsintown - dailymotion - facebook - footballdata - flickr - github - openweathermap - tumblr - vimeo - wikipedia - youtube

License

MIT