Skip to content
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

Can you provide some documentation on how the API actually works? #55

Open
Videogamer555 opened this issue Aug 13, 2023 · 1 comment
Open

Comments

@Videogamer555
Copy link

You obviously coded this software to work with the api's specifications. However I'm more interested in your documentation itself. Like what are the API endpoint URLs? What request type does it use(get or post)? Are the parameters for the requests sent in the request body, or in the URL string after the question mark? I assume you had to reverse engineer it to document it before you could implement it as you've done. Could you please post your actual documentation here?

@tombulled
Copy link
Owner

Hi @Videogamer555, thanks for opening this issue. Producing documentation for the API has been on my roadmap for quite a while now, however I haven't managed to get around to it just yet. YouTube's InnerTube API changes often, so keeping up with it can be quite a challenge. At least for now, the code base is the best thing I can provide in terms of documentation, which I appreciate is not ideal. As this library is designed for low-level interactions with the InnerTube API, it provides a mechanism for communicating with the API, and knowing which endpoints to hit, which data to provide etc. is currently left as an exercise for the user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants