I/O Docs: API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Competition

  • List Methods
  • Expand Methods

  • GET Aliases /competition/aliases/:apiKey/:competitionId

    Returns a list of recognised aliases, which can be used in the API method calls, for the competition in question.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID for the competition in question.

  • GET Attendances /competition/attendances/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of venues and matches with their attendances sorted in order of highest first.

    Parameter	Value	Type	Description
    :competitionId		string	The unique ID or recognised alias for the competition in question.
    :startDate		string	The start date for the period in question in yyyy-MM-dd format.
    :endDate		string	The end date for the period in question in yyyy-MM-dd format.

  • GET Competition /competition/:apiKey

    Returns a list of available competitions along with the most recent associated season

  • GET Events /competition/events/:apiKey/:competitionId/:startDate/:endDate

    Returns all of the matches and their events for the competition and dates in question or for the particular season.

    Parameter	Value	Type	Description
    :competitionId		integer	The unique ID or recognised alias for the competition in question.
    :startDate		date	The start date for the period in question in yyyy-MM-dd format.
    :endDate		date	The end date for the period in question in yyyy-MM-dd format.

  • GET Fixtures /competition/fixtures/:apiKey/:competitionId

    Returns a list of fixtures (games that have not yet been played) for a competition.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET FixturesEnhanced /competition/fixturesEnhanced/:apiKey/:competitionId/:endDate

    Returns a list of fixtures between 2 dates, including all postponements

    Parameter	Value	Type	Description
    :competitionId		integer	The ID of the competition in question
    :endDate		date	The required start date in yyyyMMdd format.

  • GET LeagueTable /competition/leagueTable/:apiKey/:competitionId/:date

    Returns the latest live league table for a competition.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.
    :date		date	The date you would like the table for (see notes).

  • GET LeagueTableEnhanced /competition/leagueTableEnhanced/:apiKey/:competitionId/:date

    Returns a structure representation of a competition's league table

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition Identifier
    :date		date	The date of the league table (defaults to the most recent)

  • GET LiveGames /competition/liveGames/:apiKey/:competitionId

    Returns the details of all live games that are being played on the day the method is called and for a competition.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET MatchDates /competition/matchDates/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of dates (between a start and end date) on which matches are being played, in the competition in question.

    Parameter	Value	Type	Description
    :competitionId		string	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The end date of the period in question in yyyyMMdd format.

  • GET MatchDatesEnhanced /competition/matchDatesEnhanced/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of fixture dates for a competition, including those dates where postponements occurred.

    Parameter	Value	Type	Description
    :competitionId		integer	The Competition ID of interest.
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.

  • GET MatchDay /competition/matchDay/:apiKey/:competitionId/:matchDay

    Returns a combination of fixtures, live games and results on the day the method is called and for a competition.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.
    :matchDay		date	The required date in yyyyMMdd format.

  • GET MatchDayEnhanced /competition/matchDayEnhanced/:apiKey/:competitionId/:date

    Returns a list of matches being played on a day. Includes enhanced data and schema

    Parameter	Value	Type	Description
    :competitionId		integer	The CompetitionID in question.
    :date		date	The Match Day of interest

  • GET MatchDays /competition/matchDays/:apiKey/:competitionId/:startDate/:endDate/:teamId

    Returns a combination of fixtures, live games and results for a date range and competition.

    Parameter	Value	Type	Description
    :competitionId		integer	The Competition ID of interest
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.
    :teamId		integer	The Team ID of interest

  • GET MatchDaysEnhanced /competition/matchDaysEnhanced/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of matches in a date range (includes Postponed games). Includes enhanced data and schema

    Parameter	Value	Type	Description
    :competitionId		integer	The Competition ID in question
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.

  • GET News /competition/news/:apiKey/:competitionId

    Returns the latest 10 news articles related to the competition chosen.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET NewsImage /competition/newsImage/:apiKey/:articleId/:width/:height

    Returns an image corresponding to a news article. The option parameters of width and height will provide a scaled image at the size requested.

    Parameter	Value	Type	Description
    :articleId		integer	The news article ID in question.
    :width		integer	The required width in pixels.
    :height		integer	The required height in pixels.

  • GET Postponements /competition/postponements/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of fixtures that have been postponed in a competition between two dates.

    Parameter	Value	Type	Description
    :competitionId		integer	The Competition ID
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.

  • GET Results /competition/results/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of results from the start of the current season to now, unless the optional start date and end date parameters are specified.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The optional end date of the perion in question in yyyyMMdd format.

  • GET Seasons /competition/:apiKey/:competitionId

    Returns a list of available seasons for a competition if the client is entitled to them

    Parameter	Value	Type	Description
    :competitionId		integer	The Competition ID

  • GET Teams /competition/teams/:apiKey/:competitionId/:startDate/:endDate

    Returns a list of teams that are playing, or have played, in a competition for the dates requested.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	The start date for the period in question in yyyyMMdd format.
    :endDate		date	The end date for the period in question in yyyyMMdd format.

  • GET Venue /competition/venue/:apiKey/:competitionId/:venueId/:startDate/:endDate

    Returns a list of matches and their attendances at the venue in question for the competition in question.

    Parameter	Value	Type	Description
    :competitionId		string	The PA competition ID or a recognised alias for the competition in question.
    :venueId		integer	The unique ID of the venue in question.
    :startDate		date	Start date
    :endDate		date	End date

  • GET Venues /competition/venues/:apiKey/:competitionId/:startDate/:endDate

    Returns all venues and their matches for the competition in question.

    Parameter	Value	Type	Description
    :competitionId		string	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	Start date
    :endDate		date	End date

  • GET Vidiprinter /competition/vidiprinter/:apiKey/:events/:comps/:notMatches

    Returns latest X number of major events across chosen competitions.

    Parameter	Value	Type	Description
    :events		integer	The number of events to return
    :comps		string	The pipe-delimited string of interested competition IDs
    :notMatches		string	The pipe-delimited string of interested match IDs

