bbcparse

    1.3.1 • Public • Published

    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

    var nitro = require('bbcparse/nitroSdk');
    var api = require('bbcparse/nitroApi/api');
     
    var host = 'programmes.api.bbc.com';
    var path = api.nitroMasterbrands;
    var api_key = 'INSERT_YOUR_NITRO_API_KEY_HERE';
     
    var query = nitro.newQuery();
    query.add(api.fMasterbrandsPartnerPid,'*',true);
     
    var options = {};
     
    nitro.make_request(host,path,api_key,query,options,function(obj){
      // process the response object
    });

    Utilities to:

    • fetch API definitions (fetchApis.js)
    • create a Swagger 2.0 definition from the Nitro API feed (parseNitroApi.js)
    • create a Swagger 2.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)
    • show legacy programme, brand or series information by category or searching (progs.js)
    • show legacy genres/formats for the radio player and iPlayer (categories.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

    Install

    npm i bbcparse

    DownloadsWeekly Downloads

    16

    Version

    1.3.1

    License

    BSD-3-Clause

    Last publish

    Collaborators

    • mermade