Nodejs-based utilities, SDK to consume BBC Nitro, iBL and /programmes APIs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ess Add some empty directory/gitignores Feb 25, 2017
galileoApi Add Galileo API swagger.json Oct 3, 2018
iblApi ibl; programme_type enums Nov 9, 2018
markdown Add some empty directory/gitignores Feb 25, 2017
nitroApi nitro; Fix broken link to nitropubliclicense Oct 3, 2018
rmsApi Update RMS API Oct 16, 2018
validation nitro; upgrade to OpenAPI 3.0 Oct 3, 2018
.doclets.yml I hate yaml Sep 5, 2016
.gitignore
LICENSE Initial commit Nov 20, 2015
README.md
config.json.example
connect.js connect; show Location for 3xx responses Nov 4, 2018
dlInfo.js dlInfo; fix require jgexml Oct 7, 2018
fetchApis.js
giUtils.js Refactoring Jun 19, 2016
gip_aod.js
gip_ibl.js Use constant new date() May 4, 2017
ibl.js
ignore.js
imageFinder.js
imageInfo.js
liveTv.js liveTv; more comments May 2, 2017
nitro.js Guard against missing synopses Aug 8, 2017
nitroCategories.js Update nitroCategories/nitroServices Dec 13, 2017
nitroChannels.js More refactoring Jun 20, 2016
nitroPartners.js Tweaks to nitroPartners and nitroServices Nov 29, 2016
nitroPing.js Make nitroPing a little more useful Aug 5, 2016
nitroSdk.js liveTv; add dash modes, nitroSdk; pass payload to err callback Feb 20, 2017
nitroServices.js Update nitroCategories/nitroServices Dec 13, 2017
package.json ibl; upgrade to OpenAPI 3.0 Oct 3, 2018
parseIblApi.js Log errors to stderr Oct 27, 2018
parseNitroApi.js
populate_download_history.js Refactoring Jun 19, 2016
press.js
searchSuggest.js More refactoring Jun 20, 2016

README.md

bbcparse - Nodejs-based utilities to document and consume BBC APIs, including Nitro

Join the chat at https://gitter.im/Mermade/bbcparse Share on Twitter Follow on Twitter

Example of using nitroSdk.js

const nitro = require('bbcparse/nitroSdk');
const api = require('bbcparse/nitroApi/api');

const host = 'programmes.api.bbc.com';
const path = api.nitroMasterbrands;
const api_key = 'INSERT_YOUR_NITRO_API_KEY_HERE';

let query = nitro.newQuery();
query.add(api.fMasterbrandsPartnerPid,'*',true);

let options = {};

nitro.make_request(host,path,api_key,query,options,function(obj){
  // process the response object
});

Utilities to:

  • fetch API definitions (fetchApis.js)
  • create an OpenAPI 3.0 definition from the Nitro API feed (parseNitroApi.js)
  • create an OpenAPI 3.0 definition from the iBL API schema (parseIblApi.js)
  • show programme, brand or series information by category or searching (nitro.js)
  • show TV/radio category (genre/format) information (nitroCategories.js)
  • show channel (masterbrand) information (nitroChannels.js)
  • show partner (non-BBC services) information (nitroPartners.js)
  • show linear service IDs (nitroServices.js)
  • query the configured nitro host and return the response time (nitroPing.js)
  • show download information for a version PID (dlInfo.js)
  • find images by keyword (imageFinder.js)
  • show information for an image PID (imageInfo.js)
  • show TV iPlayer programme, category or channels information (ibl.js)
  • query the searchSuggest API (searchSuggest.js)
  • ignore programmes, brands or series by adding PIDs to a download_history file (ignore.js)
  • populate a download_history from existing files (populate_download_history.js)
  • populate a tv cache file (gip_ibl)
  • populate a radio cache file (gip_aod)

Generated JSDoc courtesy of doclets.io