Giter VIP home page Giter VIP logo

podcast-index-api's Introduction

Podcast Index API Javascript library

A Podcast Index API library for Node.js

pipeline status coverage report Install size npm Downloads

Homepage | Source | npm

Installation

Install with npm

npm install podcast-index-api --save

Configuration

Sign up for API credentials here: https://api.podcastindex.org/

Description of API endpoints, arguments and returned data: https://podcastindex-org.github.io/docs-api/

Require the lib from your javascript file

const api = require('podcast-index-api')("YOUR_API_KEY_HERE", "YOUR_API_SECRET_HERE")

Usage

Using Async/Await

const results = await api.searchByTerm('Joe Rogan Experience')

Using Promise

api.searchByTerm('Joe Rogan Experience').then(results => { console.log(results) })

Functions

  • Custom
    • Use for endpoints that don't have a specific function or if the function doesn't accept an argument for a desired parameter.
      • custom(path: String, queries: Object)
  • Search
    • searchByTerm(q: String, val: String, clean: Boolean, fullText: Boolean)
    • searchByTitle(q: String, val: String, clean: Boolean, fullText: Boolean)
    • searchEpisodesByPerson(q: String, fullText: Boolean)
  • Podcasts
    • podcastsByFeedUrl(feedUrl: String)
    • podcastsByFeedId(feedId: Number)
    • podcastsByFeedItunesId(itunesId: Number)
    • podcastsByGUID(guid: Number)
    • podcastsByTag()
    • podcastsTrending(max: Number, since: Number, lang: String, cat: String, notcat: String)
    • podcastsDead()
  • Episodes
    • episodesByFeedId(feedId: Number, since: Number, max: Number, fullText: Boolean)
    • episodesByFeedUrl(feedUrl: String, since: Number, max: Number, fullText: Boolean)
    • episodesByItunesId(itunesId: Number, since: Number, max: Number, fullText: Boolean)
    • episodesById(id: Number, fullText: Boolean)
    • episodesRandom(max: Number, lang: String, cat: String, notcat: String, fullText: Boolean)
  • Recent
    • recentFeeds(max: Number, since: Number, cat: String, lang: String, notcat: String)
    • recentEpisodes(max: Number, excludeString: String, before: Number, fullText: Boolean)
    • recentNewFeeds(max: Number, since: Number)
    • recentSoundbites(max: Number)
  • Value
    • valueByFeedUrl(feedUrl: String)
    • valueByFeedId(feedId: Number)
  • Categories
    • categoriesList()
  • Notify Hub
    • hubPubNotifyById(feedId: Number)
    • hubPubNotifyByUrl(feedUrl: string)
  • Add
    • addByFeedUrl(feedUrl: String, chash: String, itunesId: Number)
    • addByItunesId(itunesId: Number)

podcast-index-api's People

Contributors

comster avatar stevencrader avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.