https://github.com/mikeralphson/bbcapis
Nodejs-based utilities, SDK to consume BBC Nitro, iBL and /programmes APIs
https://github.com/mikeralphson/bbcapis
api bbc client ibl iplayer nitro sdk
Last synced: 27 days ago
JSON representation
Nodejs-based utilities, SDK to consume BBC Nitro, iBL and /programmes APIs
- Host: GitHub
- URL: https://github.com/mikeralphson/bbcapis
- Owner: MikeRalphson
- License: bsd-3-clause
- Created: 2015-11-20T23:56:29.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-05-11T08:45:33.000Z (about 2 years ago)
- Last Synced: 2025-04-08T12:17:52.183Z (about 2 months ago)
- Topics: api, bbc, client, ibl, iplayer, nitro, sdk
- Language: JavaScript
- Homepage: https://github.com/MikeRalphson/bbcapis/wiki
- Size: 1.48 MB
- Stars: 24
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### bbcapis - Nodejs-based utilities to document and consume BBC APIs, including Nitro
[](https://join.slack.com/t/mermade/shared_invite/zt-g78g7xir-MLE_CTCcXCdfJfG3CJe9qA)
[![Share on Twitter][twitter-image]][twitter-link]
[![Follow on Twitter][twitterFollow-image]][twitterFollow-link]
### Example of using nitroSdk.js
```javascript
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](https://doclets.io/Mermade/bbcparse/master) courtesy of [doclets.io](http://doclets.io)
[twitter-image]: https://img.shields.io/twitter/url/http/PermittedSoc.svg?style=social
[twitter-link]: https://twitter.com/share?source=tweetbutton&text=BBC%20Nitro%20API%20parser%20Via%20%40PermittedSoc&url=https%3A%2F%2Fgithub.com%2FMermade%2Fbbcapis
[twitterFollow-image]: https://img.shields.io/twitter/follow/PermittedSoc.svg?style=social
[twitterFollow-link]: https://twitter.com/intent/follow?screen_name=PermittedSoc