Nhk-api-v2 NPM

nhk-api-v2

NHK番組表APIのクライアントSDK(JavaScript)です

This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.0.0
Package version: 1.1.15
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

インストール方法

npm i nhk-api-v2

サンプルコード

npm i nhl-api-v2を実行してあなたのアプリケーションにnhk-api-v2を追加します

example.jsを作成して以下のコードを入力します

const NhkApiV2 = require('nhk-api-v2')

const client = new NhkApiV2.Client('Your API Key')
const area = '020' // 地域ID
const service = 'tv' // サービスID

client.getProgramsNowOnAir(area, service).then(function (data) {
  console.log('青森で現在放送中のテレビ番組: ' + JSON.stringify(data))
}, function (error) {
  console.error(error)
})

NHK番組表APIで発行したAPI Keyを確認します
example.jsの3行目にあるYour API KeyをあなたのAPIキーに書き換えます
example.jsを実行します

サンプルアプリ

以下のコマンドで同梱のサンプルアプリの動作を確認できます。サンプルアプリのソースコードはexampleディレクトリにあります。

export NHK_API_KEY="Your Api Key"
npx -y nhk-api-v2 nhk-radio-now

movie

リクエストパラメータについて

area, service, genreはNHK番組表APIの仕様ページをご確認ください
idはgetPrograms等で取得できる13文字の番組IDです

Documentation for API Endpoints

All URIs are relative to https://api.nhk.or.jp/v2/pg

Class	Method	HTTP request	Description
NhkApiV2.ProgramsApi	getProgramInfo	GET /info/{area}/{service}/{id}.json	番組情報を取得します
NhkApiV2.ProgramsApi	getPrograms	GET /list/{area}/{service}/{date}.json	番組リストを取得します
NhkApiV2.ProgramsApi	getProgramsByGenre	GET /genre/{area}/{service}/{genre}/{date}.json	指定されたジャンルの番組リストを取得します
NhkApiV2.ProgramsApi	getProgramsNowOnAir	GET /now/{area}/{service}.json	放送中の番組リストを取得します