Associations API

Associations API

Name, code and the country of all cricket associations covered by Roanuz Sports. The association key available in the Associations API is required to access information from other APIs such as the Association Featured Tournaments. The ICC, BCCI, ECB, Yorkshire Cricket Board etc. are a few examples of cricket associations.
Cricket API Image

Request structure

Here is what you would require to make your first successful HTTP REST call from the Association API.

Sample Request

TERMINAL
pip install roanuz-sports
pip install roanuz-sports
icon copy
get_associations.py
import requests project_key = 'PROJ_KEY' token = 'API_TOKEN' url = "https://api.sports.roanuz.com/v5/cricket/{}/association/list/".format(project_key) headers = { 'rs-token': token } response = requests.get(url, headers=headers) print(response.json())
import requests

project_key = 'PROJ_KEY'
token = 'API_TOKEN'
url = "https://api.sports.roanuz.com/v5/cricket/{}/association/list/".format(project_key)
headers = {
    'rs-token': token
}
response = requests.get(url, headers=headers)

print(response.json())
icon copy
get_associations_pagination.py
import requests project_key = 'PROJ_KEY' token = 'API_TOKEN' page_key = '2' url = "https://api.sports.roanuz.com/v5/cricket/{}/association/list/{}/".format(project_key, page_key) headers = { 'rs-token': token } response = requests.get(url, headers=headers) print(response.json())
import requests

project_key = 'PROJ_KEY'
token = 'API_TOKEN'
page_key = '2'
url = "https://api.sports.roanuz.com/v5/cricket/{}/association/list/{}/".format(project_key, page_key)
headers = {
    'rs-token': token
}
response = requests.get(url, headers=headers)

print(response.json())
icon copy

Concepts

We recommend you to understand the following concepts and keep them in mind while developing your application. A sound knowledge of the concepts explained below should help you in maintaining the quality of your app.

HTTP Status

Possible status codes you may receive in response to your requests.

HTTP StatusError Code
200
OK. Everything is fine.
500
UN-500-0
Unknown Error. In unpredictable circumstances the server may throw 500 errors for a very brief period. When this happens retry the same request.
HTTP StatusReasonError Code
200
OK. Everything is fine.
500
Unknown Error. In unpredictable circumstances the server may throw 500 errors for a very brief period. When this happens retry the same request.
UN-500-0

Cache

A cache object accompanies every API response. It comes with a set of recommended values to help you properly cache the data and handle the cache internally.

When you try to cache the responses on say MemCached, Redis or any other cache server, you will usually require a Key and an expire time.

cache.key

Our recommendations on what Key or ID you should use while you cache a response of this API.

cache.expires

Our recommendations on how long you can cache a particular response.

An interesting thing to note here is that the recommended expire time is not going to be the same under all situations. Our intelligent caching mechanism dynamically decides the best expire time analysing various parameters.

The cache object also provides you with a max_age and the ETag values, which lets you implement the ETag HTTP caching mechanism. To implement HTTP Caching with this API, refer here.

cache.max_age

Our recommended period of time up to which you can consider the data to be fresh. It gives you a heads up on when you should be checking for updates in the data.

cache.etag

Etag is an identifier for a specific version of a response. To know more, refer here.

The time period specified in max_age will be lesser than that in the expires object. To sum it up, the cache.expires object tells you how long you can cache the data while the cache.max_age object tells you when you should check for updates.

Downloads

A few snapshots of the Associations API in action under different scenarios that could help you in testing your app and understanding the responses in most cases.

Response Schema

The schema as per which the data is sent by the Associations API is explained below. We constantly work on improving our API system, and in some cases, safely introduce new attributes to provide interesting and useful features. To give you a heads up regarding such updates, every successful API response will contain a schema object. It gives the information about the current minor version and major version of the API.