Skip to content

Latest commit

 

History

History
217 lines (163 loc) · 8.7 KB

TournamentsApi.md

File metadata and controls

217 lines (163 loc) · 8.7 KB
Raw

pyroyale.TournamentsApi

All URIs are relative to https://api.clashroyale.com/v1

Method HTTP request Description
get_global_tournaments GET /globaltournaments List global tournaments
get_tournament GET /tournaments/{tournamentTag} Get tournament information
search_tournaments GET /tournaments Search tournaments

get_global_tournaments

TournamentSearchResult get_global_tournaments()

List global tournaments

List all available global tournaments.

Example

  • Api Key Authentication (JWT):
from __future__ import print_function
import time
import pyroyale
from pyroyale.rest import ApiException
from pprint import pprint
configuration = pyroyale.Configuration()
# Configure API key authorization: JWT
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to https://api.clashroyale.com/v1
configuration.host = "https://api.clashroyale.com/v1"
# Create an instance of the API class
api_instance = pyroyale.TournamentsApi(pyroyale.ApiClient(configuration))

try:
    # List global tournaments
    api_response = api_instance.get_global_tournaments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TournamentsApi->get_global_tournaments: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TournamentSearchResult

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Client provided incorrect parameters for the request. -
403 Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource. -
404 Resource was not found. -
429 Request was throttled, because amount of requests was above the threshold defined for the used API token. -
500 Unknown error happened when handling the request. -
503 Service is temprorarily unavailable because of maintenance. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tournament

TournamentDetail get_tournament(tournament_tag)

Get tournament information

Get information about a single tournament by a tournament tag.

Example

  • Api Key Authentication (JWT):
from __future__ import print_function
import time
import pyroyale
from pyroyale.rest import ApiException
from pprint import pprint
configuration = pyroyale.Configuration()
# Configure API key authorization: JWT
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to https://api.clashroyale.com/v1
configuration.host = "https://api.clashroyale.com/v1"
# Create an instance of the API class
api_instance = pyroyale.TournamentsApi(pyroyale.ApiClient(configuration))
tournament_tag = 'tournament_tag_example' # str | Tag of the tournament to retrieve. 

try:
    # Get tournament information
    api_response = api_instance.get_tournament(tournament_tag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TournamentsApi->get_tournament: %s\n" % e)

Parameters

Name Type Description Notes
tournament_tag str Tag of the tournament to retrieve.

Return type

TournamentDetail

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Client provided incorrect parameters for the request. -
403 Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource. -
404 Resource was not found. -
429 Request was throttled, because amount of requests was above the threshold defined for the used API token. -
500 Unknown error happened when handling the request. -
503 Service is temprorarily unavailable because of maintenance. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_tournaments

TournamentSearchResult search_tournaments(name=name, limit=limit, after=after, before=before)

Search tournaments

Search all tournaments by name. It is not possible to specify ordering for results so clients should not rely on any specific ordering as that may change in the future releases of the API.

Example

  • Api Key Authentication (JWT):
from __future__ import print_function
import time
import pyroyale
from pyroyale.rest import ApiException
from pprint import pprint
configuration = pyroyale.Configuration()
# Configure API key authorization: JWT
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to https://api.clashroyale.com/v1
configuration.host = "https://api.clashroyale.com/v1"
# Create an instance of the API class
api_instance = pyroyale.TournamentsApi(pyroyale.ApiClient(configuration))
name = 'name_example' # str | Search tournaments by name.  (optional)
limit = 56 # int | Limit the number of items returned in the response.  (optional)
after = 56 # int | Return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.  (optional)
before = 56 # int | Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.  (optional)

try:
    # Search tournaments
    api_response = api_instance.search_tournaments(name=name, limit=limit, after=after, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TournamentsApi->search_tournaments: %s\n" % e)

Parameters

Name Type Description Notes
name str Search tournaments by name. [optional]
limit int Limit the number of items returned in the response. [optional]
after int Return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. [optional]
before int Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. [optional]

Return type

TournamentSearchResult

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Client provided incorrect parameters for the request. -
403 Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource. -
404 Resource was not found. -
429 Request was throttled, because amount of requests was above the threshold defined for the used API token. -
500 Unknown error happened when handling the request. -
503 Service is temprorarily unavailable because of maintenance. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]