{"id":15655556,"url":"https://github.com/mikeralphson/bbcapis","last_synced_at":"2025-05-05T14:42:07.025Z","repository":{"id":66094096,"uuid":"46593372","full_name":"MikeRalphson/bbcapis","owner":"MikeRalphson","description":"Nodejs-based utilities, SDK to consume BBC Nitro, iBL and  /programmes APIs","archived":false,"fork":false,"pushed_at":"2023-05-11T08:45:33.000Z","size":1553,"stargazers_count":24,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-08T12:17:52.183Z","etag":null,"topics":["api","bbc","client","ibl","iplayer","nitro","sdk"],"latest_commit_sha":null,"homepage":"https://github.com/MikeRalphson/bbcapis/wiki","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MikeRalphson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-20T23:56:29.000Z","updated_at":"2024-02-22T17:56:45.000Z","dependencies_parsed_at":"2023-07-02T21:31:04.973Z","dependency_job_id":null,"html_url":"https://github.com/MikeRalphson/bbcapis","commit_stats":null,"previous_names":["mermade/bbcparse"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fbbcapis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fbbcapis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fbbcapis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fbbcapis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikeRalphson","download_url":"https://codeload.github.com/MikeRalphson/bbcapis/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252516161,"owners_count":21760738,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bbc","client","ibl","iplayer","nitro","sdk"],"created_at":"2024-10-03T12:59:48.529Z","updated_at":"2025-05-05T14:42:07.013Z","avatar_url":"https://github.com/MikeRalphson.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"### bbcapis - Nodejs-based utilities to document and consume BBC APIs, including Nitro\n\n[![Join the Mermade Slack](https://img.shields.io/badge/Slack-Mermade-brightgreen)](https://join.slack.com/t/mermade/shared_invite/zt-g78g7xir-MLE_CTCcXCdfJfG3CJe9qA)\n[![Share on Twitter][twitter-image]][twitter-link]\n[![Follow on Twitter][twitterFollow-image]][twitterFollow-link]\n\n### Example of using nitroSdk.js\n\n```javascript\nconst nitro = require('bbcparse/nitroSdk');\nconst api = require('bbcparse/nitroApi/api');\n\nconst host = 'programmes.api.bbc.com';\nconst path = api.nitroMasterbrands;\nconst api_key = 'INSERT_YOUR_NITRO_API_KEY_HERE';\n\nlet query = nitro.newQuery();\nquery.add(api.fMasterbrandsPartnerPid,'*',true);\n\nlet options = {};\n\nnitro.make_request(host,path,api_key,query,options,function(obj){\n  // process the response object\n});\n```\n\n#### Utilities to:\n* fetch API definitions (`fetchApis.js`)\n* create an OpenAPI 3.0 definition from the Nitro API feed (`parseNitroApi.js`)\n* create an OpenAPI 3.0 definition from the iBL API schema (`parseIblApi.js`)\n* show programme, brand or series information by category or searching (`nitro.js`)\n* show TV/radio category (genre/format) information (`nitroCategories.js`)\n* show channel (masterbrand) information (`nitroChannels.js`)\n* show partner (non-BBC services) information (`nitroPartners.js`)\n* show linear service IDs (`nitroServices.js`)\n* query the configured nitro host and return the response time (`nitroPing.js`)\n* show download information for a version PID (`dlInfo.js`)\n* find images by keyword (`imageFinder.js`)\n* show information for an image PID (`imageInfo.js`)\n* show TV iPlayer programme, category or channels information (`ibl.js`)\n* query the searchSuggest API (`searchSuggest.js`)\n* ignore programmes, brands or series by adding PIDs to a download_history file (`ignore.js`)\n* populate a download_history from existing files (`populate_download_history.js`)\n* populate a tv cache file (`gip_ibl`)\n* populate a radio cache file (`gip_aod`)\n\nGenerated [JSDoc](https://doclets.io/Mermade/bbcparse/master) courtesy of [doclets.io](http://doclets.io)\n\n[twitter-image]: https://img.shields.io/twitter/url/http/PermittedSoc.svg?style=social\n[twitter-link]: https://twitter.com/share?source=tweetbutton\u0026text=BBC%20Nitro%20API%20parser%20Via%20%40PermittedSoc\u0026url=https%3A%2F%2Fgithub.com%2FMermade%2Fbbcapis\n[twitterFollow-image]: https://img.shields.io/twitter/follow/PermittedSoc.svg?style=social\n[twitterFollow-link]: https://twitter.com/intent/follow?screen_name=PermittedSoc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeralphson%2Fbbcapis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikeralphson%2Fbbcapis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeralphson%2Fbbcapis/lists"}