X-RapidAPI-Key
X-Auth-Token
		Apply token

Categorizes teams.

Identifier	Name	Description
C	Club team	Represents a city. Competes in domestic competitions. In addition the best teams compete in international competitions.
N	National team	Represents a whole country. Exclusively competes in international competitions.

Categorizes competitions by the way teams compete against each other and how results are valued.

Identifier	Name	Description
L	League	Teams compete in a league or group against (all) other participants. They earn points for wins and draws. The teams with the most points in the end are promoted to the next stage or the best team wins the league.
KO	Knock-Out	Teams compete against a single opponent in one or two legs (rarely a decider). The team that scores most goals in total (or most in an away game) is promoted to the next round or stage.

Defines the appointed time when a match was or will be played.

Identifier	Name	Description
N	Normal	The match is normally scheduled at the given start date.
PP	Postponed	The match start has changed and will be scheduled at a future date. The quoted start date is unconfirmed.
AN	Annulled	The match could not be finished for whatever reason. Consequently, a final or intermediate result has been invalidated.
NP	Not played	The match initially scheduled at the quoted date has not been played and neither will be even at a future date.

A point in time regarding match progress. In particular at the end of a match period.

Identifier	Name	Description
HT	Half time	After 45'+. The time between first and second half.
FT	Full time	After 90'+. The time after second half when a regular match ends.
ET	Extra time	After 120'+. The time after two additional halves of 15' when the regular time did not bring a winner although required.
P	Penalties	After the final penalty shooting if extra time did not bring a decision.
AW	Awarded	The time when a match outcome is overruled by court due to match abandonment or misbehavior of a match participant.

Defines the representation and relationship of performance index values.

Identifier	Name	Description
ABS	Absolute index format	Represents index values as points. Good performance leads to an increase in points, bad performance to a decrease. Index changes are positive for strong performances against equally strong opponents and negative otherwise.
REL	Relative index format	Represents index values as a relation to all other participants on a scale between 0 and 1. Good performance may not lead to an increase if others perform even stronger. Index changes are positive if their absolute value is higher than those of other participants.

Groups associated team performance indices to be included in the result of an API response. Used to control payload and billed points.

Identifier	Name	Description
I	Index	The main index incorporates the team performance in all matches no matter which venue. This is the default projection.
VI	Venue index	A venue index solely incorporates the team performance in matches at a particular venue (home or away).
IT	Index trend	Shows the relationship between a team's long-run and short-run performance. Significant variances may be a signal for turnarounds and hence unexpected results.
LIC	Last index change	Indicates the index change as a result of the team's performance in the last match. Affects the main index as well as the home index if the team competed at home ground or the away index if competed at away ground.
LMD	Last match details	Includes fixture and result of the match that initiated the last index change.

Assesses the relationship between short and long performance index trends.

Identifier	Name	Description
BT3	Strongly below trend	The team's short-run performance heavily differs from the long-run performance due to poor results. Future results are likely to be in the team's favor.
BT2	Increasingly below trend	The team's latest results do definitely not meet the expectation. This may be due to bad luck and/or weak performance.
BT1	Slightly below trend	The team performed marginally weaker in the last matches than it normally does.
IT0	In trend	The team's short-run performance exactly fits the expectation.
AT1	Slightly above trend	The team performed marginally better in the last matches than it normally does.
AT2	Increasingly above trend	The team's latest results definitely surpass the expectation. This may be due to luck and/or strong performance.
AT3	Strongly above trend	The team's short-run performance heavily differs from the long-run performance due to outstanding results. Future results are likely to be in the opponents' favor.

Groups associated metrics to be included in the result of an API response. Used to control payload and billed points.

