-
-
Notifications
You must be signed in to change notification settings - Fork 718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
API Documentation #395
Comments
There is API, but it's currently undocumented, it's something that has to be done. The official client (this repository) uses it. The list of API instances can be found at https://github.com/TeamPiped/Piped/wiki/Instances |
OK. So this issue is now based around documenting the API. |
Some basic documentation for the Streams API has been added, let me know what you think about it: https://piped-docs.kavin.rocks/docs/api-documentation/, I'll be adding the remaining within the next few days hopefully.
|
documentatoin |
Whoops, that's fixed now! |
More API documentation has been added, precisely comments, trending, playlists, search suggestions, and sponsors/SponsorBlock. The Search API is subject to a lot of changes, so that will be added later. Are you interested in the private/authenticated API too? If not, I will defer the writing of documentation for that. |
I mean yes it would be useful for authenticated use. Would make sense so more people can interact with this project. |
This just some notes I found when I was trying to implement your API in my script
|
All of these should be already documented with the exception of search. You can find a list of accepted countries at: |
I know I am about a year or so late but is it possible that:
I need this for a python script I am trying to create for searching different platforms and I would like to show comments, for that I need to get the videoId which is harder to get when for some reason "/wach?v=" is in the url value. |
You can use the following regex to extract the ID: Python code:
|
Are we able to get updated docs for the current state of the API? Many routes such as search are still undocumented. |
You can have a look at https://elements-demo.stoplight.io/?spec=https://raw.githubusercontent.com/TeamPiped/OpenAPI/main/swagger.yaml#/operations/trending, however many routes are still not present. (such as search) I will take a look at adding it in the near future. |
I think this addition would be really good for developers. |
(edit: read below two comments)
Will there ever be api support so apps can use the Piped Extraction?
Invidious has api support and services like FreeTube cannot interact with it unless it is through the UI.
The text was updated successfully, but these errors were encountered: