An API to fetch search results and tabs from Ultimate Guitar using web scraping

Features

Searching for tabs

A module for searching for a certain query on UG is available. It returns a Vec of SearchResult objects containing basic metadata about the tab and the associated URL which may be downloaded.

The search results can be limited to a specific amount of result pages on UG to accelerate the search process by getting fewer results.

The search API also returns types of tabs which are not downloadable with this tool. Results should be filtered before downloading them automatically.

Downloading tabs

Supported tab formats are: Chords, Tabs, Bass Tabs, Ukulele Chords, Drums

When a tab is downloaded, a Song is returned, containing basic metadata like the artist or song name, optional metadata like the capo position or tuning and a Vec of the tab's lines with their associated type.

There is an option to automatically detect and replace the German names of chords with their English equivalents.

Installation & support

Installation

The crate may be downloaded using cargo:
cargo add ug-scraper

Support

If you need help or want to suggest a change, please see the issues page.

Code examples and documentation

Code examples and documentation are available on Docs.rs or in the README of the repository.

Still loading...