Introduction

Scope

The goal of this API is to manage liveblogs (games), teams, players and tournaments in your organization account.

Requests

All requests and responses are application/json content type and follow typical HTTP response status codes for success and failure. It is highly recommended to use HTTPS to protect your API credentials during requests. The base URL for all requests is:

https://www.tickaroo.com

A successful response is indicated by HTTP status code 200 and always contain an optional body. If the response has a body it will be documented below.

Unless otherwise stated, errors to bad requests will respond with HTTP 4xx or status codes. The body will contain a JSON document detailing the error. General error codes include:

Authentication

Tickaroo will Provide you with an client_id and client_secret that allows you to access resources within your organization directly.

Authentication to the API is either performed via HTTP Basic Auth or via query parameters.

For basic auth, use the client_id as the basic auth username and the client_secret as the basic auth password and encode them as usual.

For query parameters just add the client_id and client_secret to your query and set them to the corresponding values.

Responses

Parsing Guidelines

Every JSON object in the API’s response contains a _type field indicating what type of object is returned. The _type field is always string starting with Tik::Model::. The documentation will use this string do define object types.

All dates and timestamps in the API are transmitted as 32bit UNIX Timestamps. The object documentation will call those fields “Timestamp”.

Fields declared “ObjectID” in the documentation are string matching the regular expression /\A[0-9a-fA-F]{24}\Z/.

Field declared “Sportstype” must contain a valid sportstype identifier. Valid identifiers are:

We are currently in the progress of migrating the v3 templates to v4. More templates will be available soon. Let us know if you miss something.

General Object Types

Tik::Model::ApiError

General error message usually used 400, 401, 403 Responses.

{
  "_type": "Tik::Model::ApiError",
  
  // (string) contains a detailed error message
  "message": "" 
}

Tik::Model::ApiSuccess

General success message without specific return value.

{
  "_type": "Tik::Model::ApiSuccess"
}

Tik::Model::ValidationError

Validation error usually used for 422 Responses.

{
  "_type": "Tik::Model::ValidationError"
  "errors": [
    {
      "_type": "Tik::Model::ValidationErrorItem",
      
      // (string) attribute with failed validation
      "attribute": ""
      
      // (string) error message
      "error": ""
    }
  ]
}

Tik::Model::Collection

General paginated list.

{
  "_type": "Tik::Model::ApiCollection",
  
  // (int) the total number of results in the list
  "total": 0,
  
  // (int) the index of the first element of result
  "offset": 0,
  
  // (array<?>) the result list
  "items": []
}

Status

Status codes for entities with a “status” attribute.

• 0: StatusDefault
• 40: StatusProtected
• 50: StatusInaccessable
• 51: StatusInaccessableByTickaroo
• 60: StatusUnpublished
• 90: StatusBlocked
• 100: StatusDeleted

Entity Types

• Liveblog (Game)
• Tournaments
• Teams
• Players