Jump to: navigation, search


Returns a list of the television service offerings for an area. This request provides an optional argument to limit the response to just the services of a single cable or satellite operator.

Your application should start with this request to get the service ID of the television service you want.


listings/services/postalcode/postalcode/info?apikey=apikey&sig=sig&locale=locale&countrycode=countrycode [&msoid=msoid] [&format=format]

Request Example 1

Request the television service offerings for Beverly Hills 90210.

Request Example 2

Make a second request with the MSO ID to see just the services offered by Dish Network for Beverly Hills 90210.

Request Example 3

Request the television services for Ontario, Canada K1N 6N5.

Request Example 4

Request the television services for Bonn, Germany, with an XML response.

Request Parameters

Sort none.gif  Click to re-sort

Parameter Required Description
apikeyYesAccess code that authorizes your request for data from Rovi.
countrycodeYesCountry served by the television service, stated as the case-sensitive, two-letter country code:
  • AR
  • SV
El Salvador
  • NI
  • AT
  • FI
  • NO
  • BE
  • FR
  • PA
  • BM
  • DE
  • PE
  • BO
  • GT
  • PL
  • BR
  • HN
  • PT
  • CA
  • IE
  • ES
  • CL
  • IT
  • SE
  • CO
  • JM
  • CH
  • CR
Costa Rica
  • LU
  • GB
United Kingdom*
  • DK
  • MX
  • US
United States
  • DO
Dominican Republic 
  • NL
  • VE
  • EC

* Includes Wales, Scotland, and Northern Ireland.

localeYesLanguage and country code of the television service. This is a case-sensitive combination of the ISO 639 language code, a hyphen character, and the ISO 3166 country code, as described in RFC 1766. Valid locales include:
  • da‑DK
Danish, Denmark
  • no‑NO
Norwegian, Norway
  • nl‑BE
Dutch, Belgium
  • pl‑PL
Polish, Poland
  • nl‑NL
Dutch, Netherlands
  • pt‑BR
Portuguese, Brazil
  • en‑BM
English (US), Bermuda
  • pt‑PT
Portuguese, Portugal
  • en‑CA
English (US), Canada
  • es‑AR
Spanish, Argentina
  • en‑IE
English (US), Ireland
  • es‑BO
Spanish, Bolivia
  • en‑JM
English (US), Jamaica
  • es‑CL
Spanish, Chile
  • en‑GB
English (UK), United Kingdom*
  • es‑CO
Spanish, Colombia
  • en‑US
English (US), United States
  • es‑CR
Spanish, Costa Rica
  • fi‑FI
Finnish, Finland
  • es‑DO
Spanish, Dominican Republic
  • fl‑BE
Flemish, Belgium
  • es‑EC
Spanish, Ecuador
  • fr‑BE
French, Belgium
  • es‑SV
Spanish, El Salvador
  • fr‑CA
French, Canada
  • es‑GT
Spanish, Guatemala
  • fr‑FR
French, France
  • es‑HN
Spanish, Honduras
  • fr‑LU
French, Luxembourg
  • es‑MX
Spanish, Mexico
  • fr‑CH
French, Switzerland
  • es‑NI
Spanish, Nicaragua
  • de‑AT
German, Austria
  • es‑PA
Spanish, Panama
  • de‑DE
German, Germany
  • es‑PE
Spanish, Peru
  • de‑LU
German, Luxembourg
  • es‑ES
Spanish, Spain
  • de‑CH
German, Switzerland
  • es‑US
Spanish, United States
  • it‑IT
Italian, Italy
  • es‑VE
Spanish, Venezuela
  • it‑CH
Italian, Switzerland
  • sv‑SE
Swedish, Sweden

* Includes Wales, Scotland, and Northern Ireland.

postalcodeYesFor the U.S. and Canada, the postal code of the coverage area. For other country codes, specify zero. Replace a space in a postal code with a plus (+) or percent20 (%20) symbol.
sigYesA calculated, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
  • Your API key.
  • The secret key you received with your API key.
  • The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

Express the alpha hex digits as lower case.

Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation.

formatNoFormat of the returned data: json or xml. Default is json.
msoidNoID of a cable or satellite operator. Specify an MSO ID to return just the services offered by that operator. Not useful for national or broadcast services.

If you don't know the MSO ID for an operator, first request the list of services in an area and then look through the response for that operator.


Response Header

BuildStringSoftware build version of the API.
EndTimestampDateTimeTime the server finished processing the request.
ErrorsError [ ]Processing errors or warnings.
RequestIdString GUIDA generated value that identifies the request and response.
StatusStatusProcessing status, indicating whether the request was successfully processed.
TimeStampDateTimeTime the server started processing the request.

Response Body

Services Service [ ] The list of television service offerings.

JSON Response Example

Here's the response to Request Example 1, which asks for the television service offerings for Beverly Hills 90210. The response has been edited to reduce the length and formatted with extra spaces and carriage returns to make it easy to read.

Requested with


      "Build":"CPS Phase v9 Build",
               "ServiceClass":"CATV ",
               "Name":"Beverly Hills - Time Warner Cable- Walnut\/Diamond Bar",
               "City":"Beverly Hills",
               "MSO":"Time Warner Cable",
               "SystemName":"Time Warner Cable- Walnut\/Diamond Bar",
               "ServiceClass":"CATV ",
               "Name":"Redondo\/Van Nuys - Time Warner Cable- Walnut\/Diamond Bar",
               "City":"Redondo\/Van Nuys",
               "MSO":"Time Warner Cable",
               "SystemName":"Time Warner Cable- Walnut\/Diamond Bar",
               "ServiceClass":"MATV ",
               "Name":"Beverly Hills - WSNET - Mulholland Estates",
               "City":"Beverly Hills",
               "SystemName":"WSNET - Mulholland Estates",

XML Response Example

Here's the response to Request Example 2, which adds the MSO ID parameter to see just the services offered by Dish Network.

Requested with

<?xml version="1.0" encoding="UTF-8"?>
<GetServicesResult xmlns="">
   <RequestId xmlns="">c990434f-57fc-4458-aa43-87c20ce2cc95</RequestId>
   <TimeStamp xmlns="">2013-07-11T22:40:36.49Z</TimeStamp>
   <Status xmlns="">PNE</Status>
   <Errors xmlns="" />
   <EndTimestamp xmlns="">2013-07-11T22:40:36.506Z</EndTimestamp>
   <Build xmlns="">9.13.6</Build>
      <Service ServiceClass="DBS">
         <Name>Dish Network with Los Angeles Area Channels (Pacific)</Name>
         <City>Los Angeles</City>
         <MSO>Echostar Communications Corp.</MSO>
         <SystemName>Dish Network</SystemName>
      <Service ServiceClass="DBS">
         <Name>Dish Network with Pacific Time Zone Area Channels (Pacific)</Name>
         <City>Pacific Time Zone</City>
         <MSO>Echostar Communications Corp.</MSO>
         <SystemName>Dish Network</SystemName>

Error Codes

1001 Core_MandatoryFieldMissing A mandatory parameter is not specified.
10603 LookupService_InvalidLocale The locale specified in the request is invalid.

See Also

↑ Top

Personal tools