Podcast Search API

This API serves to search podcasts and informations about it. Uses metadata from Gpoddernet.

Browser Support

This library relies on Fetch API. And this API is supported in the following browsers.

| | | | | --- | --- | --- | --- | --- | 39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |

Dependencies

This library depends on fetch to make requests to the Gpoddernet API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.

Instalation

$ npm install podcast-search --save

How to use

ES6

//to import a specific method
import { method } from 'podcast-search';

//to import everything
import * as podcastSearch from 'podcast-search';

CommonJS

var podcastSearch = require('podcast-search');

UMD in Browser

<!-- to import non-minified version -->
<script src="podcast-search.umd.js"></script>

<!-- to import minified version -->
<script src="podcast-search.umd.min.js"></script>

Methods

Follow the methods that the library provides.

search(query)

Search for podcasts with provided query.

Arguments

| Argument | Type | Options | | ----------- | ------ | -------------- | | query | string | 'Search query' |

Return

A promise object containing a list of podcasts data.

data[i]

.title

A title of podcast.

.url

URL to feed of podcast.

.website

Website of podcast.

.description

A description about the podcast.

.logo_url

A image that represents the podcast.

.mygpo_link

A link to mygpo page podcast

.scaled_logo_url

A link to mygpo scaled imagem that represents the podcast.

.subscribers:

Quantity of users that subscribed the podcast.

.subscribers_last_week

Quantity of users that subscribed the podcast in last week.

Example

podcastSearch.search('nerdcast')
  .then(data => {
    console.log(data[0].description);
  }); 
  // print: 'O mundo vira piada no Jovem Nerd'.

top(qtd)

List top podcasts.

Arguments

| Argument | Type | Options | | ----------- | ------ | ---------------- | | qtd | int | 'Quantity query' |

Return

A promise object containing a list of top podcasts. The functions are the same that the search method.

Example

podcastSearch.top(5)
  .then(data => {
    for(let i = 0; i < 5; i++){
      console.log(data[i].title);
    }
  });
  // print 5 top podcasts of the moment.

listTags(qtd)

List data of tags.

Arguments

| Argument | Type | Options | | ----------- | ------ | ---------------- | | qtd | int | 'Quantity query' |

Return

A promise object containing a list of tags.

data[i]

.tag

Name of tag.

.title

Title of the tag.

.usage

Quantity that was used.

Example

podcastSearch.listTags(5)
  .then(data => {
    for(let i = 0; i < 5; i++){
      console.log(data[i].tag);
    }
  });
  // print list of 5 tags name.

tagName(tag, qtd)

A list of podcasts that represent the tag.

Arguments

| Argument | Type | Options | | ----------- | ------ | ---------------- | | tag | string | 'Tag query' | qtd | int | 'Quantity query' |

Return

A promise object containing a list of podcasts. The functions are the same that the search method.

Example

podcastSearch.tagName("news-politics", 5)
  .then(data => {
    for(let i = 0; i < 5; i++){
      console.log(data[i].title);
    }
  });
  // print list of 5 title podcasts that have the tag news-politics.

info(url)

Informations about podcast that was passed by parameter.

Arguments

| Argument | Type | Options | | ----------- | ------ | ---------------- | | url | string | 'Url query'

Return

A promise object containing a podcast. The functions are the same that the search method.

Example

podcastSearch.info("http://jovemnerd.ig.com.br/categoria/nerdcast/feed/rss/")
  .then(data => {
    console.log(data.title);
  });
  // print 'Nerdcast'.