API Documentation


Competitions

Description

Returns supported competitions for your current subscription plan or the details of a particular competition.

Sample Request

https://football-api.com/api/?Action=competitions&APIKey=[YOUR_API_KEY]

Required Parameters

  • APIKey string, find your personal key in your account area.

Optional Parameters

  • comp_id integer, is the id of a particular competition.
  • OutputType string, output type, default value: JSON. Options include: XML, JSON, PHP, LINE, CONSOLE, VAR.

Sample Return

{
		"id":"1064",
		"name":"Superliga",
		"region":"Albania"
}

Standings

Description

Returns the league standing table for a given competition.

Sample Request

https://football-api.com/api/?Action=standings&APIKey=[YOUR_API_KEY]&comp_id=[COMPETITION]

Required Parameters

  • APIKey string, find your personal key in your account area.
  • comp_id integer, is the id of the competition

Optional Parameters

  • OutputType string, output type, default value: JSON. Options include: XML, JSON, PHP, LINE, CONSOLE, VAR.

Sample Return

[
		{
		"stand_id":"12049092",
		"stand_competition_id":"1204",
		"stand_season":"2013\/2014",
		"stand_round":"27",
		"stand_stage_id":"12041081",
		"stand_group":"",
		"stand_country":"England",
		"stand_team_id":"9092",
		"stand_team_name":"Chelsea",
		"stand_status":"same",
		"stand_recent_form":"DWWDW",
		"stand_position":"1",
		"stand_overall_gp":"27",
		"stand_overall_w":"18",
		"stand_overall_d":"6",
		"stand_overall_l":"3",
		"stand_overall_gs":"49",
		"stand_overall_ga":"21",
		"stand_home_gp":"14",
		"stand_home_w":"12",
		"stand_home_d":"2",
		"stand_home_l":"0",
		"stand_home_gs":"29",
		"stand_home_ga":"9",
		"stand_away_gp":"13",
		"stand_away_w":"12",
		"stand_away_d":"2",
		"stand_away_l":"0",
		"stand_away_gs":"29",
		"stand_away_ga":"9",
		"stand_gd":"28",
		"stand_points":"60",
		"stand_desc":"UEFA Champions Leagu"
		}
]

Today’s Matches (Includes Live Score)

Description

Returns the matches scheduled today. This includes live matches and their updated events.

Sample Request

https://football-api.com/api/?Action=today&APIKey=[YOUR_API_KEY]&comp_id=[COMPETITION]

Required Parameters

  • APIKey string, find your personal key in your account area.

Optional Parameters

  • comp_id integer, is the id of the competition
  • OutputType string, output type, default value: JSON. Options include: XML, JSON, PHP, LINE, CONSOLE, VAR.

Sample Return

[
		{
		"match_id":"1752427",
		"match_comp_id":"1040",
		"match_date":"Mar 20",
		"match_formatted_date":"20.03.2014",
		"match_status":"FT",
		"match_time":"01:00",
		"match_commentary_available":"libertadores",
		"match_localteam_id":"6983",
		"match_localteam_name":"Bolivar",
		"match_localteam_score":"1",
		"match_visitorteam_id":"7299",
		"match_visitorteam_name":"Flamengo RJ",
		"match_visitorteam_score":"0",
		"match_ht_score":"[1-0]"
		}
]

Returned Values of match_status

  • During the match, the minute of the game e.g. “48”
  • “HT”: in the half time (between the two halves)
  • “FT”: After the end of the match (full time)
  • “AET”: After Extra Time
  • “Pen.”: Penalties.
  • “Post.” : Postponed
  • “Awarded”: Awarded
  • “Cancl.” Cancelled.

Fixtures

Sample Request

https://football-api.com/api/?Action=fixtures&APIKey=[YOUR_API_KEY]&comp_id=[COMPETITION]&&match_date=[DATE_IN_d.m.Y_FORMAT]

Required Parameters

  • APIKey string, find your personal key in your account area.
  • match_date date string. e.g. 20.03.2014
  • from_date to be used with “to_date” to specify a date range. Input date should be formatted as a string e.g. 20.08.2014
  • to_date to be used with “from_date” to specify a date range. Input date should be formatted as a string e.g. 27.08.2014

Optional Parameters

  • comp_id integer, is the id of the competition
  • OutputType string, output type, default value: JSON. Options include: XML, JSON, PHP, LINE, CONSOLE, VAR.

Sample Return

[
		{
		match_id: "1753012",
		match_comp_id: "1232",
		match_date: "Mar 27",
		match_formatted_date: "27.03.2014",
		match_status: "15:15",
		match_time: "15:15",
		match_commentary_available: "",
		match_localteam_id: "10854",
		match_localteam_name: "Giannina",
		match_localteam_score: "?",
		match_visitorteam_id: "10849",
		match_visitorteam_name: "Panthrakikos",
		match_visitorteam_score: "?",
		match_ht_score: ""
		}
] 

Commentary

Sample Request

https://football-api.com/api/?Action=commentaries&APIKey=[YOUR_API_KEY]&match_id=[MATCH_ID]

Required Parameters

  • APIKey string, find your personal key in your account area.
  • match_id integer, is the id of the match requested.

Optional Parameters

  • OutputType string, output type, default value: JSON. Options include: XML, JSON, PHP, LINE, CONSOLE, VAR.

Sample Return