Content API

Request for content is done using the HTTPS API, The response is a JSON object.

Transport protocol

The Celltick Content API is implemented as a Restful protocol using stateless HTTPS transactions. Requests are sent using the GET HTTPS method and responses are formatted as a JSON formatted string.

Access URL for content API is available at: https://contentapi.celltick.com

Get Categories

GET https://contentapi.celltick.com/mediaApi/mediaApi/v1.0/category

Method return list of content categories

Query Parameters

Name
Type
Description

vendorFilter

string

filtered out content providers (comma separated names)

vendor

string

specific content provider (comma separated names)

categoryFilter

string

Allows to filter out categories by name (comma separated list, e.g. Sports,News)

tag

string

comma separated tag names (e.g. ball,goal)

media

string

Is used in case the request is for video categories

aid

string

Mandatory In case of android application.

optOut

string

Allowed values are: true/false Mandatory In case of android application.

localCountryCode

string

Allows fetching categories by local country,2 letter country code (ISO-ALPHA-2)

originCountryCode

string

Allows fetching categories by origin country, 2 letter country code (ISO-ALPHA-2)

language

string

2 letter language code (ISO 639-1)

countryCode

string

Allows fetching categories by country, 2 letter country code (ISO-ALPHA-2)

userId

string

Source user ID

Get Category By ID

GET https://contentapi.celltick.com/mediaApi/mediaApi/v1.0/category/id/{categoryId}

Method returns single category.

Path Parameters

Name
Type
Description

categoryId

string

The specific category Id

Query Parameters

Name
Type
Description

userId

string

Source user id (UUID).

optOut

string

Allowed values are: true/false Mandatory In case of android application.

aid

string

Mandatory In case of android application.

Get Category By Name

GET https://contentapi.celltick.com/mediaApi/v1.0/category/name/{categoryName}

Returns single category item by its name (in English)

Path Parameters

Name
Type
Description

categoryName

string

The specific category name (English)

Query Parameters

Name
Type
Description

optOut

string

Allowed values are: true/false Mandatory In case of android application.

aid

string

Mandatory In case of android application.

userId

string

Source user id (UUID)

Get Content List

GET https://contentapi.celltick.com/mediaApi/v1.0/content/

Query Parameters

Name
Type
Description

vendorFilter

string

filtered out comma separated content provider names

vendor

string

comma separated content provider names

topic

string

list of comma separated topic names or Wikipedia ids. In case extended search needed please add :ext to topic name. (e.g. weather:ext)

team

string

list of comma separated sport team names or Wikipedia ids

person

string

list of comma separated person names or Wikipedia ids

sortBy

string

Parameter used to allow content sort by “newest” articles first (in descending order). In case parameter not in use, content order define by System.

thumbImgQuality

integer

Set thumbnail image quality (e.g. 30 is 30% of the original quality )

thumbImgWidth

integer

Set thumbnail image width (pixels)

thumbImgHeight

integer

Set thumbnail image height (pixels)

limit

integer

Limits the number of returned content items. Default is 20.

offset

integer

For paging only. When offset=0 returns all query content items.

language

string

2 letter language code (ISO 639-1)

localCountryCode

string

String Allows fetching categories by local country 2 letter country code (ISO-ALPHA-2)

originCountryCode

string

Allows fetching categories by origin country 2 letter country code (ISO-ALPHA-2)

countryCode

string

Allows fetching content by country.2 letter country code (ISO-ALPHA-2)

tag

string

Allows fetching content by tag names (case insensitive) [one or more]

categoryFilter

string

Allow filter out content by category names [one or more] (e.g. categoryFilter=Sports,News)

category

string

Allows fetching content by specific category names [one or more] (e.g. category=Sports,News) (Case insensitive)

publishedAfter

string

Allows fetching content from point in time and on. Date/time of publication format is: “MM/dd/yyyy hh:mm:ss”

optOut

boolean

Allowed values are: true/false, Mandatory In case of android application

aid

string

Mandatory In case of android application

userId

string

String Source user id (UUID)

Get Content By Id

GET https://contentapi.celltick.com/mediaApi/v1.0/content/{contentId}

Path Parameters

Name
Type
Description

contentId

string

UUID format

Query Parameters

Name
Type
Description

optOut

string

Allowed values are: true/false. Mandatory In case of android application.

aid

string

Mandatory In case of android application.

userId

string

Source user id (UUID).

Get person

GET https://contentapi.celltick.com/mediaApi/v1.0/person/{id}

Method returns specific person info and a top article related to the selected person

Path Parameters

Name
Type
Description

id

string

person name or Wikipedia id

Query Parameters

Name
Type
Description

userId

string

source user id

optOut

boolean

Mandatory in case of Android application

aid

string

Mandatory in case of Android application

vendorFilter

string

comma separated list of filtered out content providers

vendor

string

comma separated list of content providers

localCountryCode

string

2 letter country code (ISO-ALPHA-2)

originCountryCode

string

2 letter country code (ISO-ALPHA-2)

publishedAfter

string

Date format MM/dd/yyyy

team

string

comma separated team list

person

string

comma separated person list

topic

string

comma separated topic list

tag

string

comma separated tag list

categoryFilter

string

comma separated list of filter out categories

category

string

comma separated list of categories

countryCode

string

2 letter country code (ISO-ALPHA-2)

language

string

2 letter language code (ISO 639-1)

GET https://contentapi.celltick.com/mediaApi/mediaApi/v1.0/category

Query Parameters

Name
Type
Description

optOut

string

Allowed values are: true/false

Get team

GET https://contentapi.celltick.com/mediaApi/v1.0/team/{id}

Method returns team info.

Path Parameters

Name
Type
Description

id

string

team Wikipedia id

Query Parameters

Name
Type
Description

optOut

boolean

Mandatory in case of Android applications

aid

string

Mandatory in case of Android applications

language

string

2 letter language code (ISO 639-1)

userId

string

source user id (UUID)

Follow person

GET https://contentapi.celltick.com/mediaApi/v1.0/person/{personId}/add

Method allows user to start follow a specific person. method returns user data after the change.

Path Parameters

Name
Type
Description

personId

string

Wikipedia id

Query Parameters

Name
Type
Description

optOut

string

Mandatory in case of Android application

aid

string

Mandatory in case of Android application

userId

string

source user id (UUID)

Unfollow person

GET https://contentapi.celltick.com/mediaApi/v1.0/person/{personId}/delete

Method allows user to stop following a person. method returns user data after the change.

Path Parameters

Name
Type
Description

personId

string

Wikipedia id

Query Parameters

Name
Type
Description

optOut

string

Mandatory in case of Android application

aid

string

Mandatory in case of Android application

userId

string

source user id (UUID)

Get user data

GET https://contentapi.celltick.com/mediaApi/v1.0/user/{id}

Method return user data including followed persons and teams.

Path Parameters

Name
Type
Description

id

string

user id

Query Parameters

Name
Type
Description

sportType

integer

Specific sport type(1=soccer, 2=basketball, 6=football)

competitionId

integer

Specific competition id

aid

string

Mandatory in case of Android application

optOut

string

Mandatory in case of Android application

Last updated