# bbcparse

> Nodejs-based parser for the BBC Nitro API

Latest version **1.3.1** (published 2017-05-02) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install bbcparse
pnpm add bbcparse
yarn add bbcparse
bun add bbcparse
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.1 |
| Published | 2017-05-02 |
| First published | 2016-02-26 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.1.1 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Mike Ralphson |
| Maintainers | mermade |
| Keywords | bbc, nitro, api, iplayer, ibl, searchSuggest |

## Links

- npm: https://www.npmjs.com/package/bbcparse
- Repository: https://github.com/Mermade/bbcparse
- Homepage: https://github.com/Mermade/bbcparse#readme
- Issues: https://github.com/Mermade/bbcparse/issues
- npm.io page: https://npm.io/package/bbcparse

## Dependencies (5)

- [ajv](https://npm.io/package/ajv.md) ^4.8.2
- [jgexml](https://npm.io/package/jgexml.md) latest
- [openapi2js](https://npm.io/package/openapi2js.md) latest
- [node-getopt](https://npm.io/package/node-getopt.md) ^0.2.3
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) ^2.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.3.1 (latest) — 2017-05-02
- 1.3.0 — 2017-05-02
- 1.2.0 — 2016-11-28
- 1.1.16 — 2016-10-27
- 1.1.15 — 2016-10-21
- 1.1.14 — 2016-09-06
- 1.1.13 — 2016-09-06
- 1.1.12 — 2016-08-23
- 1.1.11 — 2016-08-16
- 1.1.10 — 2016-08-10
- 1.1.9 — 2016-08-10
- 1.1.8 — 2016-08-08
- 1.1.7 — 2016-05-17
- 1.1.6 — 2016-04-21
- 1.1.5 — 2016-04-20
- … 6 more at https://npm.io/package/bbcparse/versions

## README

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

[![Join the chat at https://gitter.im/Mermade/bbcparse](https://badges.gitter.im/Mermade/bbcparse.svg)](https://gitter.im/Mermade/bbcparse?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Share on Twitter][twitter-image]][twitter-link]
[![Follow on Twitter][twitterFollow-image]][twitterFollow-link]

### Example of using nitroSdk.js

````javascript
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](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%2Fbbcparse
[twitterFollow-image]: https://img.shields.io/twitter/follow/PermittedSoc.svg?style=social
[twitterFollow-link]: https://twitter.com/intent/follow?screen_name=PermittedSoc

---
_Source: https://npm.io/package/bbcparse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._