Identifier	Name	Description
MD	Match details	Includes fixture and result of the match for given metrics. If excluded only the match identifier is returned.
TI	Team index	The main performance index of a team. Corresponds to the I performance projection.
TIV	Team venue index	The venue performance index of a team (home or away). Corresponds to the VI performance projection.
TIT	Team index trend	The trend of a team's main performance index. Corresponds to the IT performance projection.
CI	Competition index	The performance index of the belonging competition.
XG	Expected goals	An estimation of the number of goals that will be scored in an average game under the same preconditions. The final result may substantially diverge from this expectation as a result of over/under performance, strike rate and/or (bad) luck.
XS	Expected shots	An estimation of the number of shots that will be taken in an average game under the same preconditions. Shots are in general more representative than goals concerning performance. They uncover a team's attacking power and provide an excellent scoring indicator. Yet the strike rate may essentially differ from team to team.
XC	Expected corners	An estimation of the number of corners that will be kicked in an average game under the same preconditions. Corners are quite difficult to predict due to their manifold occurrence though provide a noticeable indicator for attacking power.
CG	Actual goals	The number of goals eventually scored.
CS	Actual shots	The number of shots eventually taken. Blocked shots and shots off target are weighted half.
CC	Actual corners	The number of corners eventually kicked.
SP	Score probabilities	Deprecated. Use 'PG' instead.
PG	Probabilities of goals	Probability distribution of potential match results at full time. Correlates with the XG projection.
PS	Probabilities of shots	Probability distribution of potential shot ratios at full time. Correlates with the XS projection.
PC	Probabilities of corners	Probability distribution of potential corner ratios at full time. Correlates with the XC projection.
XM	Expected moneyline	Statistically fair odds for teams to win or end up in a tie.
XH	Expected handicaps	Statistically fair odds for goal spreads. A spread (line) is used to even out the playing field between teams that are not evenly matched.
XP	Expected points	Statistically fair odds for the number of goals to fall above or below a threshold (line).
CM	Actual moneyline	The latest average market odds for teams to win or end up in a tie.
CH	Actual handicaps	The latest average market odds for goal spreads. A spread (line) is used to even out the playing field between teams that are not evenly matched.
CP	Actual points	The latest average market odds for the number of goals to fall above or below a threshold (line).

Represents a numeric measure of a match characteristic. Used in metric expressions and filters. Bundled through projections to be included in API responses.

Metrics dedicated to a specific team require a reference to the team in question i.e. per parameter.
Some metrics become unique only by an additional discriminator called feature. A feature is a numeric add-on (shown as regular expression in a metric identifier) that lets distinguish different thresholds or points.

