podcastindexjs/src/schemas/1.0/episodes-byfeedid.json

client-side JS library for interacting with the Podcast Index API

{
  "title": "`/api/1.0/episodes/byfeedid` - This call returns all the episodes we know about for this feed, in reverse chronological order",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["true"]
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/PIApiEpisodeInfo"
      }
    },
    "count": {
      "type": "number"
    },
    "query": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": ["count", "description", "items", "query", "status"],
  "definitions": {
    "PIApiEpisodeInfo": {
      "description": "Returned by episodesByFeed*, episodesByItunesId",
      "type": "object",
      "properties": {
        "duration": {
          "type": "number"
        },
        "transcriptUrl": {
          "type": ["null", "string"]
        },
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "link": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "guid": {
          "type": "string"
        },
        "datePublished": {
          "type": "number"
        },
        "datePublishedPretty": {
          "type": "string"
        },
        "dateCrawled": {
          "type": "number"
        },
        "enclosureUrl": {
          "type": "string"
        },
        "enclosureType": {
          "type": "string"
        },
        "enclosureLength": {
          "type": "number"
        },
        "explicit": {
          "type": "number"
        },
        "episode": {
          "type": ["null", "number"]
        },
        "episodeType": {
          "type": ["null", "string"]
        },
        "season": {
          "type": "number"
        },
        "image": {
          "description": "URL to episode image",
          "type": "string"
        },
        "feedItunesId": {
          "type": ["null", "number"]
        },
        "feedImage": {
          "description": "URL to feed image",
          "type": "string"
        },
        "feedId": {
          "type": "number"
        },
        "feedLanguage": {
          "type": "string"
        },
        "chaptersUrl": {
          "type": ["null", "string"]
        },
        "soundbite": {
          "type": "object",
          "properties": {
            "startTime": {
              "type": "number"
            },
            "duration": {
              "type": "number"
            },
            "title": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": ["duration", "startTime", "title"]
        },
        "soundbites": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "startTime": {
                "type": "number"
              },
              "duration": {
                "type": "number"
              },
              "title": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": ["duration", "startTime", "title"]
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "chaptersUrl",
        "dateCrawled",
        "datePublished",
        "datePublishedPretty",
        "description",
        "duration",
        "enclosureLength",
        "enclosureType",
        "enclosureUrl",
        "episode",
        "episodeType",
        "explicit",
        "feedId",
        "feedImage",
        "feedItunesId",
        "feedLanguage",
        "guid",
        "id",
        "image",
        "link",
        "season",
        "title",
        "transcriptUrl"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}