Skip to content

Bepro Data API (2.0.0)

Welcome to the Bepro Data API documentation. This API provides comprehensive access to Bepro's whole database based on your own service permission scope, including events, stats, positional data, or meta data etc.


Overview

This section covers the essential information you need to get started with the Bepro Data API.

Authentication

All API requests require authentication using a Bearer token.

Include the token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

To obtain an API token, please contact the Bepro team.


Rate Limits

  • Rate Limit: 1000 requests per minute per API token
  • Burst Limit: 100 requests per second

When you exceed the rate limit, you'll receive a 429 Too Many Requests response.


Event Definition

For detailed information about event types and their properties, please refer to our Event Definition Documentation:


Coordinates

All coordinate values in the API use a normalized coordinate system:

  • X-axis: 0.0 (left) to 1.0 (right)
  • Y-axis: 0.0 (bottom) to 1.0 (top)
  • Origin: Bottom-left corner (0, 0)

Version History

v2.0.0 (Current)

  • Initial release of the new Data API v2

Servers
https://ds.bepro.ai/data-api/

Meta

Operations

Get Clubs

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
club_idsClub Ids (string) or Club Ids (null)(Club Ids)
Any of:
string(Club Ids)
team_idsTeam Ids (string) or Team Ids (null)(Team Ids)
Any of:
string(Team Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​namestring(Name)required
data[].​name_enName En (string) or Name En (null)(Name En)
Any of:
string(Name En)
data[].​iso_country_codestring(Iso Country Code)required
data[].​team_countinteger(Team Count)required
data[].​team_idsArray of integers(Team Ids)required
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Leagues

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
league_idsLeague Ids (string) or League Ids (null)(League Ids)
Any of:
string(League Ids)
season_idsSeason Ids (string) or Season Ids (null)(Season Ids)
Any of:
string(Season Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​namestring(Name)required
data[].​name_enName En (string) or Name En (null)(Name En)
Any of:
string(Name En)
data[].​age_limitAge Limit (string) or Age Limit (null)(Age Limit)
Any of:
string(Age Limit)
data[].​divisionDivision (integer) or Division (null)(Division)
Any of:
integer(Division)
data[].​genderGender (string) or Gender (null)(Gender)
Any of:
string(Gender)
data[].​sport_nameSport Name (string) or Sport Name (null)(Sport Name)
Any of:
string(Sport Name)
data[].​iso_country_codeIso Country Code (string) or Iso Country Code (null)(Iso Country Code)
Any of:
string(Iso Country Code)
data[].​season_countinteger(Season Count)required
data[].​season_idsArray of integers(Season Ids)required
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Lineups

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
team_idsTeam Ids (string) or Team Ids (null)(Team Ids)
Any of:
string(Team Ids)
season_idsSeason Ids (string) or Season Ids (null)(Season Ids)
Any of:
string(Season Ids)
league_idsLeague Ids (string) or League Ids (null)(League Ids)
Any of:
string(League Ids)
club_idsClub Ids (string) or Club Ids (null)(Club Ids)
Any of:
string(Club Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​match_idinteger(Match Id)required
data[].​match_start_timestring(Match Start Time)required
data[].​home_team_idinteger(Home Team Id)required
data[].​home_team_full_namestring(Home Team Full Name)required
data[].​away_team_idinteger(Away Team Id)required
data[].​away_team_full_namestring(Away Team Full Name)required
data[].​lineupArray of objects(Lineup)required
data[].​lineup[].​player_idinteger(Player Id)required
data[].​lineup[].​player_full_namestring(Player Full Name)required
data[].​lineup[].​shirt_numberShirt Number (string) or Shirt Number (null)(Shirt Number)
Any of:
string(Shirt Number)
data[].​lineup[].​is_startingboolean(Is Starting)required
data[].​lineup[].​position_namePosition Name (string) or Position Name (null)(Position Name)
Any of:
string(Position Name)
data[].​lineup[].​team_idinteger(Team Id)required
data[].​lineup[].​team_full_namestring(Team Full Name)required
data[].​lineup[].​playing_timePlaying Time (integer) or Playing Time (null)(Playing Time)
Any of:
integer(Playing Time)
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Matches

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
only_analyzedOnly Analyzed (boolean) or Only Analyzed (null)(Only Analyzed)
Default true
Any of:
boolean(Only Analyzed)
Default true
team_idsTeam Ids (string) or Team Ids (null)(Team Ids)
Any of:
string(Team Ids)
season_idsSeason Ids (string) or Season Ids (null)(Season Ids)
Any of:
string(Season Ids)
league_idsLeague Ids (string) or League Ids (null)(League Ids)
Any of:
string(League Ids)
club_idsClub Ids (string) or Club Ids (null)(Club Ids)
Any of:
string(Club Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​match_start_timestring(Match Start Time)required
data[].​leagueobject(api__data_api__meta__match__LeagueInfo)required
data[].​league.​idinteger(Id)required
data[].​league.​namestring(Name)required
data[].​league.​name_enName En (string) or Name En (null)(Name En)
Any of:
string(Name En)
data[].​league.​age_limitAge Limit (string) or Age Limit (null)(Age Limit)
Any of:
string(Age Limit)
data[].​league.​divisionDivision (integer) or Division (null)(Division)
Any of:
integer(Division)
data[].​league.​genderGender (string) or Gender (null)(Gender)
Any of:
string(Gender)
data[].​league.​sport_nameSport Name (string) or Sport Name (null)(Sport Name)
Any of:
string(Sport Name)
data[].​league.​iso_country_codeIso Country Code (string) or Iso Country Code (null)(Iso Country Code)
Any of:
string(Iso Country Code)
data[].​seasonobject(SeasonInfo)required
data[].​season.​idinteger(Id)required
data[].​season.​namestring(Name)required
data[].​roundobject(RoundInfo)required
data[].​round.​idinteger(Id)required
data[].​round.​namestring(Name)required
data[].​home_teamobject(api__data_api__meta__match__TeamInfo)required
data[].​home_team.​idinteger(Id)required
data[].​home_team.​namestring(Name)required
data[].​home_team.​iso_country_codestring(Iso Country Code)required
data[].​away_teamobject(api__data_api__meta__match__TeamInfo)required
data[].​away_team.​idinteger(Id)required
data[].​away_team.​namestring(Name)required
data[].​away_team.​iso_country_codestring(Iso Country Code)required
data[].​scoreobject(MatchScore)required
data[].​score.​home_teaminteger(Home Team)required
data[].​score.​away_teaminteger(Away Team)required
data[].​periodsArray of objects(Periods)required
data[].​periods[].​period_orderinteger(Period Order)required
data[].​periods[].​period_typestring(Period Type)required
data[].​periods[].​period_durationinteger(Period Duration)required
data[].​periods[].​is_regularboolean(Is Regular)required
data[].​match_full_timeinteger(Match Full Time)required
data[].​match_extra_timeinteger(Match Extra Time)required
data[].​location_nameLocation Name (string) or Location Name (null)(Location Name)
Any of:
string(Location Name)
data[].​is_analysis_finishedboolean(Is Analysis Finished)required
data[].​analysis_completed_datetimeAnalysis Completed Datetime (string) or Analysis Completed Datetime (null)(Analysis Completed Datetime)
Any of:
string(Analysis Completed Datetime)
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Players

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
player_idsPlayer Ids (string) or Player Ids (null)(Player Ids)
Any of:
string(Player Ids)
team_idsTeam Ids (string) or Team Ids (null)(Team Ids)
Any of:
string(Team Ids)
club_idsClub Ids (string) or Club Ids (null)(Club Ids)
Any of:
string(Club Ids)
season_idsSeason Ids (string) or Season Ids (null)(Season Ids)
Any of:
string(Season Ids)
league_idsLeague Ids (string) or League Ids (null)(League Ids)
Any of:
string(League Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​player_full_namestring(Player Full Name)required
data[].​player_main_positionPlayer Main Position (string) or Player Main Position (null)(Player Main Position)
Any of:
string(Player Main Position)
data[].​birth_dateBirth Date (string) or Birth Date (null)(Birth Date)
Any of:
string(Birth Date)
data[].​teamsArray of objects(Teams)required
data[].​teams[].​team_idinteger(Team Id)required
data[].​teams[].​team_namestring(Team Name)required
data[].​profile_image_urlstring(Profile Image Url)required
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Seasons

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
league_idsLeague Ids (string) or League Ids (null)(League Ids)
Any of:
string(League Ids)
season_idsSeason Ids (string) or Season Ids (null)(Season Ids)
Any of:
string(Season Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​namestring(Name)required
data[].​leagueobject(api__data_api__meta__season__LeagueInfo)required
data[].​league.​idinteger(Id)required
data[].​league.​namestring(Name)required
data[].​league.​name_enName En (string) or Name En (null)(Name En)
Any of:
string(Name En)
data[].​team_countinteger(Team Count)required
data[].​team_idsArray of integers(Team Ids)required
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Get Teams

Request

Query
match_idsMatch Ids (string) or Match Ids (null)(Match Ids)
Any of:
string(Match Ids)
sort_directionstring(Sort Direction)
Default "desc"
offsetinteger(Offset)
Default 0
limitinteger(Limit)
Default 50
langstring(Lang)
Default "en"
team_idsTeam Ids (string) or Team Ids (null)(Team Ids)
Any of:
string(Team Ids)
club_idsClub Ids (string) or Club Ids (null)(Club Ids)
Any of:
string(Club Ids)

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
nextNext (string) or Next (null)(Next)
Any of:
string(Next)
prevPrev (string) or Prev (null)(Prev)
Any of:
string(Prev)
dataArray of objects(Data)required
data[].​idinteger(Id)required
data[].​namestring(Name)required
data[].​iso_country_codestring(Iso Country Code)required
data[].​sport_nameSport Name (string) or Sport Name (null)(Sport Name)
Any of:
string(Sport Name)
data[].​genderGender (string) or Gender (null)(Gender)
Any of:
string(Gender)
data[].​club_idClub Id (integer) or Club Id (null)(Club Id)
Any of:
integer(Club Id)
data[].​club_nameClub Name (string) or Club Name (null)(Club Name)
Any of:
string(Club Name)
data[].​player_countinteger(Player Count)required
data[].​player_idsArray of integers(Player Ids)required
data[].​profile_image_urlstring(Profile Image Url)required
Response
application/json
{ "count": 0, "next": "string", "prev": "string", "data": [ {} ] }

Data

Operations

Video

Operations

External

Operations