• CompetitionStats

  • List Methods
  • Expand Methods

  • GET EAIndex /competition/eaIndex/:apiKey/:competitionId/:startDate/:endDate

    Returns match and player data based on the EA Index for the competition in question and date range.

    Parameter	Value	Type	Description
    :competitionId		string	The ID or recognised alias of the competition in question.
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The start date of the period in question in yyyyMMdd format.

  • GET EAIndexFull /competition/eaIndexFull/:apiKey/:competitionId/:startDate/:endDate

    Provides the full EA Index for the parameters in question.

    Parameter	Value	Type	Description
    :competitionId		string	The ID or recognised alias of the competition in question.
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The end date of the period in question in yyyyMMdd format.

  • GET EAIndexTop /competition/eaIndexTop/:apiKey/:competitionId/:date/:type

    Provides the top players in the EA Index based on the parameters passed.

    Parameter	Value	Type	Description
    :competitionId		integer	The unique ID or recognised alias of the competition in question.
    :date		date	The end date of the period in question in yyyyMMdd format.
    :type		string	The type of report required (see notes).

  • GET Metrics /competition/metrics/:apiKey/:competitionId/:startDate/:endDate

    Returns key values on the number of elements recorded for the competition in question, for the date period in question.

    Parameter	Value	Type	Description
    :competitionId		string	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The end date of the period in question in yyyyMMdd format.

  • GET Stats /competition/stats/:stat/:apiKey/:competitionId/:startDate/:endDate

    Returns details of a chosen statistic type in a competition between two dates.

    Parameter	Value	Type	Description
    :stat		string	Stat type
    :competitionId		integer	Competition ID
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.

  • GET Summary /competition/stats/summary/:apiKey/:competitionId/:startDate/:endDate

    Returns top level total stats for all event types for a competition for the dates requested.

    Parameter	Value	Type	Description
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.
    :startDate		date	The start date of the period in yyyyMMdd format.
    :endDate		date	The end date of the period in yyyyMMdd format.

• Competitions

  • List Methods
  • Expand Methods

  • GET Competitions /competitions/competitions/:apiKey

    Returns a list of competitions and seasons you are entitled to, along with their start and end dates.

  • GET Fixtures /competitions/fixtures/:apiKey

    Returns a list of fixtures (games that have not yet been played) for all competitions you are entitled to.

  • GET MatchDates /competitions/matchDates/:apiKey/:startDate/:endDate

    Returns a list of dates (between a start and end date) on which matches are being played.

    Parameter	Value	Type	Description
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The end date of the period in question in yyyyMMdd format.

  • GET MatchDay /competitions/matchDay/:apiKey/:matchDay

    Returns a combination of fixtures, live games and results on the day the method is called and for all competitions you're entitled to.

    Parameter	Value	Type	Description
    :matchDay		date	The required date in yyyyMMdd format.

  • GET Results /competitions/results/:apiKey/:startDate/:endDate

    Returns a list of results from the start of the current season to now, unless the optional start date and end date parameters are specified.

    Parameter	Value	Type	Description
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		string	The optional end date of the period in question in yyyyMMdd format.

• CompetitionsStats

  • List Methods
  • Expand Methods

  • GET Metrics /competitions/metrics/:apiKey/:startDate/:endDate

    Returns key metrics on the number of elements recorded in the competitions you are entitled to, for the date range in question.

    Parameter	Value	Type	Description
    :startDate		date	The start date of the period in question in yyyyMMdd format.
    :endDate		date	The end date of the period in question in yyyyMMdd format.

• Match

  • List Methods
  • Expand Methods

  • GET Actions /match/actions/:apiKey/:matchId

    Returns events (actions) in a match one by one as the game progresses.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET CombinedCommentary /match/combinedCommentary/:apiKey/:matchId

    Returns either enhanced or manual commentary for the match in question.

    Parameter	Value	Type	Description
    :matchId		integer	The unique ID of the match in question.

  • GET Commentary /match/commentary/:apiKey/:matchId

    Returns the text commentary for the match in question.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET CommentaryDataSource /match/commentaryDataSource/:apiKey/:matchId

    Commentary Data Source

    Parameter	Value	Type	Description
    :matchId		integer	PA match Id

  • GET CommentaryPreview /match/commentaryPreview/:apiKey/:matchId

    Commentary Preview

    Parameter	Value	Type	Description
    :matchId		integer	PA match Id

  • GET EAIndex /match/eaIndex/:apiKey/:matchId

    Returns the players that took player in the match along with their EA index data.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET EnhancedCommentary /match/enhancedCommentary/:apiKey/:matchId

    Returns an enhanced version of the match commentary.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET Events /match/events/:apiKey/:matchId

    Returns top level events and status changes for the match in question.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET FastEvents /match/fastEvents/:apiKey/:matchId

    Provides a fast simple event notifications for all matches covered with manual commentary.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET FormLive /match/formlive/:apiKey/:matchId/:action|status|stats/:id

    Gets big collection of statistical data for a given match/action/event.

  • GET FormLivePhrases /match/formlivePhrases/:apiKey/:matchId/:action|status|stats/:id

    Gets all suitable phrases for a given match event/status/stats bucket.

  • GET FormLiveTemplates /match/formliveTemplates/:apiKey

    Retrieves all Form Live templates

  • GET HeadToHead /match/headToHead/:apiKey/:matchId/:startDate/:sameany

    Returns head to head data for a match, including summaries of official when known, previous meetings and team squads

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID
    :sameany		string	Competition Limit (see notes)
    :startDate		date	Start date

  • GET Image /match/image/:apiKey/:matchId/:imageURL/:width/:height

    Returns an image.

    Parameter	Value	Type	Description
    :imageURL		string	The URL (filename) of the image in question.
    :width		integer	The required width in pixels.
    :height		integer	The required height in pixels.

  • GET Images /match/images/:apiKey/:matchId

    Returns a list of images post match for the match in question.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET Info /match/info/:apiKey/:matchId

    Returns a match day summary for the match in question.

    Parameter	Value	Type	Description
    :matchId		integer	The unique ID of the match in question.

  • GET InfoEnhanced /match/infoEnhanced/:apiKey/:matchId

    Returns an enhanced version of the Match Info endpoint, including bookings and dismissal details

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

  • GET LineUps /match/lineUps/:apiKey/:matchId

    Returns team line-ups for a match, along with manager names, player events summaries and team formations.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET LineUpsEnhanced /match/lineUpsEnhanced/:apiKey/:matchId

    Returns team line-ups for a match, along with manager names, player events summaries and team formations.

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

  • GET MobileCommentary /match/mobileCommentary/:apiKey/:matchId

    Returns the mobile version of the text commentary for the match in question. This is designed to be less wordy and more factual and includes miniForm for important events.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET PerformanceLineups /match/performanceLineups/:apiKey/:matchId

    Returns Lineups for a match for the Performance API

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

  • GET Post-MatchStats /match/postMatchStats/:apiKey/:matchId

    Returns additional match stats based on a video review of the game post match.

    Parameter	Value	Type	Description
    :matchId		string	The unique identifier of the match in question.

  • GET Pre-MatchPreview /match/preMatchPreview/:apiKey/:matchId

    Preovides an analysis of form and (where possible) a prediction for the winner, based on that form.

    Parameter	Value	Type	Description
    :matchId		integer	The unique ID of the match in question.

  • GET Preview /match/preview/:apiKey/:matchId

    Returns an editorial preview for a match.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET PreviewEnhanced /match/previewEnhanced/:apiKey/:matchId

    Returns an editorial preview for a match.

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

  • GET Report /match/report/:apiKey/:matchId

    Returns an editorial post match report for a match.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET Shootout /match/shootout/:apiKey/:matchId

    Returns penalty shootout detailed breakdown.

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

  • GET Stats /match/stats/:apiKey/:matchId

    Returns top level stats for major events in a match.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET StatsEnhanced /match/statsEnhanced/:apiKey/:matchId

    Returns top level stats for major events in a match.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET TopX /matches/top/:stat/:apiKey/:limit/:startDate/:endDate/:competitionId/:teamId/:playerId

    Rank matches by occurrences of events

    Parameter	Value	Type	Description
    :stat		string	A Stat Type (e.g. goals)
    :limit		integer	The number of items to return (see notes)
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.
    :competitionId		integer	A Competition ID
    :teamId		integer	A Team ID
    :playerId		integer	A Player ID

  • GET Venue /match/venue/:apiKey/:matchId

    Returns the venue name, longitude and latitude floats for a match venue.

    Parameter	Value	Type	Description
    :matchId		integer	The match ID in question.

  • GET WidgetCommentary /match/widgetCommentary/:apiKey/:matchId

    Returns commentary for a match in form suitable for a widget

    Parameter	Value	Type	Description
    :matchId		integer	A Match ID

