Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Field Name
Type
Description
sport
string
The sport of the tournament
tournamentName
string
The name of the tournament
city
string
The city where the tournament is being held
status
string
The status of the tournament - Cancelled, Confirmed or Unconfirmed. Note that occasionally scheduled tournaments will not take place (e.g. a sponsor pulls out) in which case the status will be set to Cancelled
location
string
The country or state (US only) and country where the tournament is being held. See countryCode for a fixed format location field
countryCode
string
ISO-3166-1 alpha-3 country code of the country where the tournament is taking place. If the country is currently unknown, the code “ZZZ” will be returned.
startDate
date
The date the tournament starts
endDate
date
The date the tournament starts
year
int
The year of the tournament
identifier
int
Identifier for the tournament
numberOfMatches
int
The number of matches to be played in this tournament. Note that for Tennis and Badminton this number is initially an estimate and will become more accurate as the order of play is released
utcOffset
double
The number of hours difference between the tournament location’s timezone and UTC. This accounts for daylght savings.
eventsSummary
object
The number of matches to be played on each day, if known. This data is only available once the order of play for the tournament is released. See object definition below
competitions
array [object]
The competitions which are played as part of the tournament. See object definition below
Field Name
Type
Description
eventsSummary
object
Object containing the number of events on the specified date. There are codes for the types of events: MS - Mens Singles, LS - Ladies Singles, MD - Mens Doubles, LD - Ladies Doubles, XD - Mixed Doubles. The above codes can be prefixed with ‘Q’ to indicate they are part of qualifying for the competition
Field Name
Type
Description
organisation
string
Name of the organisation running the competition (ITTF or WTT)
externalId
string
External identifier for the competition.
competitionId
int
Identifier for the competition
participantType
string
The competition type - possible values are: MS - Mens Singles, LS - Ladies Singles, MD - Mens Doubles, LD - Ladies Doubles, XD - Mixed Doubles
drawSize
int
Draw size for the main competition
qualifyingDrawSize
int
Draw size for the qualifying competition
GET https://dde-api.imggaming.com/tabletennis/tournaments/
This endpoint returns an object containing tournaments.
dateFrom
string
YYYY-MM-DD (Example: dateFrom=2021-01-01)
dateTo
string
YYYY-MM-DD (Example: dateTo=2021-02-01)
Accept
string
application/vnd.imggaming.dde.api+json;version=1
Authorization
string
OAuth2 Bearer token
This endpoint returns details for a specific tournament if the id is valid and you are licenced for it
This endpoint should be requested if you want to understand details on a specific tournament. It will display the same types of information as the https://dde-api.imggaming.com/tabletennis/tournaments/ endpoint.
We recommend you request this end point on an ad hoc basis whenever you want this information on a specific tournament.
Example requests of this end point:
https://dde-api.imggaming.com/tabletennis/tournaments/1036
This endpoint currently takes no request parameters
Field Name
Type
Description
tournamentName
string
The name of the tournament
city
string
The city where the tournament is being held
status
string
The status of the tournament - Cancelled, Confirmed or Unconfirmed. Note that occasionally scheduled tournaments will not take place (e.g. a sponsor pulls out) in which case the status will be set to Cancelled
location
string
The country or state (US only) and country where the tournament is being held. See countryCode for a fixed format location field
countryCode
string
ISO-3166-1 alpha-3 country code of the country where the tournament is taking place. If the country is currently unknown, the code “ZZZ” will be returned.
startDate
date
The date the tournament starts
endDate
date
The date the tournament starts
year
int
The year of the tournament
identifier
int
Identifier for the tournament
numberOfMatches
int
The number of matches to be played in this tournament. Note that for Tennis and Badminton this number is initially an estimate and will become more accurate as the order of play is released
utcOffset
double
The number of hours difference between the tournament location’s timezone and UTC. This accounts for daylght savings.
eventsSummary
object
The number of matches to be played on each day, if known. This data is only available once the order of play for the tournament is released. See object definition below
competitions
array [object]
The competitions which are played as part of the tournament. See object definition below
Field Name
Type
Description
eventsSummary
object
Object containing the number of events on the specified date. There are codes for the types of events: MS - Mens Singles, LS - Ladies Singles, MD - Mens Doubles, LD - Ladies Doubles, XD - Mixed Doubles. The above codes can be prefixed with ‘Q’ to indicate they are part of qualifying for the competition
Field Name
Type
Description
organisation
string
Name of the organisation running the competition (ITTF or WTT)
externalId
string
External identifier for the competition.
competitionId
int
Identifier for the competition
participantType
string
The competition type - possible values are: MS - Mens Singles, LS - Ladies Singles, MD - Mens Doubles, LD - Ladies Doubles, XD - Mixed Doubles
drawSize
int
Draw size for the main competition
qualifyingDrawSize
int
Draw size for the qualifying competition
This endpoint lists the booked events for a tournament for which you are licenced. Note that the list of events is incomplete and will only show previous events and events for today and tomorrow. As a tournament progresses, matches will be added to the list.
This endpoint will include the order of play (OOP) updates. These include updates to events such as:
A change of table
A change of tablesequence
A change of scheduled start time
We recommend that you request the https://dde-api.imggaming.com/tabletennis/tournaments/{id}/events REST endpoint every minute so that you have the most up-to-date information on the events from live/upcoming tournaments.
This endpoint currently takes no request parameters, we aim to add them, and once we have they will be detailed here.
https://dde-api.imggaming.com/tabletennis/tournaments/847/events
This endpoint lists the results from a specific tournament, as a list of final match scores.
This endpoint lists information on results for a specific tournament, namely:
The match winner
The score
The time/date of match completion
As soon as a match is finished in the tournament, it will appear in this endpoint https://dde-api.imggaming.com/tabletennis/tournaments/{id}/results.
This endpoint currently takes no request parameters, we aim to add them, and once we have they will be detailed here
Field Name
Type
Description
eventId
string
Unique identifier for this event
date
date
Date the match was played or is scheduled to be played
matchType
string
Code indicating the type of match: MS - Mens Singles, LS - Ladies Singles, MD - Mens Doubles, LD - Ladies Doubles, XD - Mixed Doubles. The above codes can be prefixed with ‘Q’ to indicate they are part of qualifying for the competition
status
string
The current status of the match, one of: NotStarted, InProgress, Suspended, Finished
tableNumber
string
The number table the match is being played on
teamA
object
Team Status object for the first team in the match
teamB
object
Team Status object for the second team in the match
startTime
object
startTime object indicating when the match is scheduled to start
competitonId
integer
Identifier for the competition
round
string
The round this event is being played in. In case of a qualifier event the round number is prepended with a ‘Q’, like “Q3”. Otherwise it’s simply a number, e.g. “3”. The rounds work backwards, with 1 being the final, 2 being the semi-finals, 3 the quarters etc
Field Name
Type
Description
status
string
Indicates if the player detail is known for this team. Values are KnownTableTennisTeam, UnknownTableTennisTeam or Bye. For UnknownTableTennisTeam or Bye, no other fields will be present
team
object
A table tennis Team Object
Field Name
Type
Description
Player1
object
Player object containing details for the first player in the team
Player2
object
Player object containing details for the second player in the team. Only present if a doubles team
seed
int
This team’s seeding for the competition
entryType
string
This team’s entry type for the competition. Possible values are: Qualifier or Standard
Field Name
Type
Description
time
timestamp
Contains either the start time for the match (generally if it’s the first match of the day on a court) or the earliest time it could start (e.g. if there is a rain delay and they know play will not start until midday) or an estimate of the start time based on the start time of the previous match
status
string
Indicates the type of information held for the start time.
StartsAt: The time in which the match is expected to start.
NotBefore: The time in which the match will not start before.
EstimatedStart: The time in which the match is estimated to start.
FollowsPrevious: The match will follow the previous match on the same table, therefore the time attributed with a 'Follows Previous' state is a rough estimate of the start time of that match.
NoInformation: No information available.
This endpoint lists the draws for a tournament. This includes the placeholders for matches in each round of the competition.
A typical table tennis draw is an expected set of matchups within a tennis tournament which is a knockout competition. Every match a player wins, they are entered into the next round of the draw
A table tennis draw on the DDE is first of all defined by the draw type, with each competition in a table tennis tournament having its own draw.
For example, the majority of table tennis tournaments require one or more qualifying rounds, which typically take place over the weekend before the tournament week starting. On the DDE, a qualifying round can be identified by each match's specific event ID. Event IDs are explained in detail on this page.
We recommend that you request the https://dde-api.imggaming.com/tabletennis/tournaments/{id}/draws REST endpoint every minute so that you have the most up-to-date information on the draws from live/upcoming tournaments.
This endpoint currently takes no request parameters, we aim to add them, and once we have they will be detailed here.
Filed Name
Type
Description
competitionId
string
Unique identifier for this competition
participantType
string
Identifies the competition type e.g MD - Mens Doubles, LS - Ladies singles. There will be a draw object for each singles competition in the tournament and each doubles competition.
drawSize
int
Number of positions in the draw
entrySize
int
Number of teams in the draw (if not equal to drawSize then some teams will be given byes)
matches
array[object]
Array of Match objects describing the matches that are to be played
Field Name
Type
Description
eventId
string
Unique identifier for this match within the competition - to match this with the eventID returned in the /[id]/events end point you just need to concatenate it with the competitionID
round
int
(Knockout tournament only) Which round of the draw this match is in. The rounds work backwards, with 1 being the final, 2 being the semi finals, 3 the quarters etc
teamA
object
A team status object describing the first team taking part (if known)
teamB
object
A team status object describing the second team taking part (if known)
estimatedDate
date
Indicates the date when the match is likely to be played
estimatedTime
timestamp
Please be advised that this is merely a placeholder until the official Order of Play has been released and will be defaulted to 10am local time
Field Name
Type
Description
status
string
Indicates if the player detail is known for this team. Values are KnownTableTennisTeam, UnknownTableTennisTeam or Bye. For UnknownTableTennisTeam or Bye, no other fields will be present
team
object
A table tennis Team Object
Field Name
Type
Description
Player1
object
Player object containing details for the first player in the team
Player2
object
Player object containing details for the second player in the team. Only present if a doubles team
seed
int
This team’s seeding for the competition
entryType
string
This team’s entry type for the competition. Possible values are: Qualifier or Standard
Field Name
Type
Description
teamA
object
Team Status object containing details for the first team
teamB
object
Team Status object containing details for the second team
winner
string
The team ID of the winner - TeamA or TeamB
matchScore
object
The final match score object
matchExternalId
string
The external match ID for the event
matchId
int
IMG match ID
eventId
string
The event ID of the match
Field Name
Type
Description
status
string
Indicates if the player detail is known for this team. Values are KnownTableTennisTeam, UnknownTableTennisTeam or Bye. For UnknownTableTennisTeam or Bye, no other fields will be present
team
object
A table tennis team object
Field Name
Type
Description
player1
object
Player object containing details for the first player in the team
player2
object
Player object containing details for the second player in the team. Only present if a doubles team
seed
int
This team's seeding for the competition
entryType
string
This team’s entry type for the competition. Possible values are: Qualifier or Standard
Field Name
Type
Description
id
string
Unique identifier for this player
firstName
string
First name of the player
lastName
string
Last name of the player
country
string
IOC (Olympic) country code for the player
Field Name
Type
Description
gameScores
array [object]
The scores in the completed match games
gamesA
int
Number of games won by TeamA
gamesB
int
Number of games won by TeamB
Field Name
Type
Description
pointsA
int
Number of points won by TeamA
pointsB
int
Number of points won by TeamB