Identifier	Name	Projection	Team dedicated	Description
TIT	Team index	TI	Y	The main performance index of a team.
TIO	Opponent index	TI	Y	The main performance index of a team's opponent.
TIH	Home index	TI	N	The main performance index of the home team.
TIA	Away index	TI	N	The main performance index of the away team.
TIVT	Team venue index	TIV	Y	The venue specific performance index of a team. For matches at home ground this is the home index, for matches at away ground the away index.
TIVO	Opponent venue index	TIV	Y	The venue specific performance index of a team's opponent. For matches at home ground this is the home index, for matches at away ground the away index.
TIVH	Home venue index	TIV	N	The home performance index of the home team.
TIVA	Away venue index	TIV	N	The away performance index of the away team.
TITCL	Team index long-run change	TIT	Y	The average change in the long-run trend of a team's main performance index.
TITCS	Team index short-run change	TIT	Y	The average change in the short-run trend of a team's main performance index.
TIOCL	Opponent index long-run change	TIT	Y	The average change in the long-run trend of a team opponent's main performance index.
TIOCS	Opponent index short-run change	TIT	Y	The average change in the short-run trend of a team opponent's main performance index.
TIHCL	Home index long-run change	TIT	N	The average change in the long-run trend of the home team's main performance index.
TIHCS	Home index short-run change	TIT	N	The average change in the short-run trend of the home team's main performance index.
TIACL	Away index long-run change	TIT	N	The average change in the long-run trend of the away team's main performance index.
TIACS	Away index short-run change	TIT	N	The average change in the short-run trend of the away team's main performance index.
CI	Competition index	CI	N	The performance index of the competition related to the match.
XGT	Expected team goals	XG	Y	The estimated number of goals scored by a team in an average game under the same preconditions.
XGTVA	Expected team goals venue advantage	XG	Y	The advantage incorporated in a team's expected goals based on the venue where the team competes. Adjusting expected goals (XGT) for this advantage reflects the estimation as the match was played on neutral venue.
XGO	Expected opponent goals	XG	Y	The estimated number of goals scored by a team's opponent in an average game under the same preconditions.
XGOVA	Expected opponent goals venue advantage	XG	Y	The advantage incorporated in a team opponent's expected goals based on the venue where the opponent competes. Adjusting expected goals (XGO) for this advantage reflects the estimation as the match was played on neutral venue.
XGH	Expected home goals	XG	N	The estimated number of goals scored by the home team in an average game under the same preconditions.
XGHVA	Expected home goals venue advantage	XG	N	The advantage incorporated in home team's expected goals based on its home matches. Adjusting expected goals (XGH) for this advantage reflects the estimation as the match was played on neutral venue.
XGA	Expected away goals	XG	N	The estimated number of goals scored by the away team in an average game under the same preconditions.
XGAVA	Expected away goals venue advantage	XG	N	The advantage incorporated in away team's expected goals based on its away matches. Adjusting expected goals (XGA) for this advantage reflects the estimation as the match was played on neutral venue.
XST	Expected team shots	XS	Y	The estimated number of shots taken by a team in an average game under the same preconditions.
XSTVA	Expected team shots venue advantage	XS	Y	The advantage incorporated in a team's expected shots based on the venue where the team competes. Adjusting expected shots (XST) for this advantage reflects the estimation as the match was played on neutral venue.
XSO	Expected opponent shots	XS	Y	The estimated number of shots taken by a team's opponent in an average game under the same preconditions.
XSOVA	Expected opponent shots venue advantage	XS	Y	The advantage incorporated in a team opponent's expected shots based on the venue where the opponent competes. Adjusting expected shots (XSO) for this advantage reflects the estimation as the match was played on neutral venue.
XSH	Expected home shots	XS	N	The estimated number of shots taken by the home team in an average game under the same preconditions.
XSHVA	Expected home shots venue advantage	XS	N	The advantage incorporated in home team's expected shots based on its home matches. Adjusting expected shots (XSH) for this advantage reflects the estimation as the match was played on neutral venue.
XSA	Expected away shots	XS	N	The estimated number of shots taken by the away team in an average game under the same preconditions.
XSAVA	Expected away shots venue advantage	XS	N	The advantage incorporated in away team's expected shots based on its away matches. Adjusting expected shots (XSA) for this advantage reflects the estimation as the match was played on neutral venue.
XCT	Expected team corners	XC	Y	The estimated number of corners kicked by a team in an average game under the same preconditions.
XCO	Expected opponent corners	XC	Y	The estimated number of corners kicked by a team's opponent in an average game under the same preconditions.
XCH	Expected home corners	XC	N	The estimated number of corners kicked by the home team in an average game under the same preconditions.
XCA	Expected away corners	XC	N	The estimated number of corners kicked by the away team in an average game under the same preconditions.
CGT	Actual team goals	CG	Y	The number of goals eventually scored by a team.
CGO	Actual opponent goals	CG	Y	The number of goals eventually scored by a team's opponent.
CGH	Actual home goals	CG	N	The number of goals eventually scored by the home team.
CGA	Actual away goals	CG	N	The number of goals eventually scored by the away team.
CST	Actual team shots	CS	Y	The number of shots eventually taken by a team.
CSO	Actual opponent shots	CS	Y	The number of shots eventually taken by a team's opponent.
CSH	Actual home shots	CS	N	The number of shots eventually taken by the home team.
CSA	Actual away shots	CS	N	The number of shots eventually taken by the away team.
CCT	Actual team corners	CC	Y	The number of corners eventually kicked by a team.
CCO	Actual opponent corners	CC	Y	The number of corners eventually kicked by a team's opponent.
CCH	Actual home corners	CC	N	The number of corners eventually kicked by the home team.
CCA	Actual away corners	CC	N	The number of corners eventually kicked by the away team.
SP[0-8]{2}	Score probability	SP	N	Deprecated. Use 'PG[0-8]{2}' instead.
PG[0-8]{2}	Goal probability	PG	N	The probability of a potential match result at full time. E.g. 'PG20' corresponds to the probability of a 2-0 home win.
PS[0-9]{4}	Shot probability	PS	N	The probability of a shot ratio at full time. E.g. 'PS1206' corresponds to the probability of a 12-6 ratio.
PC[0-9]{4}	Corner probability	PC	N	The probability of a corner ratio at full time. E.g. 'PC0603' corresponds to the probability of a 6-3 ratio.
XMT	Expected team odds	XM	Y	Statistically fair odds for a team to win the match.
XMO	Expected opponent odds	XM	Y	Statistically fair odds for a team's opponent to win the match.
XMH	Expected home odds	XM	N	Statistically fair odds for the home team to win the match.
XMD	Expected draw odds	XM	N	Statistically fair odds for the match to end up in a tie.
XMA	Expected away odds	XM	N	Statistically fair odds for the away team to win the match.
XHL	Expected handicap line	XH	N	The spread between home and away team goals supposed by statistically fair odds. This is usually the threshold where home and away odds closely mirror a 50/50 chance.
XHH(|+|-)\n{1-3}	Expected home handicap odds	XH	N	Statistically fair home team odds for a given spread (line). The feature expresses an Asian handicap line multiplied by 100 and must be divisible by 25. E.g. 'XHH-025' corresponds to the estimated odds of a home team's -0.25 handicap.
XHA(|+|-)\n{1-3}	Expected away handicap odds	XH	N	Statistically fair away team odds for a given spread (line). The feature expresses an Asian handicap line multiplied by 100 and must be divisible by 25. E.g. 'XHA025' corresponds to the estimated odds of an away team's +0.25 handicap.
XPL	Expected points line	XP	N	The total number of scored goals supposed by statistically fair odds. This is usually the threshold where over and under odds closely mirror a 50/50 chance.
XPO\n{1-3}	Expected over odds	XP	N	Statistically fair odds for the number of goals to fall above a given threshold (line). The feature expresses an Asian points line multiplied by 100 and must be divisible by 25. E.g. 'XPO275' corresponds to the estimated odds that more than 2.75 goals will be scored.
XPU\n{1-3}	Expected under odds	XP	N	Statistically fair odds for the number of goals to fall below a given threshold (line). The feature expresses an Asian points line multiplied by 100 and must be divisible by 25. E.g. 'XPU275' corresponds to the estimated odds that less than 2.75 goals will be scored.
CMT	Actual team odds	CM	Y	The latest average market odds for a team to win the match.
CMO	Actual opponent odds	CM	Y	The latest average market odds for a team's opponent to win the match.
CMH	Actual home odds	CM	N	The latest average market odds for the home team to win the match.
CMD	Actual draw odds	CM	N	The latest average market odds for the match to end up in a tie.
CMA	Actual away odds	CM	N	The latest average market odds for the away team to win the match.
CHL	Actual handicap line	CH	N	The spread between home and away team goals supposed by the latest average market odds. This is usually the threshold where home and away odds closely mirror a 50/50 chance.
CHH(|+|-)\n{1-3}	Actual home handicap odds	CH	N	The latest average home team market odds for a given spread (line). The feature expresses an Asian handicap line multiplied by 100 and must be divisible by 25. E.g. 'CHH-025' corresponds to the market odds of a home team's -0.25 handicap.
CHA(|+|-)\n{1-3}	Actual away handicap odds	CH	N	The latest average away team market odds for a given spread (line). The feature expresses an Asian handicap line multiplied by 100 and must be divisible by 25. E.g. 'CHA025' corresponds to the market odds of an away team's +0.25 handicap.
CPL	Actual points line	CP	N	The total number of scored goals supposed by the latest average market odds. This is usually the threshold where over and under odds closely mirror a 50/50 chance.
CPO\n{1-3}	Actual over odds	CP	N	The latest average market odds for the number of goals to fall above a given threshold (line). The feature expresses an Asian points line multiplied by 100 and must be divisible by 25. E.g. 'CPO275' corresponds to the market odds that more than 2.75 goals will be scored.
CPU\n{1-3}	Actual under odds	CP	N	The latest average market odds for the number of goals to fall below a given threshold (line). The feature expresses an Asian points line multiplied by 100 and must be divisible by 25. E.g. 'CPU275' corresponds to the market odds that less than 2.75 goals will be scored.

