PodcastIndex Episodes API is one of 11 APIs that PodcastIndex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Episodes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
8 operations
across 8 paths,
and defines 93 schemas.
It is described by OpenAPI 3.2.0, at version 1.12.1.
Requests are made against a single base URL, https://api.podcastindex.org/api/1.0.
The identity and technical contract details declared by the specification.
description_response
string
Description of the response
item_podcast_random
object
23 properties
url_socialInteract
string
The uri/url of the root post comment
transcript
object
This tag is used to link to a transcript or closed captions file. Multiple tags can be present for multiple transcript formats. Detailed file format informatio…
2 properties
startTime_live
integer
The time the livestream starts
suggested_v4v
stringnull
Suggested amount per second of playback to send. Unit is specific to the type.
explicit_episode
integer
Is feed or episode marked as explicit - 0: not marked explicit - 1: marked explicit
href
string
The url to a relevant resource of information about the person, such as a homepage or third-party profile platform. See the [podcast namespace spec](https://gi…
value
objectnull
Information for supporting the podcast via one of the "Value for Value" methods. May not be reported. Examples: - lightning value type: https://api.podcastinde…
2 properties
datePublishedPretty
string
The date and time the episode was published formatted as a human readable string. Note: uses the PodcastIndex server local time to do conversion.
protocol_socialInteract
string
The protocol in use for interacting with the comment root post. For the most up-to-date list of options, see https://github.com/Podcastindex-org/podcast-namesp…
itunesId_feed
integernull
The iTunes ID of this feed if there is one, and we know what it is.
title_feed
string
Name of the feed
model_v4v
object
Description of the method for providing "Value for Value" payments
3 properties
dead
integer
At some point, we give up trying to process a feed and mark it as dead. This is usually after 1000 errors without a successful pull/parse cycle. Once the feed…
language
string
The channel-level language specification of the feed. Languages accord with the [RSS Language Spec](https://www.rssboard.org/rss-language-codes).
dateCrawled
integer
The time this episode was found in the feed
title_soundbite
string
Name of the soundbite
fee_destination
booleannull
Indicates if destination is included due to a fee being charged. May not be reported.
podcastguid
string
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…
categories
object
An array of categories, where the index is the Category ID and the value is the Category Name. All Category numbers and names are returned by the categories/li…
destination_v4v
object
Destination for "Value for Value" payment.
7 properties
person
object
6 properties
chaptersUrl
stringnull
Link to the JSON file containing the episode chapters
guid_query
string
Value passed to request in the guid parameter.
type_v4v
string
Payment type
status_live
string
Status of the livestream
items_itunesId
array
List of episodes matching request
type_destination
string
Type of destination
priority_socialInteract
integer
When multiple socialInteract tags are present, this integer gives order of priority. A lower number means higher priority.
duplicateOf
integernull
The internal PodcastIndex.org Feed ID this feed duplicates. May be null except in podcasts/dead.
soundbites
arraynull
Soundbites for episode. May not be reported.
query_podcast_id_single
string
Single ID passed to request
episode_object
object
Episode data
31 properties
guid
string
The unique identifier for the episode
enclosureType
string
The Content-Type for the item specified by the enclosureUrl
name_person
string
The name of the person. See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.mdperson) for more informatio…
episodes_random_array
array
List of episodes matching request
item_podcast
object
33 properties
contentLink
string
Link TODO
customValue
stringnull
A custom value to pass along with the payment. This is considered the value that belongs to the customKey. May not be reported. See the [podcast namespace spec…
group
string
The group the person's role is in. Value should be an official group within the Podcast Taxonomy Project [list](https://github.com/Podcastindex-org/podcast-nam…
socialInteract_item
object
5 properties
url_feed
string
Current feed URL
destinations_v4v
array
List of destinations where "Value for Value" payments should be sent.
items_live
array
List of episodes matching request
episodeType
stringnull
The type of episode. May be null for liveItem.
accountId_socialInteract
string
The account id (on the commenting platform) of the account that created this root post.
image_episode
string
The item-level image for the episode
split_destination
integer
Share of payment the destination should receive
enclosureLength
integer
The length of the item specified by the enclosureUrl in bytes
persons
arraynull
List of people with an interest in this episode. May not be reported. See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/bl…
soundbite
objectnull
Soundbite for episode. May not be reported.
3 properties
role
string
Used to identify what role the person serves on the show or episode. Value should be an official role within the Podcast Taxonomy Project [list](https://github…
id_episode
integer
The internal PodcastIndex.org episode ID.
feedid_query
string
Value passed to request in the feedid parameter
address_destination
string
Address of node to receive payment
socialInteract
arraynull
List the social interact data found in the podcast feed. May not be reported. See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-name…
method_v4v
string
Method for sending payment
url_query
string
Value passed to request in the url field
item_podcast_live
object
18 properties
episode_number
integernull
Episode number
datePublished
integer
The date and time the episode was published
duration
integernull
The estimated length of the item specified by the enclosureUrl in seconds. Will be null for liveItem.
query_url
object
Object containing the input query data
1 property
endTime_live
integer
The time the livestream ends
season
integernull
Season number. May be null for liveItem.
description_episode
string
The item-level description of the episode. Uses the longer of the possible fields in the feed: , and
transcriptUrl
stringnull
Link to the file containing the episode transcript Note: in most use cases, the transcripts value should be used instead
transcripts
arraynull
List of transcripts for the episode. May not be reported.
count
integer
Number of items returned in request
id_person
integer
The internal PodcastIndex.org person ID.
feedurl_query
string
Value passed to request in the feedurl parameter. If no feedurl passed, value will be null.
liveitem_podcast
object
29 properties
img
string
URL to a picture or avatar of the person. See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.mdperson) f…
item_itunesId
object
31 properties
duration_soundbite
integer
The length to play the item specified by the enclosureUrl
max
integernull
Value of max parameter passed to request.
status
string
Indicates API request status
startTime
integer
The time where the soundbite begins in the item specified by the enclosureUrl
id_query
string
Value passed to request in the id field
enclosureUrl
string
URL/link to the episode file
name_destination
string
Name for the destination
customKey
stringnull
The name of a custom record key to send along with the payment. May not be reported. See the [podcast namespace spec](https://github.com/Podcastindex-org/podca…
items_podcast
array
List of episodes matching request
liveItems_podcast
array
List of live episodes for feed
link_feed
string
The channel-level link in the feed
image_feed
string
The channel-level image element.
query_podcast_id_multiple
array
IDs passed to request
accountUrl_socialInteract
string
The public url (on the commenting platform) of the account that created this root post.
imageUrlHash
integer
A CRC32 hash of the image URL with the protocol (http://, https://) removed. 64bit integer.
id_feed
integer
The internal PodcastIndex.org Feed ID.
feedImageUrlHash
integer
A CRC32 hash of the feedImage URL with the protocol (http://, https://) removed.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PodcastIndex publishes across the network.