NHK番組表APIについて

APIの説明のページです。最終版では動的サンプルの予定です。
各番組表APIのご利用方法については該当する番組表APIをクリックすると表示されます。

  •  地域、サービス、日付を指定することで、該当する条件の番組リストを取得することが可能です。
  • Resource URL
  • http://api.nhk.or.jp/v1/pg/list/:area/:service/:date.json?key=:apikey
  • Resource Infomation
  • 項目 説明
    リクエスト制限 あり
    認証 APIキーによる認証
    HTTP メソッド GET
    レスポンスフォーマット json
    レスポンスオブジェクト List
    API バージョン v1
    利用回数制限 300回/日
  • Request Parameters
  •  パラメータ名およびパラメータ値は大文字小文字を区別します。
  • パラメータ 必須 説明 値の例
    area 地域ID(3byte)。 130
    service サービスID (2byte)。 g1
    date 日付(YYYY-MM-DD形式、当日/翌日を指定) 2013-04-01
    apikey APIキー(32byte)。 X6LOhdsSX...
  • Example Request
  • GET http://api.nhk.or.jp/v1/pg/list/130/g1/2013-04-01.json?key=_ENTER_YOUR_KEY_
  • 1.   {

    2.      "list" :[

    3.       {

    4.         "id" : "2013040156789" ,

    5.         " event_id" : "56789" ,

    6.         " start_time " : "2013-04-01T19:00:00+09:00" ,

    7.         " end_time" : "2013-04-01T19:30:00+09:00" ,

    8.         "area" :

    9.          {

    10.          " area_id" : "130" ,

    11.          " area_name" : "東京" ,

    12.        }

    13.         "service_" :

    14.        {

    15.          " service_id" : "g1" ,

    16.          " service_name" : " NHK総合1 " ,

    17.          " service_logo_s" :

    18.          {

    19.            " logo_url" : "http://api.nhk.or.jp/common/ img /service_/gtv-100x50.png" ,

    20.            " logo_width" : "100" ,

    21.            " logo_height" : "50"

    22.          },

    23.          " service_logo_m" : { },

    24.          " service_logo_l" : { }

    25.        },

    26.        "title" : " NHKニュース7 ",

    27.        "subtitle": " ▽経済財政諮問会議が3年半ぶりに復活開催【キャスター】武田真一,【サブキャスター】久保田祐佳,【気象キャスター】岡村真美子 "

    28.     },

    29.     {

    30.      "id" : "2013040167895" ,

    31.      " event_id" : "67895",

    32.      " start_time " : "2013-04-01T19:30:00+09:00" ,

    33.      " end_time" : "2013-04-01T19:58:00+09:00" ,

    34.      "area" : { },

    35.      "service" : { },

    36.      "title" : " クローズアップ現代「アスリートごはん~最新科学が支える究極の食~」" ,

    37.      "subtitle" : " 最新科学に裏付けられたアスリートのための食事が大きな注目を集めている。その研究成果は筋力の衰えた高齢者にまで応用され始めた。究極のアスリートごはんの秘密に迫る。"

    38.     },

    39.     {

    40.    …

    41.     }

    42.   ]

    43. }

  • Error
  •   Program List APIは番組表APIに共通のエラーメッセージおよびコードを返します。
  •  地域、ジャンル、日付を指定することで、該当する条件の番組リストを取得することが可能です。
  • Resource URL
  • http://api.nhk.or.jp/v1/pg/genre/:area/:genre/:date.json?key=:apikey
  • Resource Infomation
  • 項目 説明
    リクエスト制限 あり
    認証 APIキーによる認証
    HTTP メソッド GET
    レスポンスフォーマット json
    レスポンスオブジェクト List
    API バージョン v1
    利用回数制限 300回/日
  • Request Parameters
  •  パラメータ名およびパラメータ値は大文字小文字を区別します。
  • パラメータ 必須 説明 値の例
    area 地域ID(3byte)。 260
    genre ジャンルID (4byte)。 0002
    date 日付(YYYY-MM-DD形式、当日/翌日を指定) 2013-04-01
    apikey APIキー(32byte)。 X6LOhdsSX...
  • Example Request
  • GET http://api.nhk.or.jp/v1/pg/genre/260/0002/2013-04-01.json?key=_ENTER_YOUR_KEY_
  • 1.  {

    2.     "list" :[

    3.      {

    4.       "id" : "2013040167895",

    5.       "event_id" : "67895" ,

    6.       "start_time " : "2013-04-01T19:30:00+09:00" ,

    7.       "end_time" : "2013-04-01T19:58:00+09:00" ,

    8.       "area" :

    9.       {

    10.         "area_id" : "206" ,

    11.         "area_name" : "京都" ,

    12.      },

    13.       "service" : { },

    14.       "title" : " クローズアップ現代「アスリートごはん~最新科学が支える究極の食~」 " ,

    15.       "subtitle" : " 最新科学に裏付けられたアスリートのための食事が大きな注目を集めている。その研究成果は筋力の衰えた高齢者にまで応用され始めた。究極のアスリートごはんの秘密に迫る。 " ,

    16.      "genres" :

    17.       [

    18.        "0002" ,

    19.        "0800"

    20.       ]

    21.     },

    22.     {

    23.    …

    24.     }

    25.   ]

    26. }

  • Error
  • Program Genre APIは番組表APIに共通のエラーメッセージおよびコードを返します。
  •  番組IDを指定することで、該当する番組の詳細情報を取得することが可能です。
  • Resource URL
  • http://api.nhk.or.jp/v1/pg/info/:area/:id.json?key=:apikey
  • Resource Infomation
  • 項目 説明
    リクエスト制限 あり
    認証 APIキーによる認証
    HTTP メソッド GET
    レスポンスフォーマット json
    レスポンスオブジェクト Description
    API バージョン v1
    利用回数制限 300回/日
  • Request Parameters
  •  パラメータ名およびパラメータ値は大文字小文字を区別します。
  • パラメータ 必須 説明 値の例
    area 地域ID(3byte)。 130
    id 番組ID(13byte)。 2013040156789
    apikey APIキー(32byte)。 X6LOhdsSX...
  • Example Request
  • GET http://api.nhk.or.jp/v1/pg/info/130/2013010656789.json?key=_ENTER_YOUR_KEY_
  • 1.     {

    2.     "id" : "2013010656789" ,

    3.     "event_id" : "56789" ,

    4.     "start_time " : "2013-01-06T20:00:00+09:00" ,

    5.     "end_time" : "2013-01-06T21:15:00+09:00" ,

    6.     "area" :

    7.       {

    8.         "area_id" : "130" ,

    9.         "area_name" : "東京" ,

    10.      },

    11.     "service_" :

    12.     {

    13.       "service_id" : "g1" ,

    14.       "service_name" : " NHK総合1 " ,

    15.      "service_logo_s" :

    16.      {

    17.        "logo_url" : "http://api.nhk.or.jp/common/img/service_/gtv-100x50.png" ,

    18.        "logo_width" : "100" ,

    19.        "logo_height" : "50"

    20.      },

    21.      "service_logo_m" : { },

    22.      "service_logo_l" : { }

    23.    },

    24.    "title " : " 八重の桜(1)<新>「ならぬことはならぬ」 " ,

    25.    "subtitle" : " 山本八重(鈴木梨央)は会津藩砲術指南の娘。男勝りで父(松重豊)や母(風吹ジュン)も手を焼く。兄(西島秀俊)に憧れて砲術を習いたがるが、父から厳しく一蹴される。 " ,

    26.    "genres" :

    27.    [

    28.      "0300" ,

    29.      "0302"

    30.    ] ,

    31.    "program_logo " : "http://api.nhk.or.jp/common/img/program/2031.png" ,

    32.    "urls" :

    33.    {

    34.      "program_url" : "http://nhk.jp/yaenosakura"

    35.   } ,

    36.    "hashtags" :

    37.    [

    38.      "# 八重の桜 " ,

    39.      "#nhkgtv"

    40.    ]

    41. }

  • Error
  • Program Info APIは番組表APIに共通のエラーメッセージおよびコードを返します。
  •  地域、サービスを指定することで、現在提供している番組を取得することが可能です。
  • Resource
  • http://api.nhk.or.jp/v1/pg/now/:area/:service_.json?key=:apikey (各サービスを指定する場合)
    http://api.nhk.or.jp/v1/pg/now/:area/tv.json?key=:apikey (テレビを指定する場合)
    http://api.nhk.or.jp/v1/pg/now/:area/radio.json?key=:apikey (ラジオを指定する場合)
    http://api.nhk.or.jp/v1/pg/now/:area/all.json?key=:apikey (全サービスを指定する場合)
  • Resource Infomation
  • 項目 説明
    リクエスト制限 あり
    認証 APIキーによる認証
    HTTP メソッド GET
    レスポンスフォーマット json
    レスポンスオブジェクト NowOnAir or NowOnAirList
    API バージョン v1
    利用回数制限 1500回/日
  • Request Parameters
  •  パラメータ名およびパラメータ値は大文字小文字を区別します。
  • パラメータ 必須 説明 値の例
    area 地域ID(3byte)。 130
    service   サービスID (2byte)。 g1
    apikey APIキー(32byte)。 X6LOhdsSX...
  • Example Request
  • GET http://api.nhk.or.jp/v1/pg/now/140/g1.json?key=_ENTER_YOUR_KEY_
  • (service_idの場合)

    1.  {

    2.    "previous":

    3.    {

    4.      "id": "2013040123456",

    5.      "event_id": "23456",

    6.      "start_time": "2013-04-01T18:52:00+09:00",

    7.      "end_time": "2013-04-01T19:00:00+09:00",

    8.      "service": { },

    9.      "title": "気象情報",

    10.     "subtitle": "",

    11.     "genres":

    12.     [

    13.       "0300",

    14.       "0302"

    15.     ]

    16.   },

    17.   "present":

    18.   {

    19.     "id": "2013040156789",

    20.     "event_id": "56789",

    21.     "start_time": "2013-04-01T19:00:00+09:00",

    22.     "end_time": "2013-04-01T19:30:00+09:00",

    23.     "service":

    24.     {

    25.       "service_id": "g1",

    26.       "service_name": "NHK総合1",

    27.       "service_logo_s":

    28.       {

    29.         "logo_url": "http://api.nhk.or.jp/common/img/service_/gtv-100x50.png",

    30.         "logo_width": "100",

    31.         "logo_height": "50"

    32.       },

    33.       "service_logo_m": { },

    34.       "service_logo_l": { }
        },

    35.     "title": "NHKニュース7",

    36.     "subtitle": "▽経済財政諮問会議が3年半ぶりに復活開催【キャスター】武田真一,【サブキャスター】久保田祐佳,【気象キャスター】岡村真美子",

    37.     "genres":

    38.     [

    39.       "0000",

    40.       "0001",

    41.       "0100"

    42.     ]

    43.   },

    44.   "following":

    45.   {

    46.     "id": "2013040167895",

    47.     "event_id": "67895",

    48.     "start_time": "2013-04-01T19:30:00+09:00",

    49.     "end_time": "2013-04-01T19:58:00+09:00",

    50.     "service": { },

    51.     "title": "クローズアップ現代「アスリートごはん~最新科学が支える究極の食~」",

    52.     "subtitle": "最新科学に裏付けられたアスリートのための食事が大きな注目を集めている。その研究成果は筋力の衰えた高齢者にまで応用され始めた。究極のアスリートごはんの秘密に迫る。",

    53.     "genres":

    54.     [

    55.       "0002",

    56.       "0800"

    57.     ]

    58.   }

    59. }

    60.  

  • Error
  •  Now On Air APIは番組表APIに共通のエラーメッセージおよびコードを返します