{ "opencollection": "1.0.0", "info": { "name": "PodcastIndex.org API", "version": "1.12.1" }, "items": [ { "info": { "name": "Apple Replacement", "type": "folder" }, "items": [ { "info": { "name": "Search", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/search", "params": [ { "name": "term", "value": "batman", "type": "query", "description": "The term to search for\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "Replaces the Apple search API but returns data from the Podcast Index database.\n\n\nNote: No API key needed for this endpoint.\n\n\nExample:\n\n - Apple: https://itunes.apple.com/search?media=podcast&entity=podcast&term=batman\n - PodcastIndex: https://api.podcastindex.org/search?term=batman\n" }, { "info": { "name": "Lookup", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/lookup", "params": [ { "name": "id", "value": "", "type": "query", "description": "The iTunes Feed ID to search for\n" }, { "name": "entity", "value": "podcast", "type": "query", "description": "The iTunes entity type to look in\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "Replaces the Apple podcast lookup API but returns data from the Podcast Index database.\n\n\nNote: No API key needed for this endpoint.\n\n\nExample:\n\n - Apple: https://itunes.apple.com/lookup?media=podcast&entity=podcast&id=1636765656\n - PodcastIndex: https://api.podcastindex.org/lookup?entity=podcast&id=1636765656\n" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Search Podcasts", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/search/byterm", "params": [ { "name": "q", "value": "batman university", "type": "query", "description": "Terms to search for\n" }, { "name": "val", "value": "", "type": "query", "description": "Only returns feeds with a `value` block of the specified type. Use `any` to return feeds with any `value` block.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "aponly", "value": "true", "type": "query", "description": "Only returns feeds with an `itunesId`.\n" }, { "name": "clean", "value": "", "type": "query", "description": "If present, only non-explicit feeds will be returned.\nMeaning, feeds where the `itunes:explicit` flag is set to `false`.\n\n\nParameter shall not have a value\n" }, { "name": "similar", "value": "", "type": "query", "description": "If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all of the feeds that match the search terms in the `title`, `author` or `owner` of the feed.\n\n\nExample: https://api.podcastindex.org/api/1.0/search/byterm?q=batman+university&pretty\n" }, { "info": { "name": "Search Podcasts by Title", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/search/bytitle", "params": [ { "name": "q", "value": "batman university", "type": "query", "description": "Terms to search for\n" }, { "name": "val", "value": "", "type": "query", "description": "Only returns feeds with a `value` block of the specified type. Use `any` to return feeds with any `value` block.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "clean", "value": "", "type": "query", "description": "If present, only non-explicit feeds will be returned.\nMeaning, feeds where the `itunes:explicit` flag is set to `false`.\n\n\nParameter shall not have a value\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" }, { "name": "similar", "value": "", "type": "query", "description": "If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all of the feeds where the `title` of the feed matches the search term (ignores case).\n\n\nExample \"everything everywhere daily\" will match the podcast\n[Everything Everywhere Daily](https://podcastindex.org/podcast/437685) by \"everything everywhere\" will not.\n\n\nExample: https://api.podcastindex.org/api/1.0/search/bytitle?q=everything+everywhere+daily&pretty\n" }, { "info": { "name": "Search Episodes by Person", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/search/byperson", "params": [ { "name": "q", "value": "adam curry", "type": "query", "description": "Person search for\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all of the episodes where the specified person is mentioned.\n\n\nIt searches the following fields:\n\n - Person tags\n - Episode title\n - Episode description\n - Feed owner\n - Feed author\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/search/byperson?q=adam%20curry&pretty\n - https://api.podcastindex.org/api/1.0/search/byperson?q=Martin+Mouritzen&pretty\n - https://api.podcastindex.org/api/1.0/search/byperson?q=Klaus+Schwab&pretty\n" }, { "info": { "name": "Search Music Podcasts", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/search/music/byterm", "params": [ { "name": "q", "value": "batman university", "type": "query", "description": "Terms to search for\n" }, { "name": "val", "value": "", "type": "query", "description": "Only returns feeds with a `value` block of the specified type. Use `any` to return feeds with any `value` block.\n" }, { "name": "aponly", "value": "true", "type": "query", "description": "Only returns feeds with an `itunesId`.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "clean", "value": "", "type": "query", "description": "If present, only non-explicit feeds will be returned.\nMeaning, feeds where the `itunes:explicit` flag is set to `false`.\n\n\nParameter shall not have a value\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all of the feeds that match the search terms in the `title`, `author` or `owner` of the \nwhere the [medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) is `music`.\n\n\nExample: https://api.podcastindex.org/api/1.0/search/music/byterm?q=able+kirby&pretty\n" } ] }, { "info": { "name": "Podcasts", "type": "folder" }, "items": [ { "info": { "name": "By Feed ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/byfeedid", "params": [ { "name": "id", "value": "75075", "type": "query", "description": "The PodcastIndex Feed ID\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns everything we know about the feed from the PodcastIndex ID\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/podcasts/byfeedid?id=75075&pretty\n - Includes `value` and `funding`: https://api.podcastindex.org/api/1.0/podcasts/byfeedid?id=169991&pretty\n" }, { "info": { "name": "By Feed URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/byfeedurl", "params": [ { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns everything we know about the feed from the feed URL\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/podcasts/byfeedurl?url=https://feeds.theincomparable.com/batmanuniversity&pretty\n - Includes `value` and `funding`: https://api.podcastindex.org/api/1.0/podcasts/byfeedurl?url=https://engineered.network/pragmatic/feed/index.xml&pretty\n" }, { "info": { "name": "By iTunes ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/byitunesid", "params": [ { "name": "id", "value": "", "type": "query", "description": "The iTunes Feed ID to search for\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns everything we know about the feed from the iTunes ID\n\n\nExample: https://api.podcastindex.org/api/1.0/podcasts/byitunesid?id=1441923632&pretty\n" }, { "info": { "name": "By GUID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/byguid", "params": [ { "name": "guid", "value": "9b024349-ccf0-5f69-a609-6b82873eab3c", "type": "query", "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns everything we know about the feed from the feed's GUID.\n\n\nThe GUID is a unique, global identifier for the podcast. See the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/podcasts/byguid?guid=9b024349-ccf0-5f69-a609-6b82873eab3c&pretty\n - Includes `value` and `funding`: https://api.podcastindex.org/api/1.0/podcasts/byguid?guid=9b024349-ccf0-5f69-a609-6" }, { "info": { "name": "By Tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/bytag", "params": [ { "name": "podcast-value", "value": "", "type": "query", "description": "Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.\n\n\nParameter shall not have a value\n" }, { "name": "podcast-valueTimeSplit", "value": "", "type": "query", "description": "Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.\n\n\nParameter shall not have a value\n" }, { "name": "max", "value": "200", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "start_at", "value": "1", "type": "query", "description": "Feed ID to start at for request\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\n\nThe only supported tags are:\n - `podcast:value` using the `podcast-value` parameter\n - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter\n\n\nOnly the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the\nfirst parameter is used and the others are ignored.\n\n\nWhen called with" }, { "info": { "name": "By Medium", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/bymedium", "params": [ { "name": "medium", "value": "film", "type": "query", "description": "The medium value to search for.\n\n\nFull list of possible values documented in\n[medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) tag spec.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all feeds marked with the specified\n[medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) tag value.\n\n\nExample: https://api.podcastindex.org/api/1.0/podcasts/bymedium?medium=music&pretty\n" }, { "info": { "name": "Trending", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/trending", "params": [ { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "lang", "value": "", "type": "query", "description": "Specifying a language code (like \"en\") will return only episodes having that specific language.\n\n\nYou can specify multiple languages by separating them with commas.\n\n\nIf you also want to return episodes that have no language given, use the token \"unknown\". (ex. en,es,ja,unknown).\n\n\nValues are not case sensitive.\n" }, { "name": "cat", "value": "", "type": "query", "description": "Use this argument to specify that you **ONLY** want episodes with these categories in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "notcat", "value": "", "type": "query", "description": "Use this argument to specify categories of episodes to **NOT** show in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns the podcasts/feeds that in the index that are trending.\n\n\nExample: https://api.podcastindex.org/api/1.0/podcasts/trending?pretty\n" }, { "info": { "name": "Dead", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/podcasts/dead", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all feeds that have been marked dead (`dead` == 1)\n\n\nHourly statistics can also be access at https://public.podcastindex.org/podcastindex_dead_feeds.csv\nFor details, see [Dead Feeds](#get-/static/public/podcastindex_dead_feeds.csv).\n\n\nExample: https://api.podcastindex.org/api/1.0/podcasts/dead?pretty\n" }, { "info": { "name": "Batch By Feed GUID", "type": "http" }, "http": { "method": "POST", "url": "https://api.podcastindex.org/api/1.0/podcasts/batch/byguid", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns everything we know about the feed from the feed's GUID provided in JSON array in the body of the request.\n\n\nThe GUID is a unique, global identifier for the podcast. See the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" } ] }, { "info": { "name": "Episodes", "type": "folder" }, "items": [ { "info": { "name": "By Feed ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/byfeedid", "params": [ { "name": "id", "value": "", "type": "query", "description": "The PodcastIndex Feed ID or IDs to search for.\n\n\nIf searching for multiple IDs, separate values with a comma. A maximum of 200 IDs can be provided.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "enclosure", "value": "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3", "type": "query", "description": "The URL for the episode enclosure to get the information for.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "newest", "value": "", "type": "query", "description": "If present, returns only the most recent (newest) episode for each specified feed id.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all the episodes we know about for this feed from the PodcastIndex ID.\nEpisodes are in reverse chronological order.\n\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&newest&pretty\n - https://api.podcastinde" }, { "info": { "name": "By Feed URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/byfeedurl", "params": [ { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all the episodes we know about for this feed from the feed URL.\nEpisodes are in reverse chronological order.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedurl?url=https://feeds.theincomparable.com/batmanuniversity&pretty\n - Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedurl?url=https://engineered.network/pragmatic/feed/index.xml&pretty\n - Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedurl?url=https://closi" }, { "info": { "name": "By Podcast GUID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/bypodcastguid", "params": [ { "name": "guid", "value": "9b024349-ccf0-5f69-a609-6b82873eab3c", "type": "query", "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all the episodes we know about for this feed from the [Podcast GUID](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid).\nEpisodes are in reverse chronological order.\n\n\nExample: https://api.podcastindex.org/api/1.0/episodes/bypodcastguid?guid=856cd618-7f34-57ea-9b84-3600f1f65e7f&pretty\n" }, { "info": { "name": "By iTunes ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/byitunesid", "params": [ { "name": "id", "value": "", "type": "query", "description": "The iTunes Feed ID to search for\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "enclosure", "value": "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3", "type": "query", "description": "The URL for the episode enclosure to get the information for.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns all the episodes we know about for this feed from the iTunes ID.\nEpisodes are in reverse chronological order.\n\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty\n - Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=269169796&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty\n" }, { "info": { "name": "By ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/byid", "params": [ { "name": "id", "value": "16795089", "type": "query", "description": "The PodcastIndex episode ID to search for.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "Get all the metadata for a single episode by passing its id.\n\n\nExample: https://api.podcastindex.org/api/1.0/episodes/byid?id=16795090&pretty\n" }, { "info": { "name": "By GUID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/byguid", "params": [ { "name": "guid", "value": "PC2084", "type": "query", "description": "The guid value for the episode to retrieve.\n\n\n This value is the value specified in the feed's `` field.\n" }, { "name": "feedurl", "value": "http://mp3s.nashownotes.com/pc20rss.xml", "type": "query", "description": "The Feed URL\n" }, { "name": "feedid", "value": "920666", "type": "query", "description": "The PodcastIndex Feed ID\n" }, { "name": "podcastguid", "value": "917393e3-1b1e-5cef-ace4-edaa54e1f810", "type": "query", "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "Get all the metadata for a single episode by passing its guid and the feed id or URL.\n\n\nThe `feedid`, `feedurl`, or `podcastguid` is required.\n\n\nExamples: \n\n - Search using Podcast Index feed ID: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedid=920666&pretty\n - Search using feed URL: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedurl=http://mp3s.nashownotes.com/pc20rss.xml&pretty\n" }, { "info": { "name": "Live", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/live", "params": [ { "name": "max", "value": "10", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "Get all episodes that have been found in the [podcast:liveitem](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#live-item) from the feeds.\n\n\nExamples: \n\n - https://api.podcastindex.org/api/1.0/episodes/live?pretty\n" }, { "info": { "name": "Random", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/episodes/random", "params": [ { "name": "max", "value": "2", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "lang", "value": "", "type": "query", "description": "Specifying a language code (like \"en\") will return only episodes having that specific language.\n\n\nYou can specify multiple languages by separating them with commas.\n\n\nIf you also want to return episodes that have no language given, use the token \"unknown\". (ex. en,es,ja,unknown).\n\n\nValues are not case sensitive.\n" }, { "name": "cat", "value": "", "type": "query", "description": "Use this argument to specify that you **ONLY** want episodes with these categories in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "notcat", "value": "", "type": "query", "description": "Use this argument to specify categories of episodes to **NOT** show in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns a random batch of episodes, in no specific order.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/random?notcat=News,Religion&lang=en,es&pretty\n - https://api.podcastindex.org/api/1.0/episodes/random?max=2&pretty\n" } ] }, { "info": { "name": "Recent", "type": "folder" }, "items": [ { "info": { "name": "Episodes", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/episodes", "params": [ { "name": "max", "value": "7", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "excludeString", "value": "religion", "type": "query", "description": "Any item containing this string will be discarded from the result set.\n\n\nThis may, in certain cases, reduce your set size below your `max` value.\n\n\nMatches against the `title` and URL properties.\n" }, { "name": "before", "value": "1721351091", "type": "query", "description": "If you pass a PodcastIndex Episode ID, you will get recent episodes before that ID, allowing you to walk back\nthrough the episode history sequentially.\n" }, { "name": "fulltext", "value": "", "type": "query", "description": "If present, return the full text value of any text fields (ex: `description`).\nIf not provided, field value is truncated to 100 words.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns the most recent `max` number of episodes globally across the whole index,\nin reverse chronological order.\n\n\nExample: https://api.podcastindex.org/api/1.0/recent/episodes?max=7&pretty\n" }, { "info": { "name": "Feeds", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/feeds", "params": [ { "name": "max", "value": "20", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "lang", "value": "", "type": "query", "description": "Specifying a language code (like \"en\") will return only episodes having that specific language.\n\n\nYou can specify multiple languages by separating them with commas.\n\n\nIf you also want to return episodes that have no language given, use the token \"unknown\". (ex. en,es,ja,unknown).\n\n\nValues are not case sensitive.\n" }, { "name": "cat", "value": "", "type": "query", "description": "Use this argument to specify that you **ONLY** want episodes with these categories in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "notcat", "value": "", "type": "query", "description": "Use this argument to specify categories of episodes to **NOT** show in the results.\n\n\nSeparate multiple categories with commas.\n\n\nYou may specify either the Category ID and/or the Category Name.\n\n\nValues are not case sensitive.\n\n\nThe `cat` and `notcat` filters can be used together to fine tune a very specific result set.\n\n\nCategory numbers and names can be found in the\n[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns the most recent `max` feeds, in reverse chronological order.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/recent/feeds?pretty\n - https://api.podcastindex.org/api/1.0/recent/feeds?max=20&cat=102,health&lang=de,ja&pretty\n" }, { "info": { "name": "New Feeds", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/newfeeds", "params": [ { "name": "max", "value": "20", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "feedid", "value": "2653471", "type": "query", "description": "The PodcastIndex Feed ID to start from (or go to if `desc` specified).\n\n\nIf `since` parameter also specified, value of `since` is ignored.\n" }, { "name": "desc", "value": "", "type": "query", "description": "If present, display feeds in descending order.\n\n\nOnly applicable when using `feedid` parameter.\n\n\nParameter shall not have a value\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns every new feed added to the index over the past 24 hours in reverse chronological order.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/recent/newfeeds?pretty\n - https://api.podcastindex.org/api/1.0/recent/newfeeds?pretty&since=1613805000\n - https://api.podcastindex.org/api/1.0/recent/newfeeds?feedid=2653471&pretty\n - https://api.podcastindex.org/api/1.0/recent/newfeeds?feedid=2653471&desc&pretty\n" }, { "info": { "name": "New Value Feeds", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/newvaluefeeds", "params": [ { "name": "max", "value": "20", "type": "query", "description": "Maximum number of results to return.\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns feeds that have added a `value` tag in reverse chronological order.\n\n\nExample: https://api.podcastindex.org/api/1.0/recent/newvaluefeeds?pretty\n" }, { "info": { "name": "Recent Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/data", "params": [ { "name": "max", "value": "200", "type": "query", "description": "Maximum number of results to return (includes both `feeds` and `items`).\n" }, { "name": "since", "value": "1612125785", "type": "query", "description": "Return items since the specified epoch timestamp.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns every new feed and episode added to the index over the past 24 hours in reverse chronological order.\n\n\nThis is similar to `/recent/feeds` but uses the date the feed was found by the index rather than the feed's\ninternal timestamp.\n\n\nSimilar data can also be accessed using object storage root url https://tracking.podcastindex.org/current\nFor details, see [Current](#get-/static/tracking/current).\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/recent/data?pretty\n - https:/" }, { "info": { "name": "Soundbites", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/recent/soundbites", "params": [ { "name": "max", "value": "20", "type": "query", "description": "Maximum number of soundbites to return.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call returns the most recent `max` soundbites that the index has discovered.\n\n\nA soundbite consists of an enclosure url, a start time and a duration.\nIt is documented in the [podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#soundbite).\n\n\nExample: https://api.podcastindex.org/api/1.0/recent/soundbites?pretty\n" } ] }, { "info": { "name": "Value", "type": "folder" }, "items": [ { "info": { "name": "By Feed ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/value/byfeedid", "params": [ { "name": "id", "value": "75075", "type": "query", "description": "The PodcastIndex Feed ID to search for.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "This call returns the information for supporting the podcast via one of the \"Value for Value\" methods from the\nPodcastIndex ID.\n\n\nAdditionally, the value block data can be accessed using static JSON files (updated every 15 minutes).\n\n - Feeds: https://tracking.podcastindex.org/feedValueBlocks.json\n - Episodes: https://tracking.podcastindex.org/episodeValueBlocks.json\n\n\nNote: No API key needed for this endpoint.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/value/byfeedid?id=920666&pret" }, { "info": { "name": "By Feed URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/value/byfeedurl", "params": [ { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "This call returns the information for supporting the podcast via one of the \"Value for Value\" methods from feed URL.\n\n\nAdditionally, the value block data can be accessed using static JSON files (updated every 15 minutes).\n\n - Feeds: https://tracking.podcastindex.org/feedValueBlocks.json\n - Episodes: https://tracking.podcastindex.org/episodeValueBlocks.json\n\n\nNote: No API key needed for this endpoint.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/value/byfeedurl?url=https://mp3s.nashown" }, { "info": { "name": "By Feed GUID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/value/bypodcastguid", "params": [ { "name": "guid", "value": "9b024349-ccf0-5f69-a609-6b82873eab3c", "type": "query", "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "This call returns the information for supporting the podcast via one of the \"Value for Value\" methods from podcast GUID.\n\n\nNote: No API key needed for this endpoint.\n\n\nExample: https://api.podcastindex.org/api/1.0/value/bypodcastguid?guid=917393e3-1b1e-5cef-ace4-edaa54e1f810&pretty\n" }, { "info": { "name": "By Episode GUID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/value/byepisodeguid", "params": [ { "name": "podcastguid", "value": "917393e3-1b1e-5cef-ace4-edaa54e1f810", "type": "query", "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n" }, { "name": "episodeguid", "value": "PC20143", "type": "query", "description": "The guid specified by the `` in the episode ``.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "This call returns the information for supporting the podcast episode via one of the \"Value for Value\" methods from\npodcast GUID and the episode GUID.\n\n\nThe `podcastguid` is the GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier\nfor the podcast. See the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n\n\nThe `episodeguid` is the unique guid specified for the `` in the feed but may not" }, { "info": { "name": "Batch By Episode GUID", "type": "http" }, "http": { "method": "POST", "url": "https://api.podcastindex.org/api/1.0/value/batch/byepisodeguid", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call returns the information for supporting the podcast episode via one of the \"Value for Value\" methods from\na JSON object containing one or more podcast GUID and one or more episode GUID for the podcast.\n\n\nThe JSON object key shall be the `podcastguid` from the `podcast:guid` tag in the feed.\nThis value is a unique, global identifier for the podcast. See the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n\n\nThe value" } ] }, { "info": { "name": "Stats", "type": "folder" }, "items": [ { "info": { "name": "Current", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/stats/current", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "Return the most recent index statistics.\n\n\nHourly statistics can also be access at https://stats.podcastindex.org/hourly_counts.json\nFor details, see [Stats Hourly Counts](#get-/static/stats/hourly_counts.json).\n\n\nDaily statistics can also be access at https://stats.podcastindex.org/daily_counts.json.\nFor details, see [Stats Daily Counts](#get-/static/stats/daily_counts.json).\n\n\nExample: https://api.podcastindex.org/api/1.0/stats/current?pretty\n" } ] }, { "info": { "name": "Categories", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/categories/list", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "Return all the possible categories supported by the index.\n\n\nExample: https://api.podcastindex.org/api/1.0/categories/list?pretty\n" } ] }, { "info": { "name": "Hub", "type": "folder" }, "items": [ { "info": { "name": "Pub Notify", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/hub/pubnotify", "params": [ { "name": "id", "value": "75075", "type": "query", "description": "The PodcastIndex Feed ID\n\n\nThe `id` or the `url` is required.\n" }, { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n\n\nThe `id` or the `url` is required.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ] }, "docs": "Notify the index that a feed has changed\n\n\nNote: No API key needed for this endpoint.\n\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/hub/pubnotify?id=920666&pretty\n - https://api.podcastindex.org/api/1.0/hub/pubnotify?url=https://feeds.theincomparable.com/batmanuniversity&pretty\n" } ] }, { "info": { "name": "Add", "type": "folder" }, "items": [ { "info": { "name": "By Feed URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/add/byfeedurl", "params": [ { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n" }, { "name": "chash", "value": "ad651c60eaaf3344595c0dd0bd787993", "type": "query", "description": "The md5 hash of the following feed items in hex format.\nIf known, allows for easier duplicate checking.\n\n - `title`\n - `link`\n - `feedLanguage`\n - `generator`\n - `author`\n - `ownerName`\n - `ownerEmail` (note: not exposed via the API)\n\nPseudo-code:\n\n chash = md5(title+link+feedLanguage+generator+author+ownerName+ownerEmail)\n" }, { "name": "itunesid", "value": "1441923632", "type": "query", "description": "If this parameter is given, and the existing feed has no associated iTunes ID, it will be associated with this ID.\nIf an existing iTunes ID is already associated with this feed it will **NOT** be changed.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call adds a podcast to the index using its feed url. If a feed already exists, you will get its existing Feed ID returned.\n\n\n**NOTE**: this endpoint requires an API Key with the **write** permission.\n\n\nExample: https://api.podcastindex.org/api/1.0/add/byfeedurl?url=https://feeds.theincomparable.com/batmanuniversity&pretty\n" }, { "info": { "name": "By Feed URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.podcastindex.org/api/1.0/add/byfeedurl", "params": [ { "name": "url", "value": "https://feeds.theincomparable.com/batmanuniversity", "type": "query", "description": "Podcast feed URL\n" }, { "name": "itunesid", "value": "1441923632", "type": "query", "description": "If this parameter is given, and the existing feed has no associated iTunes ID, it will be associated with this ID.\nIf an existing iTunes ID is already associated with this feed it will **NOT** be changed.\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call adds a podcast to the index using its feed url. If a feed already exists, you will get its existing Feed ID returned.\n\n\n**NOTE**: this endpoint requires an API Key with the **write** permission.\n\n\nExample: https://api.podcastindex.org/api/1.0/add/byfeedurl?url=https://feeds.theincomparable.com/batmanuniversity&pretty\n" }, { "info": { "name": "By iTunes ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/add/byitunesid", "params": [ { "name": "id", "value": "1441923632", "type": "query", "description": "The iTunes ID to add\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call adds a podcast to the index using its iTunes ID. If a feed already exists, it will be noted in the response.\n\n\n**NOTE**: this endpoint requires an API Key with the **write** permission.\n\n\nExample: https://api.podcastindex.org/api/1.0/add/byitunesid?id=1441923632&pretty\n" }, { "info": { "name": "By iTunes ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.podcastindex.org/api/1.0/add/byitunesid", "params": [ { "name": "id", "value": "1441923632", "type": "query", "description": "The iTunes ID to add\n" }, { "name": "pretty", "value": "", "type": "query", "description": "If present, makes the output “pretty” to help with debugging.\n\n\nParameter shall not have a value\n" } ], "auth": { "type": "apikey", "key": "X-Auth-Key", "value": "{{X-Auth-Key}}", "placement": "header" } }, "docs": "This call adds a podcast to the index using its iTunes ID. If a feed already exists, it will be noted in the response.\n\n\n**NOTE**: this endpoint requires an API Key with the **write** permission.\n\n\nExample: https://api.podcastindex.org/api/1.0/add/byitunesid?id=1441923632&pretty\n" } ] }, { "info": { "name": "Static Data", "type": "folder" }, "items": [ { "info": { "name": "Stats Daily Counts", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/daily_counts.json" }, "docs": "Report a number of statistics about the feeds in Podcast Index's database. Updated daily.\n\n\nA subset of stats can be retrieved using the API endpoint [stats/current](#get-/stats/current).\n\n\nView at: https://stats.podcastindex.org/daily_counts.json\n" }, { "info": { "name": "Stats Hourly Counts", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/hourly_counts.json" }, "docs": "Report a number of statistics about the feeds in Podcast Index's database. Updated hourly.\n\n\nA subset of stats can be retrieved using the API endpoint [stats/current](#get-/stats/current).\n\n\nView at: https://stats.podcastindex.org/hourly_counts.json\n" }, { "info": { "name": "v4v Sats", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/chart-data.json" }, "docs": "Contains the raw data used to populate the graphs at https://stats.podcastindex.org/v4v.\n\nThis is a look at the total [sats](https://www.investopedia.com/terms/s/satoshi.asp) flowing through the Value4Value\nLightning podcasting economy over various periods of time.\n\nWe calculate this data based on our visibility as a one percent voluntary split on Podcastindex.org api\ncalls. Therefore, the true numbers could be higher, but they cannot be lower than listed here. This represents our\nbest approxima" }, { "info": { "name": "v4v Music Chart JSON", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/v4vmusic.json" }, "docs": "Contains the ranking of the music tracks played on podcasts that have been boosted the most over the last 7 days.\n\nEach entry shows the number of listener boosts sent over this time period. The chart is updated hourly.\n\n\nCan be viewed in a browser at https://podcastindex.top/ (https://stats.podcastindex.org/v4vmusic.html).\n\n\nView at: https://stats.podcastindex.org/v4vmusic.json\n\n\nAlso available in [OPML](#get-/static/stats/v4vmusic.opml) and [RSS](#get-/static/stats/v4vmusic.rss).\n" }, { "info": { "name": "v4v Music Chart OPML", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/v4vmusic.opml" }, "docs": "Contains the ranking of the music tracks played on podcasts that have been boosted the most over the last 7 days.\n\nEach entry shows the number of listener boosts sent over this time period. The chart is updated hourly.\n\n\nCan be viewed in a browser at https://podcastindex.top/ (https://stats.podcastindex.org/v4vmusic.html).\n\n\nView at: https://stats.podcastindex.org/v4vmusic.opml\n\n\nAlso available in [JSON](#get-/static/stats/v4vmusic.json) and [RSS](#get-/static/stats/v4vmusic.rss).\n" }, { "info": { "name": "v4v Music Chart RSS", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/stats/v4vmusic.rss" }, "docs": "Contains the ranking of the music tracks played on podcasts that have been boosted the most over the last 7 days.\n\nEach entry shows the number of listener boosts sent over this time period. The chart is updated hourly.\n\n\nCan be viewed in a browser at https://podcastindex.top/ (https://stats.podcastindex.org/v4vmusic.html).\n\n\nView at: https://stats.podcastindex.org/v4vmusic.rss\n\n\nAlso available in [JSON](#get-/static/stats/v4vmusic.json) and [OPML](#get-/static/stats/v4vmusic.opml).\n" }, { "info": { "name": "Current", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/tracking/current" }, "docs": "This call returns every new feed and episode added to the index over the past 24 hours in reverse chronological order.\n\n\nThis is similar to `/recent/feeds` but uses the date the feed was found by the index rather than the feed's\ninternal timestamp.\n\n\nSimilar data can also be retrieved using the API endpoint [recent/data](#get-/recent/data).\n\n\nAccess at: https://tracking.podcastindex.org/current\n\n\nThe prior 24 hours of data (going backwards until all tracked data is received) can be accessed usin" }, { "info": { "name": "Feed Value Blocks", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/tracking/feedValueBlocks" }, "docs": "Get all feeds with value blocks.\n\n\nAccess at: https://tracking.podcastindex.org/feedValueBlocks.json\n" }, { "info": { "name": "Episode Value Blocks", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/tracking/episodeValueBlocks" }, "docs": "Get all episodes with value blocks.\n\n\nAccess at: https://tracking.podcastindex.org/episodeValueBlocks.json\n" }, { "info": { "name": "Dead Feeds", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/public/podcastindex_dead_feeds.csv" }, "docs": "Lists all feed Ids that have been marked dead in the Podcast Index database. The list is updated every X hours.\n\n\nA subset of stats can be retrieved using the API endpoint [podcasts/dead](#get-/podcasts/dead).\n\n\nDownload from: https://public.podcastindex.org/podcastindex_dead_feeds.csv\n" }, { "info": { "name": "Feeds Database", "type": "http" }, "http": { "method": "GET", "url": "https://api.podcastindex.org/api/1.0/static/public/podcastindex_feeds.db.tgz" }, "docs": "Compressed database of all non-dead feeds in the Podcast Index database.\n\n\nUpdated daily. Some attributes excluded. No episodes included.\n\n\nDownload from: https://public.podcastindex.org/podcastindex_feeds.db.tgz\n" } ] } ], "bundled": true }