A configurable setting used to customize metrics projections.

Identifier	Name	Description
PIF	Performance index format	The format used to represent performance index values of both team and competition indices. See the index format enumeration.
XSQ	Expected scores quality	The minimum quality of metric values for expected goals (XG), shots (XS) and corners (XC) as well as expected odds (XM, XH, XP). Quality depends on the model's input data and is metered on a scale between 0 and 1. Medium quality is around 0.5. The higher it is the more representative the expectation.
SPM	Minimum scores probability	The minimum value of individual probabilities for possible match results. Optimizes payload in conjunction with high scores that have insignificant value.
OF	Odds format	The format used to represent expected and actual odds. See the odds format enumeration.
OL	Odds lines	The number of lines covered by handicap and points odds. Applied to both expected and actual odds. Supported values are 1-9. Though an uneven number is recommended since returned lines are centered around even odds (50/50 probability) so that the medium line is the main line.
XOM	Expected odds margin	A custom margin by which expected (fair) odds are reduced. Market (actual) odds are not affected as these include the bookmaker's margin anyway.

Allows custom metric calculation and is applied on one or more arguments. Supported arguments are individual metrics, decimal numbers and metric functions.

Identifier	Name	Description	Example	Example description
add	Addition	Summates the numeric values of two or more arguments.	add(TIH,TIA)	Total teams' performance indices.
sub	Subtraction	Subtracts the numeric value of the second argument from the first argument.	sub(1,add(SP00,SP10,SP01))	Probability of two or more goals.
mul	Multiplication	Multiplies the numeric values of two or more arguments.	add(mul(CGH,3),CSH)	Custom scores weighing.
div	Division	Divides the numeric value of the first argument by the second argument.	div(XGT,XST)	A team's expected conversion rate.
abs	Absolute	Gets the absolute value of a single argument.	abs(sub(XPL,CPL))	Divergency between expected and market points line.
grt	Greatest	Gets the highest numeric value of one or more arguments.	grt(XGHVA,XGAVA)	The higher venue advantage in expected goals.
lst	Least	Gets the lowest numeric value of one or more arguments.	lst(CMH,CMD,CMA)	The lowest moneyline market odds.