• PerformanceData

  • List Methods
  • Expand Methods

  • GET EnhancedMatch /performance/enhancedMatch/:apiKey/:matchId

    Returns player performance data for a particular match.

    Parameter	Value	Type	Description
    :matchId		integer	The unique identifier of the match in question.

  • GET Match /performance/match/:apiKey/:matchId

    Returns player performance data for a particular match.

    Parameter	Value	Type	Description
    :matchId		integer	The unique identifier of the match in question.

  • GET Seasonal /performanceData/seasonal/:apiKey

    Returns player by player seasonal performance data.

• Player

  • List Methods
  • Expand Methods

  • GET Aliases /player/aliases/:apiKey/:playerId

    Returns a list of recognised aliases, which can be used in the API method calls, for a player.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID for the player in question.

  • GET Events /player/events/:apiKey/:playerId/:startDate/:endDate

    Returns all matches and their events for a particular player in a specific competition season or for all competitions between two dates.

    Parameter	Value	Type	Description
    :playerId		string	The ID or recognised alias of the player in question.
    :startDate		date	The start date for the period in question in yyyyMMdd format.
    :endDate		date	The end date for the period in question in yyyyMMdd format.

  • GET HeadToHeads /player/headToHeads/:apiKey/:player1Id/:player2Id/:startDate/:endDate/:competitionId

    Compares top level stats for two players between two dates.

    Parameter	Value	Type	Description
    :player1Id		string	The unique identifier or recognised alias for the first player to be compared.
    :player2Id		string	The unique identifier or recognised alias for the second player to be compared.
    :startDate		string	The start date for the period in question in yyyyMMdd format.
    :endDate		string	The end date for the period in question in yyyyMMdd format.
    :competitionId		string	The optional unique identifier or recognised alias for the competition in question.

  • GET Image /player/image/:apiKey/:playerId/:width/:height

    Returns an image of a player.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.
    :width		integer	The required width in pixels.
    :height		integer	The required height in pixels.

  • GET Profile /player/profile/:apiKey/:playerId

    Returns top level personal information about a player.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.

  • GET ProfileEnhanced /player/profileEnhanced/:apiKey/:playerId

    Returns top level personal information about a player.

    Parameter	Value	Type	Description
    :playerId		integer	A Player ID

  • GET TeamMates /player/teamMates/:apiKey/:playerId/:teamId/:startDate/:endDate

    Returns a list of a player's teammates.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The start date for the historical list in yyyyMMdd format.
    :endDate		date	The end date for the historical list in yyyyMMdd format.

  • GET Teams /player/teams/:apiKey/:playerId

    Returns a list of teams that a player has played for.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.

