{ "openapi": "3.1.1", "info": { "title": "OnConnect Lookup APIs v1.1", "description": "\n\n**Note:** The OnConnect API returns JSON responses. For additional response examples, see the [OnConnect documentation](/video/on-connect-lookup-apis/index).", "version": "1.1" }, "servers": [ { "url": "/proxy/onconnect" } ], "paths": { "/v1.1/movies/showings": { "get": { "summary": "Movies Playing in Local Theatres", "description": "Returns a list of all movies currently playing in local theatres, with showtimes.", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Start date (yyyy-mm-dd). Schedules available starting with current day." }, { "name": "numDays", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Number of schedule days. Defaults to 1." }, { "name": "zip", "in": "query", "required": false, "schema": { "type": "string", "default": "78701" }, "description": "US zip code or Canadian postal code. Must supply either zip or coordinates." }, { "name": "lat", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates." }, { "name": "lng", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates." }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km)." }, { "name": "units", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "mi", "km" ] }, "description": "Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/newShowAirings": { "get": { "summary": "New Shows Airing on TV", "description": "Returns all shows and episodes and associated metadata airing new (or live) on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeAdult", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include adult TV shows in response. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/{sportsId}/events/airings": { "get": { "summary": "Airings of Sports Events", "description": "Returns live sports events and associated metadata for a list of sports that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "sportsId", "in": "path", "required": true, "schema": { "type": "string", "default": "58,59" }, "description": "A comma-separated list of sports genre ids (e.g., 58 for baseball, 59 for basketball) or 'all' to return airings for all sports." }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "liveOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to only include live events. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/movies/airings": { "get": { "summary": "All Movies Airing on TV", "description": "Returns movies and associated metadata that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.", "tags": [ "Movies on TV" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeAdult", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include adult TV shows in response. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Optional filter based on specified description language. If not specified, all movies airings returned." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/lineups": { "get": { "summary": "Find Lineups", "description": "Returns a list of lineups for a country and postal code.", "tags": [ "Lineups" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "default": "USA", "enum": [ "", "-", "USA", "CAN", "-", "-", "AUS", "-", "-", "AUT", "BEL", "CHE", "DEU", "DNK", "ESP", "FIN", "FRA", "GBR", "IRL", "ITA", "NLD", "NOR", "POL", "SWE", "-", "-", "ARG", "BLZ", "BRA", "CHL", "COL", "CRI", "ECU", "GTM", "GUY", "HND", "MEX", "PAN", "PER", "URY", "VEN", "-", "-", "AIA", "ATG", "ABW", "BHS", "BRB", "BMU", "BES", "VGB", "CYM", "CUW", "DMA", "DOM", "GRD", "JAM", "PRI", "MAF", "VCT", "KNA", "LCA", "TTO", "TCA" ] }, "description": "Country code. See [here](http://developer.tmsapi.com/docs/read/data_v1_1/lineups/Lineups_by_postal_code#validCountryValues) for list of countries currently available. If not specified, defaults to USA." }, { "name": "postalCode", "in": "query", "required": true, "schema": { "type": "string", "default": "78701" }, "description": "Postal Code. See [International Lineups](http://developer.tmsapi.com/docs/read/data_v1_1/International_Lineups) for more information." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/lineups/{lineupId}": { "get": { "summary": "Lineup Details", "description": "Returns details for a given lineup.", "tags": [ "Lineups" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "path", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/lineups/{lineupId}/channels": { "get": { "summary": "Lineup Channel List", "description": "Returns a list of stations and channel positions associated with the lineup provided.", "tags": [ "Lineups" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "path", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "enumerated", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "enhancedCallSign", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether or not to include display-friendly call signs in the results. Defaults to false." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/lineups/{lineupId}/grid": { "get": { "summary": "Lineup Airings (TV Grid)", "description": "Returns schedule airing and associated program metadata for a lineup to be contained within a TV grid. Allows for up to 6 hours of schedule metadata for a given date up to 14 days in advance.", "tags": [ "Lineups" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "path", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "stationId", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Station ID. Multiple stations accepted, comma-separated." }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)" }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "size", "in": "query", "required": false, "schema": { "type": "enumerated", "default": "", "enum": [ "", "Basic", "Detailed", "DetailedNoImage" ] }, "description": "Amount of program metadata to be returned in TV grid. The default value is Detailed. For smaller response size, use Basic or DetailedNoImage." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "excludeChannels", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Optional comma-delimited list of channel types to exclude from grid. Valid values are: nonhd, music, ppv, adult, premium." }, { "name": "enhancedCallSign", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether or not to include display-friendly call signs in the results. Defaults to false." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/stations/search": { "get": { "summary": "Station Search", "description": "Returns TV Station metadata with text matching the given name or call sign.", "tags": [ "Stations" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "default": "" }, "description": "Query string." }, { "name": "queryFields", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Comma-separated list of station fields to search. Valid values are callsign and name. Do not include spaces in list." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "The maximum number of results to be returned from the query. Valid values are between 1 and 50. Default is 10." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Zero-based offset index on the result set. Used in conjunction with limit to page through results. For example, offset=10 will set response data to begin with 11th hit." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/stations/{stationId}": { "get": { "summary": "Station Details", "description": "Returns details for a single station. *Available with R&D/Commercial plans only.", "tags": [ "Stations" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "stationId", "in": "path", "required": true, "schema": { "type": "string", "default": "10359" }, "description": "Station ID" }, { "name": "lineupId", "in": "query", "required": false, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID. If not provided, channel numbers will not be included in the response." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium). Only small and medium logos available for stations." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/stations/{stationId}/airings": { "get": { "summary": "Station Airings", "description": "Returns airings schedule and associated program metadata for a single station for a given time period over the next 14 days.", "tags": [ "Stations" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "stationId", "in": "path", "required": true, "schema": { "type": "string", "default": "10359" }, "description": "Station ID" }, { "name": "lineupId", "in": "query", "required": false, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID. If not provided, channel numbers will not be included in the response." }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/search": { "get": { "summary": "Program Search", "description": "Returns basic program metatdata based on free-form search criteria.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "default": "" }, "description": "Query string." }, { "name": "queryFields", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Comma-separated list of fields in which the search string is queried against. Valid fields are title, cast, genres, and directors. Do not include spaces in list." }, { "name": "entityType", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Comma-separated list of program types to search. Valid values are movie, episode, sports, show. Do not include spaces in list." }, { "name": "genres", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Filter results by the specified comma-separated list of genres. See Program Genres method for available genres." }, { "name": "subType", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Filter results by the specified program subType." }, { "name": "includeAdult", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include programs with 'Adults Only' genre in response. Defaults to false." }, { "name": "titleLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, en-AU=Australian English pt-BR=Brazilian Portugese)" }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified description language, using IETF language tags." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "The maximum number of results to be returned from the query. Valid values are between 1 and 50. Default is 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Zero-based offset index on the result set. Used in conjunction with limit to page through results. For example, offset=10 will set response data to begin with 11th hit." }, { "name": "lineupId", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Lineup ID. If specified, response will include only programs found in the schedule and list their airings under each program summary. If not specified, all programs matching the query will be returned, and no airings will be listed." }, { "name": "startDateTime", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Date/Time to start from (ISO 8601). Defaults to start of current hour. Only used when lineupId is specified. Example: 2013-03-05T22:00Z" }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Date/Time to end on (ISO 8601). If not specified, airings will be shown chronologically from the startDateTime, up to the maximum of 50 per program. Only used when lineupId is specified." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/{tmsId}": { "get": { "summary": "Program Details", "description": "Returns detailed metadata for any program (Movie, Show, Episode, or Sports) referred to by a given TMS ID or TMS root ID.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "tmsId", "in": "path", "required": true, "schema": { "type": "string", "default": "SH006883590000" }, "description": "TMS ID or TMS root ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/{tmsId}/airings": { "get": { "summary": "Program Airings", "description": "Returns all airings of a specific program for a given lineup and time period up to 14 days in advance.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "tmsId", "in": "path", "required": true, "schema": { "type": "string", "default": "SH006883590000" }, "description": "TMS ID" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeDetail", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include detailed program metadata with each airing. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/newShowsLastWeek": { "get": { "summary": "New Shows that Aired in Last Week", "description": "Returns all shows and episodes and associated metadata that aired new (or live) for given past dates up to 7 days. *Available with R&D/Commercial plans only.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Date to start (yyyy-mm-dd)." }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "date", "default": "" }, "description": "Date to end (yyyy-mm-dd). Defaults to startDate." }, { "name": "includeAdult", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include adult TV shows in response. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/advancePlanner": { "get": { "summary": "Advance Planner", "description": "Returns a list of notable TV programming and associated metadata due to air at future date. *Available with R&D/Commercial plans only.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Date to start (yyyy-mm-dd)." }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "date", "default": "" }, "description": "Date to end (yyyy-mm-dd). Defaults to 31 days after startDate." }, { "name": "eventCode", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11" ] }, "description": "Comma-separated list corresponding to selected event type codes. Default will return all types." }, { "name": "titleLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)" }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Preference for description language to be returned. If specified descriptionLang not found for series, reverts to primary TMS ID for series." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the images to be returned. If not specified, images in all available sizes will be returned." }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the images to be returned. Only applies to TV content. If not specified, images in all available aspect ratios will be returned." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/{resourceId}/images": { "get": { "summary": "All Program Images", "description": "Returns all available images associated with a program. *Available with R&D/Commercial plans only.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string", "default": "SH006883590000" }, "description": "tmsId or rootId for program" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "If specified, only images in selected size will be included. Default will return all available image sizes." }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "If specified, only images in selected aspect ratio will be included. Only applies to TV content. Default will return images in all available aspect ratios." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating filter for image types with or without text. If not specified, will return all image types." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/programs/genres": { "get": { "summary": "Program Genres", "description": "Returns a list of program genres, to be used in conjunction with Program Search. Note: language parameter deprecated in v1.1.", "tags": [ "Programs" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/series/{seriesId}": { "get": { "summary": "Series Details", "description": "Returns detailed metadata for a given series.", "tags": [ "Series" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "seriesId", "in": "path", "required": true, "schema": { "type": "string", "default": "185044" }, "description": "Series ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "titleLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)" }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Preference for description language to be returned. If specified descriptionLang not found for series, reverts to primary TMS ID for series." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/series/{seriesId}/airings": { "get": { "summary": "Series Airings", "description": "Returns all airings of a series for a given lineup and time period up to 14 days in advance.", "tags": [ "Series" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "seriesId", "in": "path", "required": true, "schema": { "type": "string", "default": "185044" }, "description": "Series ID" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeDetail", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include detailed program metadata with each airing. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Optional filter based on specified description language. If not specified, all series airings returned." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/series/{seriesId}/episodes": { "get": { "summary": "Series Episodes", "description": "Returns episodes of a series, sorted by season and episode numbers. If limit/offset parameters not provided, will return up to maximum of 100 episodes. If limit/offset parameters provided, response will be wrapped in object with hitCount (total number of episodes) for paging.", "tags": [ "Series" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "seriesId", "in": "path", "required": true, "schema": { "type": "string", "default": "185044" }, "description": "Series ID" }, { "name": "season", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Season number. If not specified, will return episodes from all seasons." }, { "name": "size", "in": "query", "required": false, "schema": { "type": "enumerated", "default": "", "enum": [ "", "Basic", "Detailed" ] }, "description": "Amount of program metadata to be returned for episodes. The default value is Detailed. For smaller response size, use Basic." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "default": "50" }, "description": "The maximum number of results to be returned from the query. Default is 100." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "default": "0" }, "description": "Zero-based offset index on the result set. Used in conjunction with limit to page through results. For example, offset=10 will set response data to begin with 11th hit." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "titleLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified title language (e.g., en=English, es=Spanish, en-GB=British English, pt-BR=Brazilian Portugese)" }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Set preference for description language to be returned. If specified descriptionLang not found for episode, reverts to primary TMS ID for episode." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/movies/{rootId}/versions": { "get": { "summary": "Movie Versions", "description": "Returns all versions of a given movie. *Available with R&D/Commercial plans only.", "tags": [ "Movies on TV" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "rootId", "in": "path", "required": true, "schema": { "type": "string", "default": "3542039" }, "description": "Movie Root ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Filter results based on the specified description language. When not specified, returns English versions, or if no English descriptions available, returns versions with descriptionLang of primary TMS ID." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/movies/{rootId}/airings": { "get": { "summary": "Movie Airings", "description": "Returns all airings of a movie for a given lineup and time period up to 14 days in advance.", "tags": [ "Movies on TV" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "rootId", "in": "path", "required": true, "schema": { "type": "string", "default": "169874" }, "description": "Movie Root ID" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeDetail", "in": "query", "required": false, "schema": { "type": "boolean", "default": "true", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include detailed movie metadata with each airing. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "da", "de", "en", "en-GB", "en-AU", "es", "fi", "fr", "fr-CA", "it", "nl", "no", "pt", "pt-BR", "sv" ] }, "description": "Optional filter based on specified description language. If not specified, all airings of movie returned." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/theatres": { "get": { "summary": "Find Theatres", "description": "Returns a list of theatres for a given zip/postal code or coordinates.", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "zip", "in": "query", "required": false, "schema": { "type": "string", "default": "78701" }, "description": "US zip code or Canadian postal code. Must supply either zip or coordinates." }, { "name": "lat", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates." }, { "name": "lng", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates." }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km)." }, { "name": "units", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "mi", "km" ] }, "description": "Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles." }, { "name": "numTheatres", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Maximum number of theatres to return. If not specified, response will include max 100 theatres within specified radius." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/theatres/{theatreId}": { "get": { "summary": "Theatre Details", "description": "Returns details for a specified theatre. *Available with R&D/Commercial plans only.", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "theatreId", "in": "path", "required": true, "schema": { "type": "string", "default": "8749" }, "description": "Theatre ID." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/theatres/{theatreId}/showings": { "get": { "summary": "Theatre Showtimes", "description": "Returns a list of all movies and showtimes at a theatre for a given day(s).", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "theatreId", "in": "path", "required": true, "schema": { "type": "date", "default": "8749" }, "description": "Theatre ID." }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Start date (yyyy-mm-dd). Schedules available starting with current day." }, { "name": "numDays", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Number of schedule days. Defaults to 1." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/movies/{movieId}/showings": { "get": { "summary": "Movie Showtimes (single movie)", "description": "Returns movie metadata and theatre/showtimes information for a specified movie.", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "movieId", "in": "path", "required": true, "schema": { "type": "date", "default": "MV005298400000" }, "description": "tmsId or rootId." }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Start date (yyyy-mm-dd). Schedules available starting with current day." }, { "name": "numDays", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Number of schedule days. Defaults to 1." }, { "name": "zip", "in": "query", "required": false, "schema": { "type": "string", "default": "78701" }, "description": "US zip code or Canadian postal code. Must supply either zip or coordinates." }, { "name": "lat", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Latitude coordinate. Valid values are between -90 and 90. Must supply either zip or coordinates." }, { "name": "lng", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Longitude coordinate. Valid values are between -180 and 180. Must supply either zip or coordinates." }, { "name": "radius", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Range to search from initial location. Defaults to 5 miles. Maximum 100 mi (160 km)." }, { "name": "units", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "mi", "km" ] }, "description": "Unit of measurement for the radius parameter as well as the distance value in response. Defaults to miles." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/movies/futureReleases": { "get": { "summary": "Future Releases", "description": "Returns a list of movies and associated metadata being released on a given date provided and up to 6 months into the future. *Available with R&D/Commercial plans only.", "tags": [ "Movies in Theatres" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "releaseDate", "in": "query", "required": true, "schema": { "type": "date", "default": "" }, "description": "Start date (yyyy-mm-dd). Can be up to 7 days prior to current date." }, { "name": "numDays", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Number of days to search. Defaults to 60. Maximum 180." }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "USA", "CAN" ] }, "description": "Returns releases for specified country (USA or CAN). Defaults to USA." }, { "name": "titleLang", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Filter results based on the specified title language (e.g., en=English). If not specified, defaults to en." }, { "name": "descriptionLang", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Filter results based on the specified description language (e.g., es=Spanish). If not specified, defaults to en." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageText", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text)." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/{sportsId}": { "get": { "summary": "Sports with Optional Organizations", "description": "Returns all (or specified) sports with associated organizations.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "sportsId", "in": "path", "required": true, "schema": { "type": "string", "default": "all" }, "description": "A comma-separated list of sports genre ids (e.g., \"59\" for Basketball) or 'all' for all sports." }, { "name": "includeOrg", "in": "query", "required": false, "schema": { "type": "boolean", "default": "", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include organization metadata. Defaults to false." }, { "name": "officialOrg", "in": "query", "required": false, "schema": { "type": "boolean", "default": "false", "enum": [ "", "true", "false" ] }, "description": "If true, results are filtered to include only official organizations. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/{sportsId}/non-events/airings": { "get": { "summary": "Airings of Sports Non-Events", "description": "Returns sports non-events (talk shows) and taped events (classic games, early morning replays, etc.) for a list of sports that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "sportsId", "in": "path", "required": true, "schema": { "type": "string", "default": "58,59" }, "description": "A comma-separated list of sports genre ids (e.g., 58 for baseball, 59 for basketball) or 'all' to return airings for all sports." }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/universities": { "get": { "summary": "All Universities", "description": "Returns a list of all universities.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/organizations/{organizationId}": { "get": { "summary": "Teams in an Organization", "description": "Returns a list of all teams associated with specified organizations. *Available with R&D/Commercial plans only.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "default": "17,19" }, "description": "A comma-separated list of organization IDs (e.g., 17 for MLB, 19 for NBA)" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/universities/{universityId}": { "get": { "summary": "Teams at a University", "description": "Returns a list of all teams associated with specified universities. *Available with R&D/Commercial plans only.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "universityId", "in": "path", "required": true, "schema": { "type": "string", "default": "1" }, "description": "A comma-separated list of university IDs, or 'all' for entire list of universities and teams." }, { "name": "includeTeam", "in": "query", "required": false, "schema": { "type": "boolean", "default": "true", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include organization metadata. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/teams/{teamBrandId}": { "get": { "summary": "Team Details", "description": "Returns details for a specified team. *Available with R&D/Commercial plans only.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "teamBrandId", "in": "path", "required": true, "schema": { "type": "string", "default": "1" }, "description": "A comma-separated list of team IDs." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/teams/{teamBrandId}/airings": { "get": { "summary": "Team Airings", "description": "Returns airings for specified teams. *Available with R&D/Commercial plans only.", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "teamBrandId", "in": "path", "required": true, "schema": { "type": "string", "default": "28,425" }, "description": "A comma-separated list of teamBrandIds to return airings." }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeDetail", "in": "query", "required": false, "schema": { "type": "boolean", "default": "true", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include detailed program metadata with each airing. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/sports/organizations/{organizationId}/airings": { "get": { "summary": "Organization Airings", "description": "Returns airings for specified organizations (e.g., MLB, NBA, NFL).", "tags": [ "Sports" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "default": "17,19" }, "description": "A comma-separated list of organizationIds to return airings (e.g., 17 for MLB, 19 for NBA)" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "includeDetail", "in": "query", "required": false, "schema": { "type": "boolean", "default": "true", "enum": [ "", "true", "false" ] }, "description": "Boolean indicating whether to include detailed program metadata with each airing. Defaults to false." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/celebs/{personId}": { "get": { "summary": "Celebrity Details", "description": "Returns details for a given celebrity.", "tags": [ "Celebrities" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "personId", "in": "path", "required": true, "schema": { "type": "string", "default": "13461" }, "description": "Person ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/celebs/{personId}/airings": { "get": { "summary": "Airings of Celebrities", "description": "Returns all airings of a given celebrity and given time period over the next 14 days.", "tags": [ "Celebrities" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "personId", "in": "path", "required": true, "schema": { "type": "string", "default": "87269" }, "description": "Person ID" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/celebs/talkShowAirings": { "get": { "summary": "Celebrities Appearing on Talk Shows by Day", "description": "Returns a list of celebrities and associated metadata that are appearing on a talk show on a lineup for a given time period up to 24 hours in length and up to 14 days in advance. *Available with R&D/Commercial plans only.", "tags": [ "Celebrities" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "lineupId", "in": "query", "required": true, "schema": { "type": "string", "default": "USA-TX42500-X" }, "description": "Lineup ID" }, { "name": "startDateTime", "in": "query", "required": true, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to start from (ISO 8601)." }, { "name": "endDateTime", "in": "query", "required": false, "schema": { "type": "dateTime", "default": "" }, "description": "Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours." }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "Size of the image referenced by the preferred image URI returned. The default value is Md (medium)" }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "Aspect ratio of the image referenced by the preferred image URI returned. Only applies to TV content. The default value is 2x3." }, { "name": "market", "in": "query", "required": false, "schema": { "type": "string", "default": "" }, "description": "Outputs source provided imagery that is specific to a certain country, if available." } ], "responses": { "200": { "description": "Successful response" } } } }, "/v1.1/celebs/{personId}/images": { "get": { "summary": "All Celebrity Images", "description": "Returns all available images associated with a celebrity. *Available with R&D/Commercial plans only.", "tags": [ "Celebrities" ], "parameters": [ { "$ref": "#/components/parameters/ApiKeyQuery" }, { "name": "personId", "in": "path", "required": true, "schema": { "type": "string", "default": "87269" }, "description": "Person ID" }, { "name": "imageSize", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "Sm", "Md", "Lg", "Ms" ] }, "description": "If specified, only images in selected size will be included. Default will return all available image sizes." }, { "name": "imageAspectTV", "in": "query", "required": false, "schema": { "type": "string", "default": "", "enum": [ "", "2x3", "3x4", "4x3", "16x9" ] }, "description": "If specified, only images in selected aspect ratio will be included. Only applies to TV content. Default will return images in all available aspect ratios." } ], "responses": { "200": { "description": "Successful response" } } } } }, "components": { "parameters": { "ApiKeyQuery": { "name": "api_key", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API key for authentication" } } } }