A asynchronous implementation of the invidious innertube aka youtubei API wrapper

11Tuvork28

Last update: Dec 22, 2022

Related tags

Learning Resources rust youtube-api wrapper-api tokio-rs innertube innertubeapi

Overview

youtubei-rs

A asynchronous implementation of the invidious innertube aka youtubei API wrapper.
Using tokio,reqwest, serde and serde_json.

Configuration

The client_config can be configured to dump the json response to a file if its not parsable,
this is on by default when using the default_client_config() function.
When creating the client_config manually you can parse true/false as the last parameter to disable this behavior.

Roadmap

implementing proxy support
removing panics
adding more endpoints

Implemented endpoints

next
browse
search
resolve_url
player

Supported queries

next_video_id // Get next(aka related and comments) results for a given videoId
next_continuation // Fetch more next(aka related and comments) results for a given ctoken
browse_id // Get browse(aka a channel or playlist) results for a given browseId
browse_continuation // Fetch more browse(aka a channel or playlist) results for a given ctoken
resolve, // Resolve a given url
player // Get player data for a given videoId

Example

use youtubei_rs::{query::player, utils::default_client_config, types::query_results::PlayerResult};
#[tokio::main]
async fn main() {
    // create default client_config with WEB client
    let client_config = &default_client_config();
    // get player for video with id gC6dQrScmHE
    let player: PlayerResult = player(String::from("gC6dQrScmHE"),String::from(""),&client_config).await.unwrap();
    println!("{}",player.video_details.title); // video title
}

With logging

For logging tracing is used so tracing_subscribe can be installed for easier use of tracing. The library has as target youtubei_rs with debug,trace and error levels.

use youtubei_rs::{query::player, utils::default_client_config};
#[tokio::main]
async fn main() {
    std::env::set_var("RUST_LOG", "youtubei_rs=debug");
    tracing_subscriber::fmt::init();
    // create default client_config with WEB client
    let client_config = &default_client_config();
    // get player for video with id gC6dQrScmHE
    let player: PlayerResult = player(String::from("gC6dQrScmHE"),String::from(""),&client_config).await.unwrap();
    println!("{}",player.video_details.title); // video title
}

Supported queries (legacy)

get_video: Fetches all information about the video except captions and storyboards
get_channel_info: Fetches all channel information and about tab
get_channel_tab: Fetches a specific tab like videos to get channel videos
search: Search youtube
load_search: Continue search with ctoken
get_comments: Loads initial comments or more comments for video
load_related_videos: Loads more related videos
get_playlist: Loads a playlist

For more in depth info take a look at query.rs and tests.rs

Comments

[Trivial] Some code style changes
This PR mostly just changes some trivial code formatting. I hope it would be useful. A lot of it is subjective, but at times I just felt it looked better. I'm not trying to impose my own preference on you, so you are free to make any necessary changes.

It also does the following:

Adds clippy and rustfmt to the pipeline. I'm not sure if the pipeline has the a write permission or if I've done it correctly, so it might need to be replaced with the proper action.

Formats the code with rustfmt and applies some clippy suggestions. I've also added some line breaks to make it look less dense. I hope they make sense and separate different things correctly.

Fixes some Markdown formatting.
opened by walking-octopus 5
[Trivial] Logic optimisation + Typo/style corrections
Shortens the extract_author logic, also removing a mutable in favour of an inline conditional.

Fixes a few styling issues (lack of whitespace).

Typo corrections.

Compiled and tested! - cargo check && cargo test :heavy_check_mark:
opened by JSKitty 2
Add support for includingResultsForRenderer

includingResultsForRenderer found in search results when e.g searched via a hashtag, it shows what result are also included meaning result containing a different wording/writing
bug

opened by 11Tuvork28 0
Added json dump on error

This dumps the json response in the pwd directory the naming convention is json_dump_endpoint+ requested endpoint name e.g browse. This feature needs to be impoved in regards the names because it gets overwritten which is bad. The content of the file include request params, the error itself and the json data.

opened by 11Tuvork28 0
Fixed unknown type recognitionShelfRenderer fixes #4

Adds RecognitionShelfRenderer to the ItemSectionRendererContents enum but its not getting parsed since its not needed but should probably be parsed in a future release

opened by 11Tuvork28 0
[Trivial] A bunch of minor typo/style corrections
Just a small PR for a Rust-y fren!

Fixes many small typos.

Fixes a few styling inconsistencies.

Shortens some conditional logic.

Not tested / compiled, need to setup my Rust environment!
opened by JSKitty 0
Support feed fetching

YouTube.js supports fetching recommendations, subscriptions, and trending videos. Does such a feature fit within this project's scope? Would this project also support OAuth in the future?

I just wanted to create an issue for tracking progress for this feature.
question

opened by walking-octopus 1
Implement a parser simular youtubei.js

Currently, this project uses error-prone and difficult to maintain manual parsing for each response type. Implementing a YouTube.js-inspired parser would help to get rid of unnecessary unwraps, add a layer of abstraction for creating new API endpoints, and make the project more maintainable. Maybe a macro could be made for parsing the InnerTube responses.
enhancement

opened by walking-octopus 7
Implement parsing for all other known clients

Currently only the WEB is useable, since nothing else can be parse but that must change and the parsing api needs to be updated as well regarding the result columns since those should be in an enum for a more generic matching ability
enhancement

opened by 11Tuvork28 0

Releases(1.3.5)

1.3.5(Jul 5, 2022)
What's Changed

Fixed unknown type recognitionShelfRenderer fixes #4 in https://github.com/11Tuvork28/youtubei-rs/pull/6

Added utility functions for checking various things

Full Changelog: https://github.com/11Tuvork28/youtubei-rs/compare/1.3.4...1.3.5
Source code(tar.gz)
Source code(zip)
1.3.4(Jun 13, 2022)
What's Changed

Support for mixes

Support for in channel search

Browse requests with custom data

Bug fixes

Refactored misc.rs a little

Source code(tar.gz)
Source code(zip)
1.2.4(Jun 9, 2022)
What's Changed

Fixed parsing error when captions are not available

Removed one origin of possible panics

Fixed error when search endpoint returns searchPyvRenderer in json

Source code(tar.gz)
Source code(zip)
1.2.3(Jun 9, 2022)
What's Changed

Fixed examples

various bug fixes

Added filters to filter result

[Trivial] A bunch of minor typo/style corrections by @JSKitty in https://github.com/11Tuvork28/youtubei-rs/pull/1

[Trivial] Tiny condition shortening by @JSKitty in https://github.com/11Tuvork28/youtubei-rs/pull/2

[Trivial] Logic optimisation + Typo/style corrections by @JSKitty in https://github.com/11Tuvork28/youtubei-rs/pull/3

New Contributors

@JSKitty made their first contribution in https://github.com/11Tuvork28/youtubei-rs/pull/1

Source code(tar.gz)
Source code(zip)