• PlayerStats

  • List Methods
  • Expand Methods

  • GET Appearances /player/appearances/:apiKey/:playerId/:startDate/:endDate/:teamId/:competitionId

    Returns information on appearances, matches started, substitutions and dismissals for a player.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required end date in yyyyMMdd format.
    :teamId		integer	A PA team ID or a recognised alias.
    :competitionId		integer	A PA competition ID or a recognised alias.

  • GET CompetitionAppearances /player/competitionAppearances/:apiKey/:playerId/:startDate/:endDate/:competitionId

    Returns appearance stats for a particular player in a particular competition for the date range in question.

    Parameter	Value	Type	Description
    :playerId		string	The PA player ID or a recognised alias for the player in question.
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required end date in yyyyMMdd format.
    :competitionId		string	A PA competition ID or a recognised alias.

  • GET SelectStats /player/selectStats/:apiKey/:playerId/:startDate/:endDate/:teamId/:competitionId

    Returns a predefined collection of select statistics for a player in a team/competition.

    Parameter	Value	Type	Description
    :playerId		integer	A Player ID
    :startDate		date	The Start of the Date Range
    :endDate		date	The End of the Date Range
    :teamId		integer	A Team ID
    :competitionId		integer	A Competition ID

  • GET Stats /player/stats/:statType/:apiKey/:playerId/:startDate/:endDate/:teamId/:competitionId

    Returns stats for all event types of the given stat type for a player for the dates requested.

    Parameter	Value	Type	Description
    :statType		string	A valid statistic type (e.g. goals)
    :playerId		integer	A Player ID
    :startDate		date	The start date of the date range in yyyyMMdd format
    :endDate		date	The end date of the date range in yyyyMMdd format
    :teamId		integer	A Team ID
    :competitionId		integer	A CompetitionID

  • GET Summary /player/stats/summary/:apiKey/:playerId/:startDate/:endDate/:teamId/:competitionId

    Returns top level total stats for all event types for a player for the dates requested.

    Parameter	Value	Type	Description
    :playerId		integer	The PA player ID or a recognised alias for the player in question.
    :startDate		date	The start date of the period in yyyyMMdd format.
    :endDate		date	The end date of the period in yyyyMMdd format.
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET TopX /players/top/:stat/:apiKey/:limit/:startDate/:endDate/:competitionId/:teamId

    Rank players by occurrences of events

    Parameter	Value	Type	Description
    :stat		string	A valid stat type (e.g. DismissalsForViolentConduct)
    :limit		integer	The number of results to return
    :startDate		date	The start of the date range in yyyyMMdd format
    :endDate		date	The end of the date range in yyyyMMdd format
    :competitionId		integer	A Competition ID
    :teamId		integer	A Team ID

• Stats

  • List Methods
  • Expand Methods

  • GET EventBreakdown /stats/eventBreakdown/:apiKey/:statType/:startDate/:endDate/:competitionId/:teamId/:playerId

    Shows the breakdown of match event occurrences

    Parameter	Value	Type	Description
    :statType		string	A valid Statistic Type
    :startDate		date	The start of the date range
    :endDate		date	The end of the date range
    :competitionId		integer	A Competition ID
    :teamId		integer	A Team ID
    :playerId		integer	A Player ID

  • GET StatsTypes /stats/types/:apiKey

    List and description of defined stats types

• Team

  • List Methods
  • Expand Methods

  • GET Aliases /team/aliases/:apiKey/:teamId

    Returns a list of recognised aliases, which can be used in the API method calls, for a team.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID for the team in question.

  • GET Badge /team/badge/:apiKey/:teamId/:width/:height

    Returns the current badge image for a team.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :width		integer	The required width in pixels.
    :height		integer	The required height in pixels.

  • GET CompetitionsMatchDays /team/competitionsMatchDays/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns a combination of fixtures, live games and results for a date range and team id.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.
    :competitionId		integer	A Competition ID

  • GET Events /team/events/:apiKey/:teamId/:startDate/:endDate

    Returns all matches and their events for a particular team for all competitions between two dates.

    Parameter	Value	Type	Description
    :teamId		string	The unique identifier or recognised alias for the team in question.
    :startDate		date	The start date for the period in question in yyyyMMdd format.
    :endDate		date	The end date for the period in question in yyyyMMdd format.

  • GET Fixtures /team/fixtures/:apiKey/:teamId

    Returns the fixtures (all upcoming matches) for a team.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.

  • GET FullSquad /team/fullSquad/:apiKey/:teamId

    Returns full team squad including loaned palyers.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID

  • GET HeadToHeads /team/headToHeads/:apiKey/:team1Id/:team2Id/:startDate/:endDate/:competitionId

    Compares top level stats for a particular set of teams, between two dates.

    Parameter	Value	Type	Description
    :team1Id		string	The unique identifier or recognised alias for the first team to be compared.
    :team2Id		string	The unique identifier or recognised alias for the second team to be compared.
    :startDate		string	The start date for the period in question in yyyyMMdd format.
    :endDate		string	The end date for the period in question in yyyyMMdd format.
    :competitionId		string	The optional unique identifier or recognised alias for the competition in question.

  • GET History /team/history/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns a top level summary of matches won, drawn and lost for a team, along with a full list of matches.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The required start date for the period in question in yyyyMMdd format.
    :endDate		date	The required end date for the period in question in yyyyMMdd format.
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET Manager /team/manager/:apiKey/:managerId

    Returns a complete team and match history for a manager.

    Parameter	Value	Type	Description
    :managerId		integer	The unique identifier for the manager in question.

  • GET News /team/news/:apiKey/:teamId

    Returns a set of Team News

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID

  • GET Profile /team/profile/:apiKey/:teamId

    A team profile overview; manager history and current competitions with league position where appropriate.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID

  • GET Results /team/results/:apiKey/:teamId/:startDate/:endDate

    Returns a list of results for a team.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The start date for historical results in yyyyMMdd format.
    :endDate		date	The end date for historical results in yyyyMMdd format.

  • GET Shirt /team/shirt/:apiKey/:teamId/:width/:height

    Returns the current shirt of a team, this image is representational and does not exactly match the shirts themselves, nor do we include any sponsors logos for legal reasons.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :width		integer	The required width in pixels.
    :height		integer	The required height in pixels.

  • GET Squad /team/squad/:apiKey/:teamId/:startDate/:endDate/:mode

    Returns the current squad list for a team. The optional date parameters allow you to request an historical squad list.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The start date for the historical squad list in yyyyMMdd format.
    :endDate		date	The end date for the historical squad list in yyyyMMdd format.
    :mode		string	members or transfers

  • GET SquadEnhanced /team/squadEnhanced/:apiKey/:teamId/:competitionId

    Returns squad members and stats for a team (and optionally competition) for the current season.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID
    :competitionId		integer	A CompetitionID

  • GET TeamSummary /team/teamSummary/:apiKey/:teamId

    Returns details on accepted aliases and managers for a team.

    Parameter	Value	Type	Description
    :teamId		string	The team ID or recognised alias for the team in question.

  • GET TeamSummaryEnhanced /team/teamSummaryEnhanced/:apiKey/:teamId

    Returns a summary of team details.

    Parameter	Value	Type	Description
    :teamId		integer	A PA team Id.

  • GET Venue /team/venue/:apiKey/:teamId

    Returns the home venue (ground) of a team, along with its longitude and latitude (when available).

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.

