PodcastIndex.org API

https://podcastindex-org.github.io/docs-api
Admin
PodcastIndex.org API provides programmatic access to podcast data and services for developers.
Tokens:942
Snippets:7
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Podcast Index API Request Bash Example

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

This bash command demonstrates a hypothetical GET request to the Podcast Index API's search endpoint, including necessary headers for authentication (API key and date) and user agent. It shows how to make authenticated requests to the API.

```bash
# Example: API authentication (hypothetical, based on typical API structure)
curl -X GET "https://api.podcastindex.org/api/1.0/search/byterm?q=javascript" \
  -H "X-Auth-Key: YOUR_API_KEY" \
  -H "X-Auth-Date: $(date +%s)" \
  -H "User-Agent: MyPodcastApp/1.0"

```

--------------------------------

### Repository Index Markdown

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

This markdown snippet serves as the entry point for the documentation, indicating that JavaScript is required and providing links to download OpenAPI specifications and the main Podcast Index site.

```markdown
Revert Settings
# API Docs | PodcastIndex.org
The documentation requires JavaScript to be enabled.
Download the documentation in openapi spec in json or yaml format.
Additional information in the docs api git repo
Podcast Index main site: https://podcastindex.org/

```

--------------------------------

### Download OpenAPI Specs Bash Commands

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

These bash commands demonstrate how to download the OpenAPI specification for the Podcast Index API in JSON and YAML formats using curl. This allows for programmatic access to the API definition.

```bash
# Access the live documentation (requires web browser with JavaScript)
# URL: https://podcastindex-org.github.io/docs-api/

# The live site provides:
# - Complete API endpoint reference
# - OpenAPI 3.0 specification downloads (JSON/YAML)
# - Interactive API explorer
# - Authentication documentation
# - Code examples in multiple languages
# - Rate limiting information

# Alternative: Download OpenAPI spec for programmatic access
curl -O https://podcastindex-org.github.io/docs-api/openapi.json
curl -O https://podcastindex-org.github.io/docs-api/openapi.yaml

```

--------------------------------

### Repository Structure Bash Command

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

This bash command lists the contents of a repository directory, showing the basic file structure including README.md and index.md.

```bash
# List repository contents
ls -la /path/to/repo/

# Output:
# total 20
# drwxr-xr-x 3 root root 4096 Oct 14 13:55 .
# drwxr-xr-x 3 root root 4096 Oct 14 13:55 ..
# drwxr-xr-x 8 root root 4096 Oct 14 13:55 .git
# -rw-r--r-- 1 root root   83 Oct 14 13:55 README.md
# -rw-r--r-- 1 root root  265 Oct 14 13:55 index.md

```

--------------------------------

### Git Log Bash Commands

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

These bash commands display the Git commit history for the repository, showing a single initialization commit with details about the commit author, date, and files added.

```bash
# View repository history
git log --oneline

# Output:
# d25ea1e docs: upload 1 documentation files

# View detailed commit information
git log -1 --format=full

# Output shows:
# - Commit: d25ea1ed1432d5ddf24603ddd1e7db893f24d936
# - Author: Site2MD Bot
# - Date: October 14, 2025
# - Message: "docs: upload 1 documentation files"
# - Files: README.md, index.md added

```

--------------------------------

### Generate API Client Node.js Command

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

This command uses the OpenAPI Generator CLI to generate a TypeScript client for the Podcast Index API from a downloaded OpenAPI JSON specification. This facilitates integrating with the API in TypeScript projects.

```bash
# Use OpenAPI spec with API clients
# Example: Generate client code
npx @openapitools/openapi-generator-cli generate \
  -i openapi.json \
  -g typescript-axios \
  -o ./generated-client

```

--------------------------------

### Repository README Markdown

Source: https://context7.com/context7/podcastindex-org_github_io_docs-api/llms.txt

This markdown snippet identifies the repository and states its purpose as a documentation archive created by Site2MD.

```markdown
# podcastindex-org_github_io_docs-api

Documentation repository created by Site2MD.

```
Tokens:
Raw