### API Endpoint: Pagination Link Header Example Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Shows an example of the `Link` HTTP header used for navigating through paginated API results, providing URLs for the next, first, and last pages. ```HTTP Link: ; rel="next", ; rel="first", ; rel="last" ``` -------------------------------- ### Example JSON Response for Curation Data Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md An example JSON response showing the structure of curation data, including title, ID, description, various image URLs, and categories for multiple curated items. ```json { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Netzpolitik", "id": 623, "description": "Vorsicht, k\u00f6nnte Spuren von Netzpolitik enthalten!", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/623.jpg?et=", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/623.png?et=", "smallImageURL": "https:\/\/img.fyyd.de\/curation\/small\/623.jpg?et=", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/623.png?et=", "public": 1, "slug": "netzpolitik", "user_id": 1000, "type": 1, "categories": [ 52, 39, 27 ], "url": "https:\/\/fyyd.de\/user\/eazy\/curation\/netzpolitik", "xmlURL": "https:\/\/feeds.fyyd.de\/eazy\/netzpolitik" }, { "title": "Empfehlungen von chkpnt", "id": 649, "description": "Von mir f\u00fcr gut befundene Podcastfolgen.", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/649.jpg?et=", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/649.png?et=", "smallImageURL": "https:\/\/img.fyyd.de\/curation\/small\/649.jpg?et=", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/649.png?et=", "public": 1, "slug": "public", "user_id": 1122, "type": 1, "categories": [ 52, 55, 39 ], "url": "https:\/\/fyyd.de\/user\/chkpnt\/curation\/public", "xmlURL": "https:\/\/feeds.fyyd.de\/chkpnt\/public" } ] } ``` -------------------------------- ### GET /podcast/recommend API Endpoint Documentation Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Documents the GET /podcast/recommend endpoint, which retrieves recommended podcasts. Recommendations are currently based on collection information. It specifies the required and optional parameters for the request. ```APIDOC GET /podcast/recommend Description: Gets information about what fyyd thinks, might be a good idea to listen to also. At the moment, this is based on collections information. Parameters: podcast_id (required, int): The Podcast's id or podcast_slug (alternative, string): The podcast's slug count (optional, int): The number of recommended podcasts, default: 10 ``` -------------------------------- ### API Endpoint: Retrieve Latest Episodes Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Documents the GET /episode/latest endpoint, which fetches a list of the most recently added episodes. Supports optional parameters for pagination and starting point. Includes an example successful response. ```APIDOC GET /episode/latest Description: Returns information about the last added episodes. Provide a count and/or an ID to be the starting point. Parameters: since_id (optional, int): the last episode's id you know of. Get the episodes added after that ID. Maximum: 1000 episodes. count (optional, int, default: 20): get the latest count nums of episodes. Response Example: { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "CR123 Biometrische Vollerfassung", "id": 3334, "guid": "http:\/\/chaosradio.ccc.de\/cr123.html", "url": "http:\/\/chaosradio.ccc.de\/cr123.html", "enclosure": "http:\/\/chaosradio.ccc.de\/archive\/chaosradio_123.mp3", "podcast_id": 119, "imgURL": "https:\/\/img.fyyd.de\/pd\/layout\/119.jpg", "pubdate": "2007-05-06T03:20:00+02:00", "duration": 10777, "url_fyyd": "https:\/\/fyyd.de\/episode\/3334", "description": "Fotofahndung, zentrale Fingerabdruckdatei und die Personenkennziffer" }, { "title": "CR122 Der Bundestrojaner", "id": 3335, "guid": "http:\/\/chaosradio.ccc.de\/cr122.html", "url": "http:\/\/chaosradio.ccc.de\/cr122.html", "enclosure": "http:\/\/chaosradio.ccc.de\/archive\/chaosradio_122.mp3", "podcast_id": 119, "imgURL": "https:\/\/img.fyyd.de\/pd\/layout\/119.jpg", "pubdate": "2007-03-29T13:00:00+02:00", "duration": 10603, "url_fyyd": "https:\/\/fyyd.de\/episode\/3335", "description": "Nie wurden Ihre Grundrechte so verletzt..." } ] } ``` -------------------------------- ### API Endpoint: Get All Categories Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Documents the `GET /categories` endpoint, which retrieves the complete category tree and requires no parameters. ```APIDOC GET /categories Description Gets the complete categories tree Parameters none ``` -------------------------------- ### API Endpoint: Get Latest Podcasts Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Documentation for the `/podcast/latest` API endpoint, which retrieves information about recently added podcasts. It includes details on parameters for filtering by ID or count, and an example JSON response. ```APIDOC Endpoint: GET /podcast/latest Description: Returns information about the last added podcasts. Provide a count and/or an ID to be the starting point. Parameters: - since_id (optional, int): the last podcast's id you know of. Get the podcasts added after that ID. Maximum: 1000 episodes. - count (optional, int, default: 20): get the latest count nums of podcasts. ``` ```json { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Polytox Podcast (Polytox-Podcast)", "id": 49782, "xmlURL": "http:\/\/polytox.org\/feed\/mp3\/", "htmlURL": "http:\/\/polytox.org\/polytox-podcast", "imgURL": "http:\/\/polytox.org\/wp-content\/cache\/podlove\/a3\/c6f4f8b44edc93e3b7b3ef2205f69c\/polytox-podcast_original.jpg", "status": 200, "slug": "polytox-podcast-polytox-podcast", "layoutImageURL": "https:\/\/img.fyyd.de\/pd\/layout\/49782.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/pd\/thumbs\/49782.png", "smallImageURL": "https:\/\/img.fyyd.de\/pd\/small\/49782.jpg", "microImageURL": "https:\/\/img.fyyd.de\/pd\/micro\/49782.png", "language": "de", "lastpoll": "2017-11-06T20:10:05+01:00", "generator": "Podlove Podcast Publisher v2.6.2", "categories": [], "lastpub": "2017-11-05T17:04:18+01:00", "rank": null, "url_fyyd": "https:\/\/fyyd.de\/podcast\/polytox-podcast-polytox-podcast\/0", "description": "Der Podcast des Polytox Zines mit Falk Fatal. Jede Folge gibt es Punk, Pop & Papperlapapp rund um die Subkultur.", "subtitle": "Der Subkultur-Podcast", "episode_count": 15 } ] } ``` -------------------------------- ### API Parameters and Response for Episode Search Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Details the parameters available for searching episodes, including criteria like title, GUID, podcast ID, and publication date. It also provides an example of the successful JSON response structure for an episode search query. ```APIDOC Parameters: * title (optional, string): the episode's title. Search might use parts of the string to find the episode. * guid (optional, string): the episode's GUID as stated inside the podcasts feed. * podcast_id (optional, int): the podcast's id in fyyd's database. * podcast_title (optional, string): the podcast's title. Search might use parts of the string to find the podcast. * pubdate (optional, string): the pubDate as stated inside the podcasts feed. * duration (optional, int): the duration of the episode in seconds. * url (optional, string): the episode's url as stated inside the podcast's feed. * term (optional,string): a search term to find inside the episodes. Please note: title, guid, pubdate, duration, url and term add episodes together. Think of a logical OR. In contrast to that, podcast_id and podcast_title restrict all episodes to podcasts matching to one of podcast_id or podcast_title. * count (optional, int, default: 10) ``` ```JSON { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "FS195 Dein Butler ist ein Zombie", "id": 1597636, "guid": "podlove-2017-03-22t23:23:57+00:00-f1bfca935c876bc", "url": "http:\/\/freakshow.fm\/fs195-dein-butler-ist-ein-zombie", "enclosure": "https:\/\/tracking.feedpress.it\/link\/13453\/5554460\/fs195-dein-butler-ist-ein-zombie.m4a", "podcast_id": 85, "imgURL": "", "pubdate": "2017-03-23 02:16:34", "duration": 14632, "url_fyyd": "https:\/\/fyyd.de\/episode\/1597636", "description": "\n

