Podcast Lists API

Podcast Lists are used to collect podcasts about one topic. On the website, podcast lists are available at https://gpodder.net/lists/

Create Podcast List

POST /api/2/lists/(username)/create.(format)
  • requires authenticaton
  • since 2.10
Query Parameters:
 
  • title – url-encoded title
Parameters:
  • username – username for which a new podcast list should be created
  • format – see Formats

The list content is sent in the request body, in the format indicates by the format extension

The server then generates a short name for the list from the title given in the Request. For example, from the title “My Python Podcasts” the name “my-python-podcasts” would be generated.

Status Codes:
  • 409 Conflict – if the the user already has a podcast list with the (generated) name
  • 303 See Other – the podcast list has been created at the URL given in the Location header

Get User’s Lists

GET /api/2/lists/(username).json
  • since 2.10

Example response:

HTTP/1.1 200 OK

[
    {
        "title": "My Python Podcasts",
        "name": "my-python-podcasts",
        "web": "http://gpodder.net/user/a-user/lists/my-python-podcasts"
    }
]
Status Codes:

Get a Podcast List

GET /api/2/lists/(username)/list/(listname).(format)
  • since 2.10
Parameters:
  • username – username to which the list belongs
  • listname – name of the requested podcast list
  • format – see Formats
Status Codes:
  • 200 OK – the podcast list is returned in in the requested format
  • 404 Not Found – if the user or the list do not exist

Update a Podcast List

PUT /api/2/lists/(username)/list/(listname).(format)
  • requires authentication
  • since 2.10
Parameters:
  • username – username to which the list belongs
  • listname – name of the requested podcast list
  • format – see Formats
Status Codes:

Delete a Podcast List

DELETE /api/2/lists/(username)/list/(listname).(format)
  • requires authentication
  • since 2.10
Parameters:
  • username – username to which the list belongs
  • listname – name of the requested podcast list
  • format – see Formats
Status Codes: