Every API here is available over the APIs.io API and to AI agents over MCP.
{
"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)."
},
{
# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gracenote/refs/heads/main/openapi/gracenote-onconnect-lookup-apis-openapi.json