Open Source Development \u2014 Ultraschall \u2014 Podlove Publisher \u2014 Podcast Empanzipation \u2014 Thunderbolt..." } ] } ``` -------------------------------- ### Example Podcast Data JSON Response Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md A sample JSON response demonstrating the structure of podcast data returned by the fyyd-api, including details like title, ID, URLs, and descriptive information. ```json { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Explikator", "id": 158, "xmlURL": "http:\/\/explikator.de\/feed\/podcast\/", "htmlURL": "http:\/\/explikator.de\/podcast", "imgURL": "http:\/\/explikator.de\/wp-content\/cache\/podlove\/ed\/92555a31e2f10f4922dd5b5b8b2b77\/explikator_original.png", "status": 304, "slug": "explikator", "layoutImageURL": "https:\/\/img.fyyd.de\/pd\/layout\/158.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/pd\/thumbs\/158.png", "microImageURL": "https:\/\/img.fyyd.de\/pd\/micro\/158.png", "language": "de", "lastpoll": "2017-04-23 10:13:56", "generator": "Podlove Podcast Publisher v2.3.18", "user_id": null, "categories": [ 52 ], "lastpub": "2017-04-20 00:01:21", "rank": 29, "url_fyyd": "https:\/\/fyyd.de\/podcast\/158", "description": "Jeden Werktag 10 Minuten Podcast und ein neuer Musiktitel. Themen sind Wissenschaft, Bewusstsein, Geschichte, Film & TV und Entertainment. Unbekanntes & Unbeachtetes, Hintergrund & Oberfl\u00e4che. Mal ernster, mal satirischer aber immer Morgen-Kaffee-tauglich!", "subtitle": "Morgenradio 2.0: Jeden Werktag 10 Minuten Unbeachtetes & Unbekanntes aus Gesellschaft und Kultur." } ] } ``` -------------------------------- ### Example JSON Response for User Collections Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md A sample JSON response illustrating the data structure returned when querying user collections, including collection metadata and image URLs. ```JSON { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Netzpolitik", "id": 1, "description": "(Netz)politische Podcasts", "layoutImageURL": "https:\/\/img.fyyd.de\/collection\/layout\/1.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/collection\/thumbs\/1.png", "microImageURL": "https:\/\/img.fyyd.de\/collection\/micro\/1.png", "slug": "netzpolitik", "url": "https:\/\/fyyd.de\/user\/eazy\/collection\/netzpolitik" }, { "title": "Gamechanger", "id": 8, "description": "", "layoutImageURL": "https:\/\/img.fyyd.de\/collection\/layout\/8.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/collection\/thumbs\/8.png", "microImageURL": "https:\/\/img.fyyd.de\/collection\/micro\/8.png", "slug": "gamechanger", "url": "https:\/\/fyyd.de\/user\/eazy\/collection\/gamechanger" }, { "title": "Lieblingspodcasts", "id": 11, "description": "Was ich so mit auf die Insel nehmen w\u00fcrde..", "layoutImageURL": "https:\/\/img.fyyd.de\/collection\/layout\/11.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/collection\/thumbs\/11.png", "microImageURL": "https:\/\/img.fyyd.de\/collection\/micro\/11.png", "slug": "lieblingspodcasts", "url": "https:\/\/fyyd.de\/user\/eazy\/collection\/lieblingspodcasts" } ] } ``` -------------------------------- ### API Endpoint: Get User Collections and Podcasts Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Describes the GET /user/collections endpoint for retrieving a user's maintained collections. The optional '/podcasts' path includes the content of these collections. ```APIDOC GET /user/collections[/podcasts] Description: Retrieves the collections maintained by the given user. You may append /podcasts to also get the content of this collections. Parameters: - user_id (required, int) the users account id - or nick (optional, string) identifies the user by nick ``` -------------------------------- ### API Endpoint: Get Hot Podcast Languages Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md This section documents the GET /feature/podcast/hot/languages endpoint, which retrieves a list of languages that have 50 or more podcasts listed and for which hotness values are calculated. It specifies that the endpoint takes no parameters and provides an example JSON response. ```APIDOC GET /feature/podcast/hot/languages Description: As described above, only for all languages with 50 or more podcasts listed, hotness values are calculated. To get these languages, take this request. Parameters: none Response: { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 }, "SERVER": "195.201.115.6", "duration": 0 }, "data": [ "en", "fr", "ru", "it", "de", "es", "nl" ] } ``` -------------------------------- ### API Endpoint: Retrieve Single Episode Information Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Documents the GET /episode endpoint, which allows fetching detailed information for a specific episode using its ID. Includes parameters and an example successful response. ```APIDOC GET /episode Description: Returns information about a single episode Parameters: episode_id (required, int): the episode's id Response Example: { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": { "title": "Space Hulk (Stay Forever, Folge 33)", "id": 42, "guid": "796a53669cb29b0504fdd4f0a3f9a41d", "url": "http:\/\/kaliban.podspot.de\/files\/Stay_Forever_Ep33_Space_Hulk.mp3", "enclosure": "http:\/\/kaliban.podspot.de\/files\/Stay_Forever_Ep33_Space_Hulk.mp3", "podcast_id": 5, "imgURL": "", "pubdate": "2014-03-06 18:10:30", "duration": null, "url_fyyd": "https:\/\/fyyd.de\/episode\/42", "description": "Christian hasst Space Hulk, Gunnar liebt es. Fight!" } } ``` -------------------------------- ### Example JSON Response for Collection Data Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates the structure of a successful API response containing a list of collection objects, including metadata and pagination details. ```JSON { "status": 1, "msg": "ok", "meta": { "paging": { "count": 3, "page": 0, "first_page": 0, "last_page": 19, "next_page": 1, "prev_page": null }, "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Hört das!", "id": 48, "description": "", "layoutImageURL": "https:\/\/fyyd.de\/images\/collection300.png?et=", "smallImageURL": "https:\/\/fyyd.de\/images\/collection300.png?et=", "thumbImageURL": "https:\/\/fyyd.de\/images\/collection80.png?et=", "microImageURL": "https:\/\/fyyd.de\/images\/collection20.png?et=", "slug": "88610109b7c51842990bcfdbc1938696", "user_id": 1111, "url": "https:\/\/fyyd.de\/user\/Lesefreude\/collection\/88610109b7c51842990bcfdbc1938696" }, { "title": "Bildung\/Schule\/Sozio", "id": 64, "description": "", "layoutImageURL": "https:\/\/fyyd.de\/images\/collection300.png?et=", "smallImageURL": "https:\/\/fyyd.de\/images\/collection300.png?et=", "thumbImageURL": "https:\/\/fyyd.de\/images\/collection80.png?et=", "microImageURL": "https:\/\/fyyd.de\/images\/collection20.png?et=", "slug": "bildung-schule-sozio", "user_id": 1135, "url": "https:\/\/fyyd.de\/user\/Anke\/collection\/bildung-schule-sozio" } ] } ``` -------------------------------- ### Example FYYD API Response Structure Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md This snippet shows a typical JSON response structure from the FYYD API, including metadata, server information, and detailed podcast data such as title, URLs, status, language, and statistics. ```JSON { "status": 1, "msg": "ok", "meta": { "count": 1, "API_INFO": { "API_VERSION": "0.2" }, "SERVER": "195.201.115.6", "duration": 1 }, "data": [ { "title": "Stormpeonz", "id": 54528, "xmlURL": "http:\/\/www.stormpeonz.com\/feed\/peonzradio-feed\/", "htmlURL": "http:\/\/www.stormpeonz.com", "imgURL": "http:\/\/www.stormpeonz.com\/wp-content\/uploads\/2019\/02\/Podcast.png", "status": 200, "slug": "stormpeonz", "layoutImageURL": "https:\/\/img-1.fyyd.de\/pd\/layout\/5452850f1f8d7dc1331b7bc9d71e01225b87b.jpg", "thumbImageURL": "https:\/\/img-1.fyyd.de\/pd\/thumbs\/5452850f1f8d7dc1331b7bc9d71e01225b87b.png", "smallImageURL": "https:\/\/img-1.fyyd.de\/pd\/small\/5452850f1f8d7dc1331b7bc9d71e01225b87b.jpg", "microImageURL": "https:\/\/img-1.fyyd.de\/pd\/micro\/5452850f1f8d7dc1331b7bc9d71e01225b87b.png", "language": "de", "lastpoll": "2018-12-12T09:08:41+01:00", "generator": "Podlove Podcast Publisher v3.0.4", "categories": [ 142, 150 ], "lastpub": "2020-07-27T13:19:15+02:00", "rank": 2, "url_fyyd": "https:\/\/fyyd.de\/podcast\/stormpeonz\/0", "description": "Einmal die Woche besprechen wir das aktuelle Weltgeschehen aus dem Bereich Gaming, oder aber auch nicht so aktuelle Sachen.", "subtitle": "Der wöchentliche Gaming Podcast mit Sven und Thomas.", "tcolor": "#fff", "color": "#103424", "episode_count": "33", "iflags": null, "paymentURL": null, "author": "Thomas, Sven", "stats": { "medianduration": 0, "medianduration_string": "0m", "episodecount": 33, "pubinterval": 7, "pubinterval_string": "wöchentlich", "pubinterval_value": 7, "pubinterval_type": 2 } } ] } ``` -------------------------------- ### Example API Response for Podcast Data Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates the typical JSON structure returned by the fyyd API for podcast information, including metadata, podcast details, and a list of episodes. It shows pagination details, API version, and comprehensive podcast attributes. ```json { "status": 1, "msg": "ok", "meta": { "paging": { "count": 50, "page": 0, "first_page": 0, "last_page": 0, "next_page": null, "prev_page": null }, "API_INFO": { "API_VERSION": 0.2 } }, "data": { "title": "Raumzeit", "id": 703, "xmlURL": "https:\/\/feeds.metaebene.me\/raumzeit\/m4a", "htmlURL": "http:\/\/raumzeit-podcast.de", "imgURL": "https:\/\/meta.metaebene.me\/media\/raumzeit\/raumzeit-icon-1400x1400.jpg", "status": 200, "slug": "raumzeit", "layoutImageURL": "https:\/\/img.fyyd.de\/pd\/layout\/703.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/pd\/thumbs\/703.png", "smallImageURL": "https:\/\/img.fyyd.de\/pd\/small\/703.jpg", "microImageURL": "https:\/\/img.fyyd.de\/pd\/micro\/703.png", "language": "de", "lastpoll": "2018-01-21T11:04:01+01:00", "generator": "Podlove Podcast Publisher v2.7.0.build467", "categories": [ 48, 62 ], "lastpub": "2018-01-20T11:03:23+01:00", "rank": 46, "url_fyyd": "https:\/\/fyyd.de\/podcast\/raumzeit\/0", "description": "Raumzeit ist eine Serie von Gespr\u00e4chen mit Wissenschaftlern, Ingenieuren, Astronauten und Projektleitern \u00fcber Raumfahrt. Jede Episode r\u00fcckt einen Themenbereich in den Fokus und diskutiert ausf\u00fchrlich alle Aspekte und Details. ", "subtitle": "Raumfahrt und kosmische Angelegenheiten", "episode_count": 68, "episodes": [ { "title": "Philae", "id": 24580, "guid": "podlove-2015-04-28t23:48:53+00:00-4a76622f3e60548", "url": "http:\/\/raumzeit-podcast.de\/2015\/06\/16\/rz058-philae\/", "enclosure": "https:\/\/tracking.feedpress.it\/link\/13437\/1885139\/rz058-philae.m4a", "podcast_id": 703, "imgURL": "https:\/\/meta.metaebene.me\/media\/raumzeit\/rz058-philae.jpg", "pubdate": "2015-06-16T19:51:06+02:00", "duration": 5587, "status": 200, "num_season": 2, "num_episode": 58, "url_fyyd": "https:\/\/fyyd.de\/episode\/24580", "description": "...", "chapters": [ { "start": "00:00:00.000", "start_ms": 0, "title": "Intro" } ], "content_type": "audio\/mp4" } ] } } ``` -------------------------------- ### Example JSON Response for Categories API Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates the structure of a successful response from an API endpoint, showing a list of categories and their subcategories, including localized names and API version information. ```JSON { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "id": 1, "slug": "arts", "name": "Arts", "name_de": "Kunst", "subcategories": [ { "id": 2, "slug": "design", "name": "Design", "name_de": "Design" }, { "id": 3, "slug": "fashion-beauty", "name": "Fashion & Beauty", "name_de": "Mode & Schönheit" }, { "id": 4, "slug": "food", "name": "Food", "name_de": "Essen" }, { "id": 5, "slug": "literature", "name": "Literature", "name_de": "Literatur" }, { "id": 6, "slug": "performing-arts", "name": "Performing Arts", "name_de": "Darstellende Künste" }, { "id": 7, "slug": "visual-arts", "name": "Visual Arts", "name_de": "Bildende Künste" } ] }, { "id": 8, "slug": "business", "name": "Business", "name_de": "Wirtschaft", "subcategories": [ { "id": 9, "slug": "business-news", "name": "Business News", "name_de": "Wirtschaftsnachrichten" }, { "id": 10, "slug": "careers", "name": "Careers", "name_de": "Karriere" }, { "id": 11, "slug": "investing", "name": "Investing", "name_de": "Geldanlage" }, { "id": 12, "slug": "management-marketing", "name": "Management & Marketing", "name_de": "Management & Markteting" }, { "id": 13, "slug": "shopping", "name": "Shopping", "name_de": "Shopping" } ] }, { "id": 14, "slug": "comedy", "name": "Comedy", "name_de": "Komödien", "subcategories": [] } ] } ``` -------------------------------- ### API Endpoint: Get Podcast List Parameters Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Describes the optional query parameters `page` and `count` for paginating podcast list results, specifying their types and default values. ```APIDOC - **page (optional, int)** the page you want to address, default: 0 - **count (optional,int)** the page's size, default: 50 ``` -------------------------------- ### Example API Response for Curation Addition Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates a typical successful API response structure, including status, message, metadata, and a data payload indicating an action like adding an item to a curation. ```JSON { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": { "state": 1, "text": "added AdH039: Singende Nonne to TestKuration" } } ``` -------------------------------- ### API Endpoint: Get Podcast Information (GET /podcast/[/episodes]) Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md This endpoint retrieves detailed information about a specific podcast identified by its ID or slug. Optionally, appending '/episodes' allows fetching the podcast's episodes. Results can be paginated using 'page' and 'count' parameters. ```APIDOC GET /podcast/[/episodes] Description: Gets information about the podcast with id {id}. You may retrieve the episodes by appending /episodes. Additionally you can address the resultset with {page} and {count}. Parameters: podcast_id (required, int): the podcast's id or podcast_slug (alternative, string): the podcast's slug page (optional, int): the page you want to address, default: 0 count (optional,int): the page's size, default: 50 ``` -------------------------------- ### Example JSON Response for Curations API Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates the structure of a successful response from the Curations API, including metadata, paging information, and an array of curation objects with details like title, ID, description, image URLs, and categories. ```JSON { "status": 1, "msg": "ok", "meta": { "paging": { "count": 2, "page": 0, "first_page": 0, "last_page": 1, "next_page": 1, "prev_page": null }, "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Museumsfeed", "id": 593, "description": "Eine Zusammenstellung von Podcast-Episoden mit Museums- & Ausstellungsfokus: Besuche, Menschen, Projekte...", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/593.jpg?et=", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/593.png?et=", "smallImageURL": "https:\/\/img.fyyd.de\/curation\/small\/593.jpg?et=", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/593.png?et=", "public": 1, "slug": "museumsfeed", "user_id": 1097, "type": 1, "categories": [ 52, 1, 15 ], "url": "https:\/\/fyyd.de\/user\/tinowa\/curation\/museumsfeed", "xmlURL": "https:\/\/feeds.fyyd.de\/tinowa\/museumsfeed" }, { "title": "Netzpolitik", "id": 623, "description": "Vorsicht, k\u00f6nnte Spuren von Netzpolitik enthalten!", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/623.jpg?et=", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/623.png?et=", "smallImageURL": "https:\/\/img.fyyd.de\/curation\/small\/623.jpg?et=", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/623.png?et=", "public": 1, "slug": "netzpolitik", "user_id": 1000, "type": 1, "categories": [ 52, 39, 27 ], "url": "https:\/\/fyyd.de\/user\/eazy\/curation\/netzpolitik", "xmlURL": "https:\/\/feeds.fyyd.de\/eazy\/netzpolitik" } ] } ``` -------------------------------- ### API Endpoint: Get User Curations and Episodes Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Details the GET /user/curations endpoint, allowing retrieval of a user's maintained curations. The optional '/episodes' path includes curation content. Authenticated requests for one's own curations will also include non-public entries. ```APIDOC GET /user/curations[/episodes] Description: Retrieves the curations maintained by the given user. You may append /episodes to also get the content of this curations. If you're authenticated and you request your own curations, non-public curations will be included also. Parameters: - user_id (required, int) the users account id - or nick (optional, string) identifies the user by nick Response: { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Netzpolitik", "id": 623, "description": "Vorsicht, k\u00f6nnte Spuren von Netzpolitik enthalten!", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/623.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/623.png", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/623.png", "public": 1, "type": 1, "slug": "netzpolitik", "url": "https:\/\/fyyd.de\/user\/eazy\/curation\/netzpolitik", "xmlURL": "https:\/\/feeds.fyyd.de\/eazy\/netzpolitik" }, { "title": "Podcasting", "id": 586, "description": "Alles \u00fcber das Podcasting", "layoutImageURL": "https:\/\/img.fyyd.de\/curation\/layout\/586.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/curation\/thumbs\/586.png", "microImageURL": "https:\/\/img.fyyd.de\/curation\/micro\/586.png", "public": 1, "type": 1, "slug": "podcasting", "url": "https:\/\/fyyd.de\/user\/eazy\/curation\/podcasting", "xmlURL": "https:\/\/feeds.fyyd.de\/eazy\/podcasting" } ] } ``` -------------------------------- ### API Endpoint: Get Podcast List Response Structure Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Illustrates the JSON response structure for the podcast list endpoint, including pagination metadata and an array of detailed podcast objects. ```JSON { "status": 1, "msg": "ok", "meta": { "paging": { "count": 2, "page": 0, "first_page": 0, "last_page": 7094, "next_page": 1, "prev_page": null }, "API_INFO": { "API_VERSION": 0.2 } }, "data": [ { "title": "Freakonomics Radio", "id": 1, "xmlURL": "http:\/\/feeds.feedburner.com\/freakonomicsradio", "htmlURL": "http:\/\/www.wnyc.org\/articles\/freakonomics-podcast", "imgURL": "https:\/\/media2.wnyc.org\/i\/1400\/1400\/l\/80\/1\/wn16_wnycstudios_freakonomics-rev3.png", "status": 390, "slug": "freakonomics-radio", "layoutImageURL": "https:\/\/img.fyyd.de\/pd\/layout\/1.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/pd\/thumbs\/1.png", "microImageURL": "https:\/\/img.fyyd.de\/pd\/micro\/1.png", "language": "en", "lastpoll": "2017-04-16 00:34:49", "generator": null, "categories": [ 52 ], "lastpub": "2017-03-16 04:00:00", "rank": 1, "url_fyyd": "https:\/\/fyyd.de\/podcast\/1", "description": "Have fun discovering the hidden side of everything with host Stephen J. Dubner, co-author of the best-selling \"Freakonomics\u201d books. Each week, hear surprising conversations that explore the riddles of everyday life and the weird wrinkles of human nature\u2014from cheating and crime to parenting and sports. Dubner talks with Nobel laureates and provocateurs, social scientists and entrepreneurs \u2014 and his \u201cFreakonomics\u201d co-author Steve Levitt. After just a few episodes, this podcast will have you too thinking like a Freak. Produced by WNYC Studios, home of other great podcasts such as \u201cRadiolab,\" \"Death, Sex & Money,\" and \"On the Media.\" ", "subtitle": "Have fun discovering the hidden side of everything with host Stephen J. Dubner, co-author of the best-selling \"Freakonomics\u201d books. Each week, hear surprising conversations that explore the riddles of everyday life and the weird wrinkles of human nature\u2014f" }, { "title": "Skeptoid", "id": 3, "xmlURL": "http:\/\/skeptoid.com\/podcast.xml", "htmlURL": "https:\/\/skeptoid.com", "imgURL": "http:\/\/skeptoid.com\/images\/1500b.jpg", "status": 304, "slug": "skeptoid", "layoutImageURL": "https:\/\/img.fyyd.de\/pd\/layout\/3.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/pd\/thumbs\/3.png", "microImageURL": "https:\/\/img.fyyd.de\/pd\/micro\/3.png", "language": "en", "lastpoll": "2017-04-17 02:39:44", "generator": null, "categories": [ 52 ], "lastpub": "2017-04-11 02:00:00", "rank": 1, "url_fyyd": "https:\/\/fyyd.de\/podcast\/3", "description": "Since 2006, the weekly Skeptoid podcast has been taking on all the most popular myths and revealing the true science, true history, and true lessons we can learn from each. Free subscribers get the most recent 50 episodes, premium subscribers (skeptoid.com) can access the full archive, all ad-free.", "subtitle": "A weekly look at the true facts behind urban legends and stories you've probably heard." } ] } ``` -------------------------------- ### API Endpoint: GET /curation[/episodes] Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Describes the API endpoint for retrieving information about a single curation. It explains that episodes can be appended, authentication requirements for accessing non-public curations, and the required parameters. ```APIDOC Endpoint: GET /curation[/episodes] Description: Returns information about a single curation, given the curation's id. May append episodes, not paged at the moment. If you're authenticated and you request your own curation, non-public curations will be accessable too. Authorization: required for getting your own curation, otherwise you only get public curations. Parameters: curation_id (required, int): the curation's id ``` -------------------------------- ### API Endpoint: GET /account/info Source: https://github.com/eazyliving/fyyd-api/blob/master/README.md Retrieves general information about the authenticated user's account. This endpoint requires authorization. ```APIDOC GET /account/info Description: Returns general information about the account Parameters: none Authorization: required Response: { "status": 1, "msg": "ok", "meta": { "API_INFO": { "API_VERSION": 0.2 } }, "data": { "nick": "your-nick", "id": 42, "fullname": "Jon Doe", "bio": "This is me!", "url": "https:\/\/fyyd.de\/", "layoutImageURL": "https:\/\/img.fyyd.de\/user\/layout\/42.jpg", "thumbImageURL": "https:\/\/img.fyyd.de\/user\/thumbs\/42.png", "microImageURL": "https:\/\/img.fyyd.de\/user\/micro\/42.png" } } ```