PodcastIndex
The Podcast Index (Podcast Index LLC) is a software developer focused partnership that provides tools and data to anyone who aspires to create new and exciting Podcast experiences without the heavy lifting of indexing, aggregation and data management.
1 APIs
0 Features
PodcastingPodcast IndexDiscoveryOpen Data
APIs
PodcastIndex API
The Podcast Index API provides search, discovery, and metadata access for podcasts and episodes, including support for value-for-value, podcast namespace tags, live items, and o...
Collections
PodcastIndex.org API
OPENPricing Plans
Rate Limits
FinOps
Podcastindex Finops
FINOPSResources
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
👥
GitHubOrganization
GitHubOrganization
💻
SourceCode
SourceCode
📜
TermsOfService
TermsOfService
Sources
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
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- name: entity
value: podcast
type: query
description: 'The iTunes entity type to look in
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- 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.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: aponly
value: 'true'
type: query
description: 'Only returns feeds with an `itunesId`.
'
- name: clean
value: ''
type: query
description: 'If present, only non-explicit feeds will be returned.
Meaning, feeds where the `itunes:explicit` flag is set to `false`.
Parameter shall not have a value
'
- name: similar
value: ''
type: query
description: 'If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
Example: https://api.podcastindex.org/api/1.0/search/byterm?q=batman+university&pretty
'
- 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
'
- 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.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: clean
value: ''
type: query
description: 'If present, only non-explicit feeds will be returned.
Meaning, feeds where the `itunes:explicit` flag is set to `false`.
Parameter shall not have a value
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
- name: similar
value: ''
type: query
description: 'If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.
'
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).
Example "everything everywhere daily" will match the podcast
[Everything Everywhere Daily](https://podcastindex.org/podcast/437685) by "everything everywhere" will not.
Example: https://api.podcastindex.org/api/1.0/search/bytitle?q=everything+everywhere+daily&pretty
'
- 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
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- 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.
'
- name: aponly
value: 'true'
type: query
description: 'Only returns feeds with an `itunesId`.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: clean
value: ''
type: query
description: 'If present, only non-explicit feeds will be returned.
Meaning, feeds where the `itunes:explicit` flag is set to `false`.
Parameter shall not have a value
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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></feed>
where the [medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) is `music`.
Example: https://api.podcastindex.org/api/1.0/search/music/byterm?q=able+kirby&pretty
'
- 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
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
Example: https://api.podcastindex.org/api/1.0/podcasts/byitunesid?id=1441923632&pretty
'
- 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.
See the namespace spec for
[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
Parameter shall not have a value
'
- 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.
Parameter shall not have a value
'
- name: max
value: '200'
type: query
description: 'Maximum number of results to return.
'
- name: start_at
value: '1'
type: query
description: 'Feed ID to start at for request
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
Full list of possible values documented in
[medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) tag spec.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
auth:
type: apikey
key: X-Auth-Key
value: '{{X-Auth-Key}}'
placement: header
docs: 'This call returns all feeds marked with the specified
[medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) tag value.
Example: https://api.podcastindex.org/api/1.0/podcasts/bymedium?medium=music&pretty
'
- 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.
'
- name: since
value: '1612125785'
type: query
description: 'Return items since the specified epoch timestamp.
'
- name: lang
value: ''
type: query
description: 'Specifying a language code (like "en") will return only episodes having that specific language.
You can specify multiple languages by separating them with commas.
If you also want to return episodes that have no language given, use the token "unknown". (ex. en,es,ja,unknown).
Values are not case sensitive.
'
- name: cat
value: ''
type: query
description: 'Use this argument to specify that you **ONLY** want episodes with these categories in the results.
Separate multiple categories with commas.
You may specify either the Category ID and/or the Category Name.
Values are not case sensitive.
The `cat` and `notcat` filters can be used together to fine tune a very specific result set.
Category numbers and names can be found in the
[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)
'
- name: notcat
value: ''
type: query
description: 'Use this argument to specify categories of episodes to **NOT** show in the results.
Separate multiple categories with commas.
You may specify either the Category ID and/or the Category Name.
Values are not case sensitive.
The `cat` and `notcat` filters can be used together to fine tune a very specific result set.
Category numbers and names can be found in the
[Podcast Namespace documentation](https://github.com/Podcastindex-org/podcast-namespace/blob/main/categories.json)
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
Example: https://api.podcastindex.org/api/1.0/podcasts/trending?pretty
'
- 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.
Parameter shall not have a value
'
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)
Hourly statistics can also be access at https://public.podcastindex.org/podcastindex_dead_feeds.csv
For details, see [Dead Feeds](#get-/static/public/podcastindex_dead_feeds.csv).
Example: https://api.podcastindex.org/api/1.0/podcasts/dead?pretty
'
- 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.
Parameter shall not have a value
'
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.
The GUID is a unique, global identifier for the podcast. See the namespace spec for
[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
'
- 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.
If searching for multiple IDs, separate values with a comma. A maximum of 200 IDs can be provided.
'
- name: since
value: '1612125785'
type: query
description: 'Return items since the specified epoch timestamp.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- 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.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: newest
value: ''
type: query
description: 'If present, returns only the most recent (newest) episode for each specified feed id.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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
'
- name: since
value: '1612125785'
type: query
description: 'Return items since the specified epoch timestamp.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
See the namespace spec for
[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
'
- name: since
value: '1612125785'
type: query
description: 'Return items since the specified epoch timestamp.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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).
Episodes are in reverse chronological order.
Example: https://api.podcastindex.org/api/1.0/episodes/bypodcastguid?guid=856cd618-7f34-57ea-9b84-3600f1f65e7f&pretty
'
- 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
'
- name: since
value: '1612125785'
type: query
description: 'Return items since the specified epoch timestamp.
'
- name: max
value: '10'
type: query
description: 'Maximum number of results to return.
'
- 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.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
Example: https://api.podcastindex.org/api/1.0/episodes/byid?id=16795090&pretty
'
- 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 `<guid>`\
\ field.\n"
- name: feedurl
value: http://mp3s.nashownotes.com/pc20rss.xml
type: query
description: 'The Feed URL
'
- name: feedid
value: '920666'
type: query
description: 'The PodcastIndex Feed ID
'
- 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.
See the namespace spec for
[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
'
- name: fulltext
value: ''
type: query
description: 'If present, return the full text value of any text fields (ex: `description`).
If not provided, field value is truncated to 100 words.
Parameter shall not have a value
'
- name: pretty
value: ''
type: query
description: 'If present, makes the output “pretty” to help with debugging.
Parameter shall not have a value
'
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.
'
- name: pretty
value: ''
type:
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/podcastindex/refs/heads/main/apis.yml