{"id":49351454,"url":"https://github.com/nhas/ytdlp-api","last_synced_at":"2026-04-27T10:03:27.281Z","repository":{"id":350337038,"uuid":"1206387762","full_name":"NHAS/ytdlp-api","owner":"NHAS","description":"A very simple yt-dlp api","archived":false,"fork":false,"pushed_at":"2026-04-09T22:49:04.000Z","size":236,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-09T23:29:18.665Z","etag":null,"topics":["extension","youtube","yt-dlp","yt-dlp-gui"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHAS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-09T21:35:45.000Z","updated_at":"2026-04-09T22:48:51.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/NHAS/ytdlp-api","commit_stats":null,"previous_names":["nhas/ytdlp-api"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/NHAS/ytdlp-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHAS%2Fytdlp-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHAS%2Fytdlp-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHAS%2Fytdlp-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHAS%2Fytdlp-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHAS","download_url":"https://codeload.github.com/NHAS/ytdlp-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHAS%2Fytdlp-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32331306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["extension","youtube","yt-dlp","yt-dlp-gui"],"created_at":"2026-04-27T10:03:08.697Z","updated_at":"2026-04-27T10:03:27.272Z","avatar_url":"https://github.com/NHAS.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yt-dlp Api\n\n![A picture showing the main UI](images/main_page.png)\n\nThis is a very simple project that provides an api for the associated extension. \nIn essence it is a wrapper around the `yt-dlp` command line tool, but enables you to record the music you listen to, as you listen to it. \n\nThe extension (https://github.com/NHAS/tracker-extension) built for firefox, loads some JS into the `http://music.youtube.com` to watch the player and record the video id of the current song, sending it off to the api for recording. \n\n\n## Warning\n\nThis is a personal project. Unlike my other repos such as `reverse_ssh` and `wag` the amount of support and cleaniliness of this project is likely to be minimal. \n\nBear that in mind when opening issues and requesting features please. \n\n## Docker compose\n\n```yml\nservices:\n  ytdl-server:\n    image: ghcr.io/nhas/ytdlp-api:latest\n    restart: unless-stopped\n    ports:\n      - \"8080:8080\"\n    volumes:\n      - downloads:/downloads\n      - data:/data\n      - ./config.json:/app/config.json:ro\n \nvolumes:\n  downloads:\n  data:\n```\n\n\n## Configuration\n\nThis project takes an environment variable `CONFIG_PATH` to determine where its config path is. \nIt'll default to `/data/config.json` is none is specified.\n\n| Field | Default | Description |\n|---|---|---|\n| `addr` | `localhost:8080` | Address and port the HTTP server listens on |\n| `external_address` | Same as `addr` if none set | Publicly reachable URL of this server, used when generating extension registration links |\n| `downloads_path` | `/downloads` | Directory where downloaded audio files are saved |\n| `db_path` | `/data/ytdl.db` | Path to the SQLite database file |\n| `download_timeout` | `5m` | Maximum time allowed for a single `yt-dlp` download before it is cancelled |\n| `key` | Random and printed to stdout if not set | Admin key required to call `/api/register` and provision new extension API keys |\n\n\nExample:\n\n```js\n{\n    \"addr\": \":8080\",\n    \"external_addr\": \"example.com\",\n}\n```\n\n## Registration\n\nOn the server UI click the `Generate registration` button top left. \nThis will require you to have the administrative key which is either configured in `config.json` or random generated on start of this container.\n\n![A page showing the server registration page](images/registration.png)\n\n\nThis will then generate a link like the following:\n```\next+ytdl://register?key=2f1fbbbb8460115722218a63c6bf81d1\u0026url=http%3A%2F%2Flocalhost%3A8080\n```\n\nEither give this to your user, or browse to it in a browser that has loaded the [extension](https://github.com/NHAS/tracker-extension), this will automatically fill in the details and once you begin listening to music on https://music.youtube.com you should see music starting to be downloaded","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhas%2Fytdlp-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhas%2Fytdlp-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhas%2Fytdlp-api/lists"}