Defines the numeric styling of odds. Commonly depends on the region.

Note that all market (actual) odds include the bookmaker's margin. In reality a probability of 50% will never pay out even odds (i.e. decimal 2.00) but a little less (e.g. 1.95) as a consequence. Expected odds are by default represented as statistically fair odds (no margin). You may want to adapt this representation by setting the XOM metric attribute to a standard margin.

Identifier	Name	Description
DC	Decimal	The probability's inverse. Payout equals risk at odds of 2.0 (= even odds or a 50/50 chance).
AM	American	Favorites have negative, underdogs positive value. Positive indicates the payout of a one unit risk, negative the risk of a one unit payout. The lower the odds the better the chances to win. Even odds are at +100.
HK	Hong Kong	Equal to decimal odds minus 1. Even money is payed out at odds of 1.0.
ID	Indonesian	Equal to American odds divided by 100. Even money is payed out at odds of 1.0.
MY	Malaysian	Favorites have positive, underdogs negative value. Positive odds equal Hong Kong style, negative indicate the risk of a one unit payout. Even odds are at -1.0.
PB	Probability	The implied probability. Inverse of decimal odds. Payout equals risk at a probability of 50%.

Allows compare numeric values and delivers a boolean value. Used for predicates.

Identifier	Name
eq	Equal
ne	Not equal
lt	Less than
le	Less equal
ge	Greater equal
gt	Greater than

