Overview
The American Football Live Win Probability feed provides pre-game and live-game win probability predictions during the course of an American Football match.
The feed includes traditional match data such as match information, competition information, team details, and venue information, together with predictive information such as win probability, score prediction, expected points added, and expected spread adjustment.
Problem Statement & Use Cases
This API solves the business problem of quantifying how likely each team is to win during an American Football fixture, both before the game and as the game state changes live. It combines fixture metadata, game clock context, period context, play identifiers, and predictive outputs so applications can present probability-driven game state analysis in real time.
| Use Case |
Description |
| Live win probability dashboards |
Display current win probability for each team during an in-progress American Football game. |
| Broadcast and editorial graphics |
Power in-game visualizations showing how win probability changes by play, period, or clock state. |
| Fan engagement widgets |
Add predictive context to game centers, mobile apps, and second-screen experiences. |
| Predictive model enrichment |
Use win probability, score prediction, expected points added, and expected spread adjustment as downstream modeling features. |
Compliance & Guidelines
Authentication and API Security
To comply with Stats Perform API security and best-practice requirements, refer to the Stats Perform FAQs, API Overview, and Authentication Guide.
Authentication uses the OAuth method to fetch data.
Polling Frequency
Do not exceed the rate confirmed by Stats Perform. Contact a Stats Perform representative for higher rate limits or clarification.
| Feed |
Polling Frequency |
| Live Win Probability (MA21) |
Once every 30 seconds |
Request Formatting Rules
All URLs are case-sensitive. URL strings must contain the correct case, operators, and required parameters, or the API returns an error.
| Rule |
Requirement |
| Query string start |
Begin the query parameter string with ? immediately after the feed name. |
| Parameter separator |
Separate query parameters with &. |
| Multiple values: AND |
Use & for multiple values where the API treats them as AND. |
| Multiple values: OR |
Use , only if the parameter supports OR-style multiple values. |
| NOT operator |
Use ! only if the parameter supports negation. |
| Underscore-prefixed parameters |
Include the required _ prefix for parameters such as _fmt and _clbk. |
| Placeholder braces |
Remove placeholder curly braces {} from production API calls. They are documentation examples only. |
| Case sensitivity |
Preserve exact URL, parameter, and operator case. |
| Base URL reference |
The base URL format is {protocol}://{requestDomain}/{feedResource}. |
JSONP Requirements
If _fmt=jsonp is used, it must be combined with the callback parameter _clbk.
| Constraint |
Requirement |
Reason |
| JSONP callback |
Use _fmt=jsonp together with _clbk. |
JSONP requires a callback wrapper function. |
| Fixed callback value |
Use a fixed _clbk value whenever possible. |
Random callback names can reduce cacheability and violate API best-practice logic. |
| JavaScript frameworks |
Override framework-generated random callback names, including defaults from common frameworks such as jQuery. |
Some frameworks generate random JSONP function names unless explicitly configured. |
Endpoints
Base URL
https://api.statsperform.com
Feed Resource
/sdapi/v1/footballdata/matchlivewinprobability
Get Live Win Probability by Fixture Path Parameter
GET /sdapi/v1/footballdata/matchlivewinprobability/{fixtureUUID}?_fmt={format}
Get Live Win Probability by fx Query Parameter
GET /sdapi/v1/footballdata/matchlivewinprobability?fx={fixtureUUID}&_fmt={format}
Endpoint Usage
| Usage |
Feed |
| Get Live Win Probability information by fixture inline path URL. |
/sdapi/v1/footballdata/matchlivewinprobability/{fixtureUUID}?_fmt={format} |
| Get Live Win Probability information by fixture UUID query parameter. |
/sdapi/v1/footballdata/matchlivewinprobability?fx={fixtureUUID}&_fmt={format} |
Query Parameters
This feed uses Global query parameters and the feed-specific query parameters listed below.
The /matchlivewinprobability feed must be queried by a specific fixture or match UUID.
Feed-Specific Query Parameters
| Query Parameter |
Description |
Example Request |
fixtureUUID |
Get Live Win Probability information by fixture inline path URL. |
GET https://api.statsperform.com/sdapi/v1/footballdata/matchlivewinprobability/{fixtureUUID}?_fmt=xml |
fx |
Get Live Win Probability information by fixture UUID query parameter. |
GET https://api.statsperform.com/sdapi/v1/footballdata/matchlivewinprobability?fx={fixtureUUID}&_fmt=xml |
Parameter Definitions
| Parameter |
Location |
Description |
Accepted Values / Format |
Required |
fixtureUUID |
Path |
Fixture or match UUID passed directly in the URL path. |
String; alphanumeric UUID |
Conditional |
fx |
Query |
Fixture or match UUID passed as a query parameter. |
String; alphanumeric UUID |
Conditional |
_fmt |
Query |
Response data format. |
Example: xml; other global formats may be supported by the API. |
No |
_clbk |
Query |
JSONP callback function name. |
Fixed callback function name. |
Required when _fmt=jsonp |
Fixture Identifier Requirements
| Requirement |
Description |
| Specific fixture required |
Every request must identify a specific fixture or match. |
| Path parameter method |
Use /matchlivewinprobability/{fixtureUUID} when passing the fixture identifier in the URL path. |
| Query parameter method |
Use /matchlivewinprobability?fx={fixtureUUID} when passing the fixture identifier as a query parameter. |
| Placeholder removal |
Remove {} braces from actual production requests. |
Output Schema
The feed response fields are documented using XML element names. JSON responses contain similar fields, but some XML-only nodes are omitted or represented differently.
`<match
LiveWinProbability>`
| Property |
Value |
| Format |
XML only |
| Nesting |
matchLiveWinProbability |
| Description |
Required or optional root element of the fields related to live win probability. |
| JSON behavior |
Not present in JSON feed response. In JSON, the root element is matchInfo. |
| XML behavior |
Only present in XML. |
| Attributes |
None documented. |
`<match
Info>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo |
| Description |
Required root element of the fields related to match information. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the fixture or match. |
String; alphanumeric UUID |
date |
Yes |
Date of the fixture or match in UTC. |
Date in format YYYY-MM-DDZ |
time |
No |
Start time of the fixture or match in UTC. This value may be missing or empty until confirmed; the feed is updated once the time is received. |
String |
localDate |
Yes |
Start date of the fixture according to the local time zone. |
Date in format YYYY-MM-DDZ |
localTime |
Yes |
Start time of the fixture according to the local time zone. |
Time in format hh:mm:ssZ |
week |
Yes |
Week in which the game takes place. |
Integer |
coverageLevelId |
No |
Level at which Stats Perform is covering the fixture. |
Integer |
lastUpdated |
Yes |
UTC date and time when the fixture information or record was last updated. |
Date/Time in format YYYY-MM-DDThh:mm:ssZ |
<description>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/description |
| Description |
Optional description of the match or fixture, such as the contestant names. |
| Value |
String |
| Attributes |
None |
<sport>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/sport |
| Description |
Required root element of the related fields for the sport. |
| XML value |
String giving the sport name, for example American Football. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the sport. |
String; alphanumeric UUID |
name |
Yes |
Name of the sport. JSON only. |
String |
<ruleset>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/ruleset |
| Description |
Required root element of the fields related to the ruleset. |
| XML value |
String giving the ruleset name. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the ruleset. |
String; alphanumeric UUID |
name |
Yes |
Name of the ruleset. JSON only. |
String |
<competition>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/competition |
| Description |
Required root element of the fields related to the competition. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the competition. |
String; alphanumeric UUID |
name |
Yes |
Name of the competition. |
String |
abbreviation |
Yes |
Abbreviated name of the competition. |
String |
<country> under <competition>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/competition/country |
| Description |
Required root element of the fields related to the country where the competition is based. |
| XML value |
String giving the country name. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the country where the competition is based. |
String; alphanumeric UUID |
name |
Yes |
Name of the country. JSON only. |
String |
`<tournament
Calendar>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/tournamentCalendar |
| Description |
Required root element of the fields related to a tournament calendar. |
| XML value |
String giving the tournament calendar name. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the tournament calendar. |
String; alphanumeric UUID |
startDate |
Yes |
Start date of the tournament calendar in UTC. |
Date in format YYYY-MM-DDZ |
endDate |
Yes |
End date of the tournament calendar in UTC. |
Date in format YYYY-MM-DDZ |
name |
Yes |
Name of the tournament calendar. JSON only. |
String |
<stage>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/stage |
| Description |
Required root element of the fields related to the stage. |
| XML value |
String giving the stage name. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the stage. |
String; alphanumeric UUID |
startDate |
Yes |
Start date of the stage in UTC. |
Date in format YYYY-MM-DDZ |
endDate |
Yes |
End date of the stage in UTC. |
Date in format YYYY-MM-DDZ |
name |
Yes |
Name of the stage. JSON only. |
String |
<contestants>
| Property |
Value |
| Format |
XML only |
| Nesting |
matchLiveWinProbability/matchInfo/contestants |
| Description |
Optional root element of the fields related to contestants. This element may not always be returned. |
| JSON behavior |
Not present in JSON/JSONP feed response; individual contestant elements are returned instead. |
| Attributes |
None |
<contestant>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/contestants/contestant |
| Description |
Optional root element of the fields related to a contestant. It may be absent when a match is scheduled but contestants are not yet known; the record is updated once contestants are known. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the contestant. |
String; alphanumeric UUID |
name |
Yes |
Name of the contestant. |
String |
position |
Yes |
Indicates whether the contestant is the home or away side. |
String; one of home, away |
nickname |
No |
Nickname of the team. |
String |
location |
Yes |
Location to which the team belongs. |
String |
abbreviation |
Yes |
Abbreviation of the team name. |
String |
playoffSeed |
No |
Position at which a team is seeded in playoffs. |
Integer |
<country> under <contestant>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/contestants/contestant/country |
| Description |
Optional root element of the fields related to the contestant country. This element may not always be returned. |
| XML value |
String giving the country name. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the country the contestant is from. |
String; alphanumeric UUID |
name |
Yes |
Name of the country. JSON only. |
String |
<venue>
| Property |
Value |
| Nesting |
matchLiveWinProbability/matchInfo/venue |
| Description |
Optional root element of the fields related to a venue. |
| Attribute |
Required |
Description |
Values |
id |
Yes |
Unique ID of the venue. |
String; alphanumeric UUID |
name |
Yes |
Name of the venue where the fixture is scheduled to be played. |
String |
city |
Yes |
City in which the venue is located. |
String |
stateId |
Yes |
UUID of the state in which the venue is located. |
String; alphanumeric UUID |
state |
Yes |
Name of the state in which the venue is located. |
String |
countryId |
Yes |
UUID of the country in which the venue is located. |
String; alphanumeric UUID |
country |
Yes |
Name of the country in which the venue is located. |
String |
latitude |
Yes |
Latitude of the venue. |
String |
longitude |
Yes |
Longitude of the venue. |
String |
zipcode |
Yes |
Zip code of the venue. |
String |
neutral |
Yes |
Indicates neutral-venue status. |
String |
<predictions>
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions |
| Description |
Required root element of the fields related to predictions. |
| Attributes |
None |
`<live
Predictions>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions |
| Description |
Required root element of the fields related to live predictions. |
| Attribute |
Required |
Description |
Values |
timeMin |
Yes |
Game time in minutes. |
Integer |
timeSec |
Yes |
Game time in seconds. |
Integer |
periodId |
Yes |
Unique ID of the period in the game. |
String |
playId |
Yes |
Unique ID of the play. |
String |
lastUpdated |
Yes |
UTC date and time when the prediction information was last updated. |
Date/Time in format YYYY-MM-DDThh:mm:ssZ |
`<win
Prediction>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/winPrediction |
| Description |
Optional root element of the fields related to win predictions. |
| Attributes |
None |
<prediction> under `<win
Prediction>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/winPrediction/prediction |
| Description |
Required root element of the fields related to prediction types. |
| Attribute |
Required |
Description |
Values |
type |
Yes |
Type of prediction being made. |
String; one of Home, Away, OT Draw |
value |
Yes |
Predicted final value for type. |
Decimal |
`<score
Prediction>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/scorePrediction |
| Description |
Optional root element of the fields related to score predictions. |
| Attribute |
Required |
Description |
Values |
type |
Yes |
Type of prediction being made. |
String; one of Home, Away, OT Draw |
<prediction> under `<score
Prediction>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/scorePrediction/prediction |
| Description |
Required root element of the fields related to prediction types. |
| Attribute |
Required |
Description |
Values |
type |
Yes |
Type of prediction being made. |
String; one of Home, Away, Home and Away |
value |
Yes |
Predicted final value for type. |
Decimal |
`<expected
PointsAdded>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/expectedPointsAdded |
| Description |
Optional root element of the fields related to expected points added predictions. |
| Attributes |
None |
<prediction> under `<expected
PointsAdded>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/expectedPointsAdded/prediction |
| Description |
Required root element of the fields related to prediction types. |
| Attribute |
Required |
Description |
Values |
type |
Yes |
Type of prediction being made. |
String; one of Home, Away |
value |
Yes |
Predicted final value for type. |
Decimal |
`<expected
SpreadAdjustment>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/expectedSpreadAdjustment |
| Description |
Optional root element of the fields related to expected spread adjustment predictions. |
| Attributes |
None |
<prediction> under `<expected
SpreadAdjustment>`
| Property |
Value |
| Nesting |
matchLiveWinProbability/predictions/livePredictions/expectedSpreadAdjustment/prediction |
| Description |
Required root element of the fields related to prediction types. |
| Attribute |
Required |
Description |
Values |
type |
Yes |
Type of prediction being made. |
String; one of Home, Away |
value |
Yes |
Predicted final value for type. |
Decimal |
