Cricket v1
Frequently Asked Questions
## Cricket Tournament Coverage
Tournament coverage is dictated by availability of video coverage or live scouts. Based on coverage, tournaments or events can be added or removed at any time.
Please note, as more series are added to our offering, the list will be updated. For the most up to date list, please see the Schedule feed.
Series we are currently covering for 2017:
Covered Live
* Australia vs. England ODI Series
* Bangladesh vs. Australia Test Series
* Caribbean Premier League
* England vs. Ireland ODI Series
* England vs. South Africa ODI Series
* England vs. South Africa T20 Series
* England vs. South Africa Test Series
* England vs. West Indies ODI Series
* England vs. West Indies T20 Series
* England vs. West Indies Test Series
* ICC Champions Trophy
* ICC Champions Trophy Warm-up matches
* Indian Premier League
* Ireland vs. West Indies ODI Series
* NatWest T20 Blast
* Netherlands vs. Zimbabwe ODI Series
* Scotland vs. Zimbabwe ODI Series
* South Africa vs. Bangladesh ODI Series
* South Africa vs. Bangladesh T20 Series
* South Africa vs. Bangladesh Test Series
* Sri Lanka vs. India ODI Series
* Sri Lanka vs. India T20 Series
* Sri Lanka vs. India Test Series
* Sri Lanka vs. Zimbabwe ODI Series
* Sri Lanka vs. Zimbabwe Test Series
* Tamil Nadu Premier League
* The Ashes
* Tri-Nation Series
* West Indies vs. Afghanistan ODI Series
* West Indies vs. Afghanistan T20 Series
* West Indies vs. India ODI Series
* West Indies vs. India T20 Series
* West Indies vs. Pakistan Test Series
* World Cup, Women
Delayed Live Coverage
* NatWest T20 Blast
Non-Live Coverage
* Bangladesh Premier League
* County Championship Division 1
* County Championship Division 2
* Deodhar Trophy
* Duleep Trophy
* Irani Cup
* List A One-Day Cup
* Matador BBQs One-Day Cup
* Momentum One-Day Cup
* Ranji Trophy
* Sheffield Shield
* Sunfoil Series
* Super Smash
* Syed Mushtaq Ali Trophy
* Vijay Hazare
Series are not currently covered for 2017:
* India A tour of South Africa
* Intercontinental Cup
* Rajputana Premier League
* T20 Tri-series in Australia and New Zealand
* Women's Cricket Super League
* World Cricket League Championship
## Daily Schedule
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/matches/2015/7/21/schedule.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/matches/2015/7/21/schedule.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/matches/2015/7/21/schedule.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
To access the Daily Schedule, replace the parameters in the following URL:
https://api.sportradar.us/cricket-`{access_level}{version}`/matches/`{year}`/`{month}`/`{day}`/schedule.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `year` | Year in 4 digit format (YYYY). |
| `month` | Month in 2 digit format (MM). |
| `day` | Day in 2 digit format (DD). |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Daily Schedule, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/matches-schedule.xsd?api_key=`{your_api_key}`
## Daily Summary
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/matches/2015/07/21/summary.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/matches/2015/07/21/summary.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/matches/2015/07/21/summary.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this for post game, and live games.
This endpoint retrieves the Daily Summary information.
https://api.sportradar.us/cricket-`{access_level}{version}`/matches/`{year}`/`{month}`/`{day}`/summary.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `year` | Year in 4 digit format (YYYY). |
| `month` | Month in 2 digit format (MM). |
| `day` | Day in 2 digit format (DD). |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Daily Summary, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/matches-summary.xsd?api_key=`{your_api_key}`
## Match Summary
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/matches/15cf845f-6dd0-4004-8822-2d1b17dd4ed0/summary.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/matches/15cf845f-6dd0-4004-8822-2d1b17dd4ed0/summary.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/matches/15cf845f-6dd0-4004-8822-2d1b17dd4ed0/summary.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this for post game, and live games.
This endpoint retrieves the Match Summary information for a specific match.
https://api.sportradar.us/cricket-`{access_level}{version}`/matches/`{match_id}`/summary.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `match_id` | ID of a given match. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Match Summary, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/matches-summary.xsd?api_key=`{your_api_key}`
## Player Profile
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/players/1cafe5fe-ba04-4773-bf3b-24cc29688fdd/profile.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/players/1cafe5fe-ba04-4773-bf3b-24cc29688fdd/profile.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/players/1cafe5fe-ba04-4773-bf3b-24cc29688fdd/profile.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
This endpoint retrieves a Player Profile.
https://api.sportradar.us/cricket-`{access_level}{version}`/players/`{player_id}`/profile.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `player_id` | ID for a given player. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Player Profile, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/players-profile.xsd?api_key=`{your_api_key}`
## Schedule
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/matches/schedule.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/matches/schedule.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/matches/schedule.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
This endpoint retrieves the Schedule.
https://api.sportradar.us/cricket-`{access_level}{version}`/matches/schedule.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Schedule, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/matches-schedule.xsd?api_key=`{your_api_key}`
## Series Statistics
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/series/324e971e-2044-4fa6-bdb2-0c47c99da64e/statistics.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/series/324e971e-2044-4fa6-bdb2-0c47c99da64e/statistics.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/series/324e971e-2044-4fa6-bdb2-0c47c99da64e/statistics.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
This endpoint retrieves the Series Statistics.
https://api.sportradar.us/cricket-`{access_level}{version}`/series/`{series_id}`/statistics.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `series_id` | ID of a given series. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Series Statistics, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/series-statistics.xsd?api_key=`{your_api_key}`
## Team Hierarchy
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/teams/hierarchy.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/teams/hierarchy.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/teams/hierarchy.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
This endpoint retrieves the Team Hierarchy.
https://api.sportradar.us/cricket-`{access_level}{version}`/teams/hierarchy.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Team Hierarchy, replace the parameters in the following URL.
https:///api.sportradar.us/cricket-`{access_level}{version}`/schema/teams-hierarchy.xsd?api_key=`{your_api_key}`
## Team Profile
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/cricket-t1/teams/a0a815ad-108b-402c-b930-8c888f07dc01/profile.xml?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
```
```python
import http.client
conn = http.client.HTTPSConnection("api.sportradar.us")
conn.request("GET", "/cricket-t1/teams/a0a815ad-108b-402c-b930-8c888f07dc01/profile.xml?api_key={your_api_key}")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```
```shell
curl -X GET "https://api.sportradar.us/cricket-t1/teams/a0a815ad-108b-402c-b930-8c888f07dc01/profile.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
This endpoint retrieves the Team Profile.
https://api.sportradar.us/cricket-`{access_level}{version}`/teams/`{team_id}`/profile.xml?api_key=`{your_api_key}`
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (p) or Trial (t). |
| `version` | Version number of the API you are accessing (Current Version: 1). |
| `team_id` | ID for a given team. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Team Profile, replace the parameters in the following URL.
https://api.sportradar.us/cricket-`{access_level}{version}`/schema/teams-profile.xsd?api_key=`{your_api_key}`
## Frequently Asked Questions
| API | API Version |
| Cricket | v1 |
| Note: Authentication is required for all API calls. |
Q: What format are date fields presented in?
A: When we present date only values we present these in the ISO 8601 standard format.
ex: 2013-04-03
We use these for attributes that have date and no time (such as birthdate). For more information: https://en.wikipedia.org/wiki/ISO_8601
Q: What format are the date/time fields presented in?
A: All of our Date/Time attributes are in UTC, presented in the ISO 8601 standard format.
ex: 2013-04-03T18:15:00+00:00
For more information: https://en.wikipedia.org/wiki/ISO_8601
Q: What are the valid match status values and their definition?
A: Here are the valid match status values:
- badlight – The match has been stopped due to bad lighting.
- badweather – The match has been stopped due to bad weather.
- break – The match is not over, it is currently at an inning break.
- canceled – The match has been canceled.
- closed – The match is over and the stats have been validated.
- delay – The toss or the match start is currently delayed.
- dinner – The match is not over, but the teams are taking a break for dinner.
- drink – The match is not over, but the teams are taking a drink break.
- inprogress – The match is in progress.
- lunch – The match is not over, but the teams are taking a break for lunch.
- postponed - The match has been postponed, to be made up at another day and time.
- preview – The match will be starting soon.
- rain – The match has been stopped due to rain.
- scheduled - The match is scheduled to occur.
- stump - The match is not over, but the umpires have declared the play is over for the day.
- tea – The match is not over, but the teams are taking a break for tea.
- unforeseen – The match has been stopped for an unknown reason.
- wetoutfield – The match has been stopped due to wet outfield.
Q: What are the various Cricket series you cover?
A: Here is the current list of series we are covering:
- Asia Cup Qualifiers, 2016
- Asia Cup, 2016
- Australia tour of New Zealand, 2016
- Australia tour of South Africa, 2016
- Australia Women tour of New Zealand, 2016
- England tour of South Africa, 2015-16
- England Women tour of South Africa, 2016
- ICC Intercontinental Cup, 2015-17
- ICC Womens World T20, 2016
- ICC World Cricket League Championship, 2015-17
- India tour of Australia, 2016
- India Women tour of Australia, 2016
- Ireland tour of United Arab Emirates, 2016
- Ireland v Papua New Guinea in Australia, 2016
- Pakistan Super League, 2016
- Pakistan tour of New Zealand, 2016
- Scotland and Netherlands tour of UAE, 2016
- Scotland tour of Hong Kong, 2016
- Sri Lanka tour of India, 2016
- Sri Lanka tour of New Zealand, 2015-16
- Sri Lanka Women tour of India, 2016
- T20 WC, 2016
- West Indies tour of Australia, 2015-16
- West Indies Women tour of South Africa, 2016
- Zimbabwe tour of Bangladesh, 2016
- Zimbabwe tour of United Arab Emirates, 2015-16
Please note, as additional series may be added to our offering, for the most up to date list see the Team Hierarchy feed.
Q: What are the valid match type values?
A: Here are the valid match type values:
- ODI
- T20
- TEST
Q: What are the valid batting styles?
A: Here are the valid batting styles values:
- left handed bat
- right handed bat
Q: What are the valid bowling styles?
A: Here are the valid bowling styles values:
- left-arm chinaman
- left-arm fast
- left-arm fast-medium
- left-arm medium
- left-arm orthodox
- right-arm fast
- right-arm fast-medium
- right-arm legbreak
- right-arm medium
- right-arm offbreak
Q: What are the valid toss decision values?
A: Here are the valid toss decision values and their definitions:
- batting – The coin toss winner has decided to bat.
- fielding – The coin toss winner has decided to take the field.
Q: What are the possible batting outcome values?
A: Here are the valid match type values:
- batting
- bowled
- caught
- dnb
- lbw
- retired_hurt
- retired_out
- absent-hurt
- runout
- stumped
- hitwicket
Q: What are the valid team type values?
A: Here are the valid match type values:
- team
- proxy
Q: What are the valid outcome values under match results?
A: Here are the valid outcome values:
- draw
- win
- tie
- abandon
- no_result