Errors are basically mapped to API specific codes which are returned in the response model under /error/code.
Some errors are not mapped to codes and solely identifiable through HTTP status.

Error code	HTTP status	Description	Example
101	401	Failed authentication	API authentication failed. Provide a valid authentication token.
102	401	Failed authentication	API authentication failed. Provide a valid user login and password.
111	401	Failed authentication	API authentication failed. Provide a valid subscription token.
131	403	Unauthorized operation	The operation is not active for your subscription. Either ignore it or consider another subscription plan.
-	404	Invalid endpoint	The requested URI represents an invalid endpoint which is not available. Refer to the docs to find valid paths.
-	405	Illegal method	Non-GET requests are not supported.
141	429	Exceeded rate limit	Request exceeded the maximum number of requests allowed for your subscription within a certain amount of time. Try again soon.
201	400	Missing parameter (obligatory)	The 'teamId' parameter must be defined. Refer to the docs to find out parameter details.
202	400	Missing parameters (choice)	At least one of the following parameters must be defined: 'countryId', 'nameLike'.
203	400	Missing parameter (dependent)	If a team dedicated metric is defined then the 'teamId' parameter must be defined, too.
211	400	Illegal string parameter	The 'nameLike' parameter must at least consist of 4 letters/digits.
214	400	Illegal string parameter (expression)	The 'metric' parameter contains an invalid expression. Refer to the docs to learn about eligible formats.
231	400	Illegal number parameter	The 'year' parameter must consist of 4 digits.
241	400	Illegal date parameter	The date format is unsupported for the 'minStart' parameter. Refer to the docs to find a valid format.
281	400	Too many entities parameter	The 'teamIds' parameter must not define more than two teams.
301	400	Invalid entity	The competition stage identifier is invalid. Use the 'Get Competitions' operation to find valid stages.
311	400	Unknown entity	The 'XY' projection is unknown. Refer to the docs to find valid projections.
331	400	Illegal match team	The team does not compete in the requested match.
332	400	Illegal competition stage	The match is not competed in the requested competition stage.
333	400	Illegal match start	The match start is outside the requested or default time span.
341	400	Competition stage not grouped	The competition stage is not divided into groups.
401	400	Unsupported subscription projection	The 'IT' projection is unsupported for your subscription. Either ignore it or consider another subscription plan.
411	400	Unsupported subscription format	The performance index format is unsupported for your subscription. Refer to the docs to find an alternative format.
431	400	Exceeded subscription time span	The time span between 'minDate' and 'maxDate' must not exceed 3 years for your subscription.
451	400	Exceeded subscription entities	The number of competitions must not exceed 50 for your subscription.
999	500	Unexpected error	An unexpected error occurred. Try again later or contact our API support at [email protected] under specification of reference MX-202103145519.
-	503	API unavailable	The API server is not available due to maintenance. Check the 'Retry-After' response header to find out when it's planned to come back.

Version 1.1.0

New metrics projections PG, PS and PC for detailed probability distributions on goals, shots and corners.


Version 1.0.3

New competition stage property group.
New parameter group for endpoints Get Teams and Get Team Performance Indices.


Version 1.0.2

Short names for teams.


Version 1.0.1

Shorter match result and odds updates.
New metrics projection MD.
Format correction for score probabilities with scientific notation.


Version 1.0.0

Stable version. Minor schema additions to beta.
New match property schedule, new match time AW.


Version 0.9.1

Beta version. Metrics library support. Minor schema additions to alpha.


Version 0.8.3

Alpha test version. Base and performance index libraries support.

© 2023 metrx21.io  -  Predictive Sports Analytics