• TeamStats

  • List Methods
  • Expand Methods

  • GET Metrics /team/metrics/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns top level figures on how many events, matches and players have been processed for the team in question, for the dates in question and the optional competition.

    Parameter	Value	Type	Description
    :teamId		string	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The start date for historical results in yyyyMMdd format.
    :endDate		string	The end date for historical results in yyyyMMdd format.
    :competitionId		string	The unique ID or recognised alias for the competition in question.

  • GET SelectStats /team/selectStats/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns a predefined collection of select statistics for a team in a competition.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID
    :startDate		date	The Start of the Date Range
    :endDate		date	The End of the Date Range
    :competitionId		integer	A Competition ID

  • GET Stats /team/stats/:statType/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns stats for all event types of the given stat type for a team for the dates requested.

    Parameter	Value	Type	Description
    :teamId		integer	A Team ID
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.
    :competitionId		integer	A Competition ID
    :statType		string	A statistic type

  • GET StatsOverview /teams/stats/:apiKey/:competitionId/:startDate/:endDate

    Returns a statistical overview of teams in a competition between two dates.

    Parameter	Value	Type	Description
    :competitionId		integer	A Competition ID
    :startDate		date	The required start date in yyyyMMdd format.
    :endDate		date	The required start date in yyyyMMdd format.

  • GET Summary /team/stats/summary/:apiKey/:teamId/:startDate/:endDate/:competitionId

    Returns top level total stats for all event types for a team for the dates requested.

    Parameter	Value	Type	Description
    :teamId		integer	The PA team ID or a recognised alias for the team in question.
    :startDate		date	The start date of the period in yyyyMMdd format.
    :endDate		date	The end date of the period in yyyyMMdd format.
    :competitionId		integer	The PA competition ID or a recognised alias for the competition in question.

  • GET TopX /teams/top/:stat/:apiKey/:limit/:startDate/:endDate/:competitionId

    Rank teams by occurrences of events

    Parameter	Value	Type	Description
    :stat		string	A valid stat type (e.g. dismissals)
    :limit		integer	The number of results to return (see notes)
    :startDate		date	The start of the date range in yyyyMMdd format
    :endDate		date	The end of the date range in yyyyMMdd format
    :competitionId		integer	A Competition ID

• Competition

  • List Methods
  • Expand Methods

  • GET List all Competitions competition

    Returns a list of all available competitions

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML

  • GET Details of specific Competition competition/competitionId

    Returns the details of a specific competition

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.ae533484-a755-f5b4-f6e5-355615a1f06cÂÂ

  • GET Competition Table competition/competitionId/table

    Returns the table of a specific competition

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.ae533484-a755-f5b4-f6e5-355615a1f06c

  • GET List of Fixtures for a specific Competition competition/competitionId/fixtures

    Returns a list of fixtures for a specific competition

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.ae533484-a755-f5b4-f6e5-355615a1f06cÂÂ
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date

  • GET List of Results for a specific Competition competition/competitionId/results

    Returns a list of results for a specific competition

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.ae533484-a755-f5b4-f6e5-355615a1f06cÂÂ
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date

  • GET List of Statistics for a specific Competition competition/competitionId/statistics

    Returns a list of statistics for a specific competition

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.ae533484-a755-f5b4-f6e5-355615a1f06cÂÂ
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date
    teamId		string	The ID of the team query, e.g.0f0ca30c-fc57-4eed-ff54-62a4aeb1db92ÂÂ
    opposingTeamId		string	The ID of the opposing team query, e.g.26721a38-e81d-e8cb-d33f-bd590ebd85ecÂÂ

  • GET List of Teams for a specific Competition in the current year and future seasons competition/competitionId/team

    Returns a list of Teams for a specific competition in the current year and future seasons

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    competitionId		string	The ID of the required competition, e.g.f0e51504-8adf-dc7b-c80d-9b0df7939c16

• Match

  • List Methods
  • Expand Methods

  • GET Details of a specific Match match/matchId

    Returns the details of a specific match

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    matchId		string	The ID of the required match, e.g.f3c4584a-340f-91c3-0a32-714f798a514aÂÂ

  • GET Line-ups for a specific Match match/matchId/line-ups

    Returns the Line-up for a specific match

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    matchId		string	The ID of the required match, e.g.f3c4584a-340f-91c3-0a32-714f798a514aÂÂ

  • GET Scorecard for a specific Match match/matchId/scorecard

    Returns the Scorecard for a specific match

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    matchId		string	The ID of the required match, e.g.f3c4584a-340f-91c3-0a32-714f798a514aÂÂ

• Team

  • List Methods
  • Expand Methods

  • GET Details of a specific Team team/teamId

    Returns the details of a specific Team

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    teamId		string	The ID of the required team, e.g. 2

  • GET List of Fixtures for a specific Team team/teamId/fixtures

    Returns a List of Fixtures for a specific Team

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    teamId		string	The ID of the required team, e.g. 2
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date

  • GET List of Results for a specific Team team/teamId/results

    Returns a List of Results for a specific Team

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    teamId		string	The ID of the required team, e.g. 2
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date

  • GET List of Statistics for a specific Team team/teamId/statistics

    Returns a List of Statistics for a specific Team

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    teamId		string	The ID of the required team, e.g. 2
    startDate		date	YYYY-MM-DD Format for the Start Date
    endDate		date	YYYY-MM-DD Format for the End Date
    competitionId		string	The ID of the requested competitions, e.g. ae533484-a755-f5b4-f6e5-355615a1f06c
    opposingTeamId		string	The ID of the opposing team query, e.g.26721a38-e81d-e8cb-d33f-bd590ebd85ecÂÂ

• Player

  • List Methods
  • Expand Methods

  • GET Details of a specific Player player/playerId

    Returns a specific player

    Parameter	Value	Type	Description
    Accept	application/xml application/json	string	Output format as JSON or XML
    playerId		string	The ID of the required player

• Country

  • List Methods
  • Expand Methods

  • GET List all Country /v1/racing/country

    Returns a list of all available country

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the country list to items containing the provided string. For example: IRE.

  • GET Details of specific Country /v1/racing/country/countryId

    Returns the details of a specific country

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    countryId		string	The ID of the required country, e.g.8f708753-05ba-11e4-aee5-1c6d1ea457ae

