API Documentation
134 open REST endpoints covering scores, odds, lineups, player and team statistics, transfers and schedules. Every endpoint returns standard JSON and authenticates with the X-API-Key header.
Contract 2cb261fd829404b2 · docs generated 09/11/2026, 14:29 UTC
General: auth, response format, paging, rate limits, errors →Realtime: WebSocket / SSE / MQTT with live test →SDKs: JS / Python / Dart / Swift / Kotlin →Animation widget: embedding 2.5D / 3D →
World Cup package
47GET
/api/v1/categories
GETList categories
/api/v1/coach/honors/detail
GETGet a coach's honours
/api/v1/coaches/careers/detail
GETGet a coach's career
/api/v1/coaches/detail
GETGet coach details
/api/v1/competitions/records/detail
GETList competition records
/api/v1/countries
GETList countries / regions
/api/v1/data/delete/records
GETGet deleted records
/api/v1/honors/detail
GETGet honour details
/api/v1/intelligences/detail
GETGet a match's intelligence
/api/v1/leagues/detail
GETGet competition details
/api/v1/matches/compensation/detail
GETGet a match's historical same-odds data
/api/v1/matches/detail/live
GETGet live match data
/api/v1/matches/half/statistics
GETList team statistics by half (half-time / full-time)
/api/v1/matches/half/statistics/detail
GETGet team statistics by half for a finished match
/api/v1/matches/lineup/players
GETGet a match's lineups
/api/v1/matches/lineups
GETGet a match's lineups
/api/v1/matches/lineups/detail
GETGet a team's squad
/api/v1/matches/live/history
GETGet match data for a finished match
/api/v1/matches/schedule/detail
GETGet fixtures and results
/api/v1/matches/season/best/lineups/detail
GETGet a season's teams of the round
/api/v1/matches/stat/live
GETGet team and player statistics of matches
/api/v1/matches/trend/detail
GETGet a match's momentum
/api/v1/player/honors/detail
GETGet a player's honours
/api/v1/player/market/detail
GETGet a player's market value
/api/v1/players/abilities/detail
GETGet a player's ability ratings
/api/v1/players/detail
GETGet player details
/api/v1/players/match/statistics/detail
GETGet player statistics for a finished match
/api/v1/players/missing/detail
GETGet a team's injuries and suspensions
/api/v1/players/salaries/detail
GETGet a player's salaries
/api/v1/players/season/statistics
GETGet season statistics
/api/v1/players/season/statistics/old
GETGet season statistics
/api/v1/players/transfers/detail
GETGet a player's transfers
/api/v1/rank/fifa/live
GETGet live FIFA rankings
/api/v1/rank/fifa/men
GETGet FIFA men's national team rankings
/api/v1/rank/fifa/women
GETGet FIFA women's national team rankings
/api/v1/referees/detail
GETGet referee details
/api/v1/season/brackets
GETGet the knockout bracket
/api/v1/seasons/table
GETGet a season's standings
/api/v1/team/honors/detail
GETGet a team's honours
/api/v1/team/persons/detail
GETGet a team's coaching staff
/api/v1/teams/abilities/detail
GETGet a team's ability ratings
/api/v1/teams/detail
GETGet team details
/api/v1/teams/match/statistics/detail
GETGet team statistics for a finished match
/api/v1/teams/records/detail
GETList team records
/api/v1/teams/squads/history
GETGet a team's past squads
/api/v1/teams/transfers/detail
GETGet a team's transfers
/api/v1/venues/detail
Get venue details
Advanced data package
24GET
/api/v1/coach/honors
GETList coach honours
/api/v1/coaches/careers
GETList coaching careers
/api/v1/competitions/records
GETList competition records
/api/v1/intelligences
GETList intelligence
/api/v1/matches/injuries/by-match
GETInjuries and suspensions for a match
/api/v1/matches/intelligences
GETList match intelligence (new)
/api/v1/matches/season/best/lineups
GETList teams of the round
/api/v1/player/honors
GETList player honours
/api/v1/player/market
GETList player market values
/api/v1/players/abilities
GETList player ability ratings
/api/v1/players/attributes
GETList player ability ratings
/api/v1/players/missing
GETList team injuries and suspensions
/api/v1/players/salaries
GETList player salaries
/api/v1/players/transfers
GETList player transfers
/api/v1/rank/club
GETGet club rankings
/api/v1/rank/fifa/live
GETGet live FIFA rankings
/api/v1/rank/fifa/men
GETGet FIFA men's national team rankings
/api/v1/rank/fifa/women
GETGet FIFA women's national team rankings
/api/v1/team/honors
GETList team honours
/api/v1/team/persons
GETList team coaching staff
/api/v1/teams/abilities
GETList team ability ratings
/api/v1/teams/players
GETList team squads
/api/v1/teams/records
GETList team records
/api/v1/teams/squads/history
Get a team's past squads
Realtime data package
17GET
/api/v1/data/delete/records
GETGet deleted records
/api/v1/live
GETLive scoreboard
/api/v1/matches/basic/statistics
GETGet live match data
/api/v1/matches/half/statistics
GETList team statistics by half (half-time / full-time)
/api/v1/matches/lineup/players
GETGet a match's lineups
/api/v1/matches/lineups
GETGet a match's lineups
/api/v1/matches/realtime/events
GETGet live match data
/api/v1/matches/realtime/live
GETGet live match data
/api/v1/matches/realtime/trends
GETGet live match momentum
/api/v1/matches/recent
GETList changed matches
/api/v1/matches/schedule/diary
GETList fixtures and results by date
/api/v1/matches/schedule/param
GETList fixtures and results by dimension
/api/v1/matches/standing
GETGet live standings
/api/v1/matches/trend/detail
GETGet a match's momentum
/api/v1/matches/trends/by-match
GETAttacking momentum of a match (one row per minute)
/api/v1/players/match/statistics
GETList player statistics of matches
/api/v1/teams/match/statistics
List team statistics of matches
Statistics package
15GET
/api/v1/brackets
GETKnockout bracket of the current season
/api/v1/competitions/table
GETGet a competition's standings
/api/v1/matches/analysis
GETGet match analysis
/api/v1/matches/analysis/by-match
GETPre-match analysis for a match
/api/v1/matches/compensation/list
GETList historical same-odds statistics
/api/v1/matches/half/statistics/detail
GETGet team statistics by half for a finished match
/api/v1/matches/live/history
GETGet match data for a finished match
/api/v1/players/match/statistics/detail
GETGet player statistics for a finished match
/api/v1/scorers
GETTop scorers of a competition
/api/v1/scorers/leagues
GETCompetitions that have a top scorers list
/api/v1/season/brackets
GETGet the knockout bracket
/api/v1/standing
GETStandings (with platform team ids)
/api/v1/teams/match/statistics/detail
GETGet team statistics for a finished match
/api/v1/teams/season/statistics
GETGet competition statistics
/api/v1/teams/season/statistics/old
Get competition statistics
Basic data package
13GET
/api/v1/categories
GETList categories
/api/v1/coaches
GETList coaches
/api/v1/competition/rules
GETList competition formats
/api/v1/continents
GETList continents / regions
/api/v1/countries
GETList countries / regions
/api/v1/honors
GETList honours
/api/v1/leagues
GETList competitions
/api/v1/players
GETList players
/api/v1/referees
GETList referees
/api/v1/seasons
GETList seasons
/api/v1/stages
GETList stages
/api/v1/teams
GETList teams
/api/v1/venues
List venues
Platform extensions
5GET
/api/v1/logos
GETList logo assets (team / competition / player / category logos)
/api/v1/player/appearances
GETA player's recent appearances
/api/v1/player/summary
GETPlayer career summary (appearances, goals, ability ratings, honours)
/api/v1/search
GETGlobal search (teams / players / competitions)
/api/v1/team/summary
Team profile (honours, past squads, ability ratings)
Database package
5Odds package
5Live animation widget
5GET
/api/v1/widget/app-keys
GETLive animation widget: App Keys with today's views and refusals
/api/v1/widget/configs
GETLive animation widget: configurations saved by this account
/api/v1/widget/options
GETLive animation widget: views, templates, layouts and modules available to this account
/api/v1/widget/stats
POSTLive animation widget: viewers online now and views today
/api/v1/widget/token
Live animation widget: exchange an embed token (server side only)
Entities
3Global
3By match
3Account
2Mechanism
2Enumerations
1Lineup intelligence
1News package
1Compatibility endpoints not provided
15If you are migrating from another data service: these compatibility API paths are not provided, with the reason.
GET
/api/v5/football/match/stream/urls_free
Get licensed live stream URLs · Not provided: no live streaming rights
GET
/api/v5/football/match/stream/video_collection
Get licensed highlight video URLs · Not provided: highlights are internal only (/api/v1/matches/video)
GET
/api/v5/football/match/highlight/detail
Get animated clips of match events · Not provided: no source for event clips
GET
/api/v5/football/odds/bf/live
Get live Betfair data · Not provided: Betfair data is internal only
GET
/api/v5/football/odds/bf/history
Get a match's Betfair data · Not provided: Betfair data is internal only
GET
/api/v5/sports/lottery/revise
Get sports lottery corrections · Not provided: sports lottery data is internal only
GET
/api/v2/sports/lottery/match/list
List sports lottery match links · Not provided: sports lottery data is internal only
GET
/api/v2/sports/jc/odds
Get Jingcai match odds · Not provided: sports lottery data is internal only
GET
/api/v2/sports/jc/result
Get Jingcai match results · Not provided: sports lottery data is internal only
GET
/api/v2/sports/bd/odds
Get Beidan odds · Not provided: sports lottery data is internal only
GET
/api/v2/sports/bd/result
Get Beidan results · Not provided: sports lottery data is internal only
GET
/api/v2/sports/bd/sf_odds
Get Beidan win/lose parlay odds · Not provided: sports lottery data is internal only
GET
/api/v2/sports/bd/sf_result
Get Beidan win/lose parlay results · Not provided: sports lottery data is internal only
GET
/api/v2/sports/zc/matches
Get traditional football lottery fixtures · Not provided: sports lottery data is internal only
GET
/api/v2/sports/zc/result
Get traditional football lottery results · Not provided: sports lottery data is internal only
Planned endpoints
12These endpoints are still being built and cannot be called yet; they will appear in the catalog above once live.
GET
/api/v1/betfair/markets
GET
/api/v1/betfair/volumes
GET
/api/v1/competitions
GET
/api/v1/ctzc/issues
GET
/api/v1/jczq/odds
GET
/api/v1/matches/detail
GET
/api/v1/matches/incidents
GET
/api/v1/matches/stats
GET
/api/v1/matches/tlive
GET
/api/v1/players/honors
GET
/api/v1/teams/honors
GET
/api/v1/teams/squad