Stations airings

/stations/:stationId/airings

Return schedule and associated program metadata for a single station for a maximum period of 14 days. Schedule information can be requested up to 14 days in advance.

Request Parameters

Parameter

Mandatory?

Description

stationId

Yes

StationId, which can be retrieved by calling /lineups/:lineupId/channels API.

lineupId

No

LineupId, which can be retrieved by calling /lineups API.
If omitted, channel numbers will not be returned in response data.

startDateTime

Yes

DateTime to begin grid information, specified in ISO 8601 format.
Must be no more than 14 days after current dateTime.
See DateTime documentation for tips on formatting.

endDateTime

No

DateTime to end grid information, specified in ISO 8601 format.
Must be no more than 14 days after current dateTime.
If not specified, defaults to 3 hours after current dateTime.
See DateTime documentation for tips on formatting.

imageSize

No

Small, medium, large, master sizes are available.
Valid values are: Sm, Md, Lg, Ms. See Image Sizing for details.
If not specified, defaults to Md.
If requested image size is not available, generic image will be returned.

imageAspectTV

No

Requested aspect ratio (horizontal by vertical) for TV show images
Valid values are: 2x3, 3x4, 4x3, 16x9
If not specified, defaults to 2x3
If requested aspect ratio is not available, generic image will be returned.

imageText No

Boolean indicating preference for program image types with text (banners) or without text (iconics). If requested preference is not available, image selection will continue to next type (banner/iconic), before finally returning generic if no image found. Defaults to true for text preference.

api_key

Yes

24-character key obtained during application registration

Response Body

Response

Type

Description

Station airings

Airing [ ]

Collection of schedule and program metadata

Sample Request

Return program schedule information for specified station and time range.

http://data.tmsapi.com/v1.1/stations/10161/airings?startDateTime=2015-02-20T00:00Z&api_key=1234567890

Sample Response

[
  {
    "startTime":"2015-02-19T23:00Z",
    "endTime":"2015-02-20T01:00Z",
    "duration":120,
    "qualifiers":["Stereo"],
    "program":{
      "tmsId":"SH018079070000",
      "rootId":"10261471",
      "seriesId":"10261471",
      "subType":"Special",
      "title":"Key Capitol Hill Hearings",
      "releaseYear":2013,
      "releaseDate":"2013",
      "origAirDate":"2013-09-24",
      "titleLang":"en",
      "descriptionLang":"en",
      "entityType":"Show",
      "genres":[ "Special", "Politics"],
      "longDescription":"Speeches from policy makers and coverage from around the country.",
      "shortDescription":"Speeches from policy makers and coverage from around the country.",
      "preferredImage":{
        "width":"240",
        "height":"360",
        "uri":"assets/p10261471_b_v5_aa.jpg",
        "category":"Banner-L3",
        "text":"yes",
        "primary":"true"
      }
    },
    "station":{
      "stationId":"10161",
      "callSign":"CSPAN",
      "preferredImage":{
        "width":"360",
        "height":"270",
        "uri":"h3/NowShowing/10161/s10161_h3_aa.png",
        "category":"Logo", "primary":"true"
      }
    }
  }
]

Docs Navigation