• Course

  • List Methods
  • Expand Methods

  • GET List all Courses /v1/racing/course

    Returns a list of all available courses

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the course list to items containing the provided string. For example: Ponte.
    countryId		string	The ID of the required country, e.g.8f708753-05ba-11e4-aee5-1c6d1ea457ae

  • GET Details of specific Course /v1/racing/course/courseId

    Returns the details of a specific course

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    courseId		string	The ID of the required course, e.g.2b8aa722-11cc-d96b-23cb-99e81aecf395

• Meeting

  • List Methods
  • Expand Methods

  • GET List all Meetings /v1/racing/meeting

    Returns a list of all available meetings

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    countryId		string	The ID of the required country, e.g.8f708753-05ba-11e4-aee5-1c6d1ea457ae
    date		string	The date to search for Meetings

  • GET Details of specific Meeting /v1/racing/meeting/meetingId

    Returns the details of a specific Meeting

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    meetingId		string	The ID of the required meeting, e.g.39de9420-f958-11e4-862e-6ac51dc15c70

• Race

  • List Methods
  • Expand Methods

  • GET Details of race /v1/racing/race/raceId

    Returns the details of a specific race

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    raceId		string	The ID of the required race, e.g. 39e78382-f958-11e4-862e-6ac51dc15c70

  • GET Race commentary /v1/racing/race/raceId/commentary

    Returns the commentary for a specific race

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    raceId		string	The ID of the required race, e.g. f4597dcc-9bdb-11e4-ada2-d7159d179004

• Runner

  • List Methods
  • Expand Methods

  • GET Runner Details /v1/racing/runner/runnerId

    Returns the details of a specific runner

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    runnerId		string	The ID of the runner, e.g.e4bc347a-9c1e-11e4-ada2-d7159d179004

  • GET Runners form /v1/racing/runner/runnerId/form

    Returns the details of a runners form

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    runnerId		string	The ID of the required runner, e4bc347a-9c1e-11e4-ada2-d7159d179004

• Jockey

  • List Methods
  • Expand Methods

  • GET List all Jockeys /v1/racing/jockey

    Returns a list of all available jockeys

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the jockey list to items containing the provided string. For example: McCoy.

  • GET Details of specific Jockey /v1/racing/jockey/jockeyId

    Returns the details of a specific jockey

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    jockeyId		string	The ID of the required jockey, e.g.5cd0f4bc-603f-11e4-b74c-b86ac427c202

• Owner

  • List Methods
  • Expand Methods

  • GET List all Owners /v1/racing/owner

    Returns a list of all available owners

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the owner list to items containing the provided string. For example: Godolphin.

  • GET Details of specific Owner racing/owner/ownerId

    Returns the details of a specific owner

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    ownerId		string	The ID of the required owner, e.g.41fc7830-5f8d-11e4-b04c-da83f7195bdf

• Trainer

  • List Methods
  • Expand Methods

  • GET List all Trainers /v1/racing/trainer

    Returns a list of all available trainers

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the trainer list to items containing the provided string. For example: Roger.

  • GET Details of specific Trainer /v1/racing/trainer/trainerId

    Returns the details of a specific trainer

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    trainerId		string	The ID of the required trainer, e.g.73ffac02-6123-11e4-b04c-da83f7195bdf

• Horse

  • List Methods
  • Expand Methods

  • GET List all Horses /v1/racing/horse

    Returns a list of all available horses

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    query		string	Limit the horse list to items containing the provided string. For example: Job.

  • GET Details of specific Horse /v1/racing/horse/horseId

    Returns the details of a specific horse

    Parameter	Value	Type	Description
    Accept	application/json	string	Output format as JSON
    horseId		string	The ID of the required horse, e.g.ef6c68c8-603b-11e4-b04c-da83f7195bdf

• Root

  • List Methods
  • Expand Methods

  • GET Get Resources /

    Return a collection of available resources. This endpoint is for navigation of the API only.

    Some of the endpoints are not navigable without suppling the required parameters in with the request.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.

• Country

  • List Methods
  • Expand Methods

  • GET Country Collection /country

    Return a collection of countries.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 100
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Country Detail /country/:countryId

    Return the country's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :countryId		integer	The identifier for the country requested.

• Draw

  • List Methods
  • Expand Methods

  • GET Draw Collection /draw

    Return a collection of draws.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    stage		integer	The Stage ID for the draw selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Draw Detail /draw/:drawId

    Return the draw's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :drawId		integer	The identifier for the draw requested.

• Event

  • List Methods
  • Expand Methods

  • GET Event Collection /event

    Return a collection of events. One request parameter is required unless the combination of country and sport is used.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    sport		integer	The Sport ID for the event selection.
    country		integer	The Country ID for the event selection.
    tournament		integer	The Tournament ID for the event selection.
    season		integer	The Season ID for the event selection.
    stage		integer	The stage ID for the event selection.
    start		date	Limit the events to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the events to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 20
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Event Detail /event/:eventId

    Return the event's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :eventId		integer	The identifier for the event requested.

  • GET Event Actions /event/:eventId/actions

    Return the event's actions.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :eventId		integer	The identifier for the event requested.

  • GET Event Composition /event/:eventId/composition

    Return the event composition.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :eventId		integer	The identifier for the event requested.

• Participant

  • List Methods
  • Expand Methods

  • GET Participant Detail /participant/:participantId

    Return the participant's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :participantId		integer	The identifier for the participant requested.

• Season

  • List Methods
  • Expand Methods

  • GET Season Collection /season

    Return a collection of seasons.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    tournament		integer	The Tournament ID for the event selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Season Detail /season/:seasonId

    Return the season's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :seasonId		integer	The identifier for the season requested.

• Sport

  • List Methods
  • Expand Methods

  • GET Sport Collection /sport

    Return a collection of sports.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Sport Detail /sport/:sportId

    Return the standing's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :sportId		integer	The identifier for the sport requested.

• Standing

  • List Methods
  • Expand Methods

  • GET Standing Collection /standing

    Return a collection of standings.

    • One of: sport, tournament, season, stage, participant, event should be supplied

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    start		date	Limit the standings to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the standings to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    sport		integer	The Sport ID for the standings selection.
    tournament		integer	The Tournament ID for the standings selection.
    season		integer	The Season ID for the standings selection.
    stage		integer	The Stage ID for the standings selection.
    event		integer	The Event ID for the standings selection.
    participant		integer	The Participant ID for the standings selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 20
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Standing Detail /standing/:standingId

    Return the standing's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :standingId		integer	The identifier for the standing requested.

• Stage

  • List Methods
  • Expand Methods

  • GET Stage Collection /stage

    Return a collection of stages.

    • At least one of sport or season must be supplied

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    start		date	Limit the stages to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the stages to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    sport		integer	The Sport ID for the stage selection.
    season		integer	The Season ID for the stage selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 50
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Stage Detail /stage/:stageId

    Return the stage's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :stageId		integer	The identifier for the stage requested.

• Tournament

  • List Methods
  • Expand Methods

  • GET Tournament Collection /tournament

    Return a collection of tournaments.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    sport		integer	The Sport ID for the tournament selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 50
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Tournament Detail /tournament/:tournamentId

    Return the tournament's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :tournamentId		integer	The identifier for the tournament requested.

• Venue

  • List Methods
  • Expand Methods

  • GET Venue Detail /venue/:venueId

    Return the venue's details.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :venueId		integer	The identifier for the venue requested.

• Root

  • List Methods
  • Expand Methods

  • GET Get Resources /

    Return a collection of available resources. This endpoint is for navigation of the API only.

    Some of the endpoints are not navigable without suppling the required parameters in with the request.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.

• Country

  • List Methods
  • Expand Methods

  • GET Country Collection /country

    Return a collection of countries.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 100
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Country Detail /country/:countryId

    Return the country's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :countryId		integer	The identifier for the country requested.

• Draw

  • List Methods
  • Expand Methods

  • GET Draw Collection /draw

    Return a collection of draws.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    stage		integer	The Stage ID for the draw selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Draw Detail /draw/:drawId

    Return the draw's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :drawId		integer	The identifier for the draw requested.

• Event

  • List Methods
  • Expand Methods

  • GET Event Collection /event

    Return a collection of events. One request parameter is required unless the combination of country and sport is used.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    sport		integer	The Sport ID for the event selection.
    country		integer	The Country ID for the event selection.
    tournament		integer	The Tournament ID for the event selection.
    season		integer	The Season ID for the event selection.
    stage		integer	The stage ID for the event selection.
    start		date	Limit the events to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the events to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 20
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Event Detail /event/:eventId

    Return the event's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :eventId		integer	The identifier for the event requested.

  • GET Event Actions /event/:eventId/actions

    Return the event's actions.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :eventId		integer	The identifier for the event requested.

  • GET Event Composition /event/:eventId/composition

    Return the event composition.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :eventId		integer	The identifier for the event requested.

• Participant

  • List Methods
  • Expand Methods

  • GET Participant Detail /participant/:participantId

    Return the participant's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :participantId		integer	The identifier for the participant requested.

• Season

  • List Methods
  • Expand Methods

  • GET Season Collection /season

    Return a collection of seasons.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    tournament		integer	The Tournament ID for the event selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Season Detail /season/:seasonId

    Return the season's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :seasonId		integer	The identifier for the season requested.

• Sport

  • List Methods
  • Expand Methods

  • GET Sport Collection /sport

    Return a collection of sports.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 30
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Sport Detail /sport/:sportId

    Return the standing's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :sportId		integer	The identifier for the sport requested.

• Standing

  • List Methods
  • Expand Methods

  • GET Standing Collection /standing

    Return a collection of standings.

    • One of: sport, tournament, season, stage, participant, event should be supplied

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    start		date	Limit the standings to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the standings to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    sport		integer	The Sport ID for the standings selection.
    tournament		integer	The Tournament ID for the standings selection.
    season		integer	The Season ID for the standings selection.
    stage		integer	The Stage ID for the standings selection.
    event		integer	The Event ID for the standings selection.
    participant		integer	The Participant ID for the standings selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 20
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Standing Detail /standing/:standingId

    Return the standing's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :standingId		integer	The identifier for the standing requested.

• Stage

  • List Methods
  • Expand Methods

  • GET Stage Collection /stage

    Return a collection of stages.

    • At least one of sport or season must be supplied

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    start		date	Limit the stages to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    end		date	Limit the stages to ones scheduled before the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd 'YYYY-MM-DD' 'YYYY-MM-DD[T]HH:mm:ssZ' 'YYYY-MM-DD[T]HH:mm:ss.SSSZ' 'YYYY-MM-DD[T]HH:mm:ss' 'YYYY-MM-DD[T]HH:mm' 'now' 'today' 'tomorrow' 'now.plus.n' 'now.minus.n'
    sport		integer	The Sport ID for the stage selection.
    season		integer	The Season ID for the stage selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 50
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Stage Detail /stage/:stageId

    Return the stage's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :stageId		integer	The identifier for the stage requested.

• Tournament

  • List Methods
  • Expand Methods

  • GET Tournament Collection /tournament

    Return a collection of tournaments.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    sport		integer	The Sport ID for the tournament selection.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination. Maximum limit: 50
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Tournament Detail /tournament/:tournamentId

    Return the tournament's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :tournamentId		integer	The identifier for the tournament requested.

• Venue

  • List Methods
  • Expand Methods

  • GET Venue Detail /venue/:venueId

    Return the venue's details.

    Parameter	Value	Type	Description
    Accept	application/json application/xml	string	The response format.
    :venueId		integer	The identifier for the venue requested.

• Platform

  • List Methods
  • Expand Methods

  • GET Platform Collection /platform

    Return a list of available platforms.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    query		string	Search string to query the objects and return matching results.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Platform Detail /platform/:platformId

    Return the content of the selected platform.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :platformId		string	The identifier for the selected platform.

  • GET Platform Region Collection /platform/:platformId/region

    Return a list of regions for a platform.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :platformId		string	The identifier for the selected platform.
    query		string	Search string to query the objects and return matching results.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Channel

  • List Methods
  • Expand Methods

  • GET Channel Collection /channel

    Return a collection of channels.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    platformId		string	The platform ID for the channel selection.
    regionId		string	The platform region ID for the channel selection.
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Channel Detail /channel/:channelId

    Return the content of the selected asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :channelId		string	The identifier for the selected channel.

• Schedule

  • List Methods
  • Expand Methods

  • GET Schedule Collection /schedule

    Return a collection of schedule items. It is required that a request must contain either a channelId or a combination or platformId and RegionId.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    channelId		string	The channel ID for the schedule selection.
    platformId		string	The platform ID for the schedule selection.
    regionId		string	The platform region ID for the channel selection.
    start		date	Limit the schedule to ones scheduled from the selected date provided. For example 2014-04-14. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd yyyy/MM/ddThh:mm now.plus.{nHours?} now.minus.{nHours?} tomorrow
    end		date	Limit the schedule to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd yyyy/MM/ddThh:mm now.plus.{nHours?} now.minus.{nHours?} tomorrow
    assetId		string	A asset ID filter for the schedule collection. This can be a reference to any type of asset i.e. movie, season, series or episode.
    contributorId		string	Filter the schedule items by contributor ID
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Asset

  • List Methods
  • Expand Methods

  • GET Asset Collection /asset

    Return a collection of Assets.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    contributorId		string	Contributor filter for the Assets.
    type		string	Type filter for the assets.i.e episode, movie, season or series
    tag		string	Tag filter for the assets
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Asset Detail /asset/:assetId

    Return the content of the selected asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :assetId		string	The identifier for the selected asset.

  • GET Asset Contributor Collection /asset/:assetId/contributor

    Return a collection of Contributors for given Asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    :assetId		string	The identifier for the selected asset.
    type		string	Type filter for the assets. i.e. cast, director or producer
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Feature

  • List Methods
  • Expand Methods

  • GET Feature Collection /feature

    Return a collection of channels.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    tag		string	Feature tag category
    start		date	Limit the features to ones scheduled from the selected date provided. For example 2014-04-14. The 'end' parameter is typically used in combination with the 'start' param to form a date range.
    end		date	Limit the feature to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Feature Detail /feature/:featureId

    Return the content of the selected feature.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :featureId		string	The identifier for the selected feature.

• Contributor

  • List Methods
  • Expand Methods

  • GET Contributor Collection /contributor

    Return a collection of contributors.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    query		string	Limit the contributor collection to items containing the provided string. For example: Jon
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Contributor Detail /contributor/:contributorId

    Return the content of the selected feature.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :contributorId		string	The identifier for the selected contributor.

• Tag

  • List Methods
  • Expand Methods

  • GET Tag Collection /tag

    Return a collection of Tags.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    query		string	Limit the contributor collection to items containing the provided string. For example: horro
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Platform

  • List Methods
  • Expand Methods

  • GET Platform Collection /platform

    Return a list of available platforms.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    query		string	Search string to query the objects and return matching results.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Platform Detail /platform/:platformId

    Return the content of the selected platform.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :platformId		string	The identifier for the selected platform.

  • GET Platform Region Collection /platform/:platformId/region

    Return a list of regions for a platform.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :platformId		string	The identifier for the selected platform.
    query		string	Search string to query the objects and return matching results.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Channel

  • List Methods
  • Expand Methods

  • GET Channel Collection /channel

    Return a collection of channels.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    platformId		string	The platform ID for the channel selection.
    regionId		string	The platform region ID for the channel selection.
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Channel Detail /channel/:channelId

    Return the content of the selected asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :channelId		string	The identifier for the selected channel.

• Schedule

  • List Methods
  • Expand Methods

  • GET Schedule Collection /schedule

    Return a collection of schedule items. It is required that a request must contain either a channelId or a combination or platformId and RegionId.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    channelId		string	The channel ID for the schedule selection.
    platformId		string	The platform ID for the schedule selection.
    regionId		string	The platform region ID for the channel selection.
    start		date	Limit the schedule to ones scheduled from the selected date provided. For example 2014-04-14. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd yyyy/MM/ddThh:mm now.plus.{nHours?} now.minus.{nHours?} tomorrow
    end		date	Limit the schedule to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range. Formats Supported: yyyy/MM/dd yyyy/MM/ddThh:mm now.plus.{nHours?} now.minus.{nHours?} tomorrow
    assetId		string	A asset ID filter for the schedule collection. This can be a reference to any type of asset i.e. movie, season, series or episode.
    contributorId		string	Filter the schedule items by contributor ID
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Asset

  • List Methods
  • Expand Methods

  • GET Asset Collection /asset

    Return a collection of Assets.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    contributorId		string	Contributor filter for the Assets.
    type		string	Type filter for the assets.i.e episode, movie, season or series
    tag		string	Tag filter for the assets
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Asset Detail /asset/:assetId

    Return the content of the selected asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :assetId		string	The identifier for the selected asset.

  • GET Asset Contributor Collection /asset/:assetId/contributor

    Return a collection of Contributors for given Asset.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    :assetId		string	The identifier for the selected asset.
    type		string	Type filter for the assets. i.e. cast, director or producer
    query		string	Limit the asset collection to items containing the provided string. For example: BBC
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

• Feature

  • List Methods
  • Expand Methods

  • GET Feature Collection /feature

    Return a collection of channels.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    tag		string	Feature tag category
    start		date	Limit the features to ones scheduled from the selected date provided. For example 2014-04-14. The 'end' parameter is typically used in combination with the 'start' param to form a date range.
    end		date	Limit the feature to ones scheduled to the selected date provided. For example: 2014-04-17. The 'end' parameter is typically used in combination with the 'start' param to form a date range.
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Feature Detail /feature/:featureId

    Return the content of the selected feature.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :featureId		string	The identifier for the selected feature.

• Contributor

  • List Methods
  • Expand Methods

  • GET Contributor Collection /contributor

    Return a collection of contributors.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    query		string	Limit the contributor collection to items containing the provided string. For example: Jon
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.

  • GET Contributor Detail /contributor/:contributorId

    Return the content of the selected feature.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format.
    :contributorId		string	The identifier for the selected contributor.

• Tag

  • List Methods
  • Expand Methods

  • GET Tag Collection /tag

    Return a collection of Tags.

    Parameter	Value	Type	Description
    Accept	application/json	string	The response format to return.
    query		string	Limit the contributor collection to items containing the provided string. For example: horro
    limit		integer	Limit the the number of items to be returned per page. For example: 5. The 'limit' parameter is typically used with the 'offset' parameter to facilitate pagination.
    offset		integer	The page offset of the first item to be returned. For example: 2. The 'offset' parameter is typically used with the 'limit' parameter to facilitate pagination.