<h1 align="center">XVIDEOS API</h1>
<div align="center">
<a href="https://pepy.tech/project/xvideos_api"><img src="https://static.pepy.tech/badge/xvideos_api" alt="Downloads"></a>
<a href="https://pepy.tech/project/xvideos_api-async"><img src="https://static.pepy.tech/badge/xvideos_api-async" alt="Downloads"></a> <pan style="font-size: 20px">(Async)</pan>
<a href="https://github.com/EchterAlsFake/xvideos_api/workflows/"><img src="https://github.com/EchterAlsFake/xvideos_api/workflows/CodeQL/badge.svg" alt="CodeQL Analysis"/></a>
<a href="https://github.com/EchterAlsFake/xvideos_api/actions/workflows/sync-tests.yml"><img src="https://github.com/EchterAlsFake/xvideos_api/actions/workflows/sync-tests.yml/badge.svg" alt="Sync API Tests"/></a>
<a href="https://github.com/EchterAlsFake/xvideos_api/actions/workflows/async-tests.yml"><img src="https://github.com/EchterAlsFake/xvideos_api/actions/workflows/async-tests.yml/badge.svg?branch=async" alt="Async Branch API Tests"></a>
</div>
# Description
XVideos API is an API for xvideos.com. It allows you to fetch information from videos using regexes and requests.
# Disclaimer
> [!IMPORTANT]
> XVideos API is in violation to the ToS of xvideos.com!
> If you are the website owner of xvideos.com, contact me at my E-Mail, and I'll take this repository immediately offline.
> EchterAlsFake@proton.me
# Quickstart
### Have a look at the [Documentation](https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/XVideos.md) for more details
- Install the library with `pip install xvideos_api`
```python
from xvideos_api import Client
# Initialize a Client object
client = Client()
# Fetch a video
video_object = client.get_video("<insert_url_here>")
# Information from Video objects
print(video_object.title)
print(video_object.likes)
# Download the video
video_object.download(downloader="threaded", quality="best", path="your_output_path + filename")
# SEE DOCUMENTATION FOR MORE
```
> [!NOTE]
> XVideos API can also be used from the command line. Do: xvideos_api -h to see the options
# Changelog
See [Changelog](https://github.com/EchterAlsFake/xvideos_api/blob/master/README/Changelog.md) for more details.
# Support (Donations)
I am developing all my projects entirely for free. I do that because I have fun and I don't want
to charge 30€ like other people do.
However, if you find my work useful, please consider donating something. A tiny amount such as 1€
means a lot to me.
Paypal: https://paypal.me/EchterAlsFake
<br>XMR (Monero): `46xL2reuanxZgFxXBBaoagiEJK9c7bL7aiwKNR15neyX2wUsX2QVzkeRMVG2Cro44qLUNYvsP1BQa12KPbNat2ML41nyEeq`
# Contribution
Do you see any issues or having some feature requests? Simply open an Issue or talk
in the discussions.
Pull requests are also welcome.
# License
Licensed under the LGPLv3 License
<br>Copyright (C) 2023–2025 Johannes Habel
Raw data
{
"_id": null,
"home_page": "https://github.com/EchterAlsFake/xvideos_api",
"name": "xvideos-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Johannes Habel",
"author_email": "EchterAlsFake@proton.me",
"download_url": "https://files.pythonhosted.org/packages/8a/18/4266aada3644936f797f5e86a28e422fffc5171fd1d4ad7a77bd7b83431a/xvideos_api-1.5.3.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">XVIDEOS API</h1> \n\n<div align=\"center\">\n <a href=\"https://pepy.tech/project/xvideos_api\"><img src=\"https://static.pepy.tech/badge/xvideos_api\" alt=\"Downloads\"></a>\n <a href=\"https://pepy.tech/project/xvideos_api-async\"><img src=\"https://static.pepy.tech/badge/xvideos_api-async\" alt=\"Downloads\"></a> <pan style=\"font-size: 20px\">(Async)</pan>\n <a href=\"https://github.com/EchterAlsFake/xvideos_api/workflows/\"><img src=\"https://github.com/EchterAlsFake/xvideos_api/workflows/CodeQL/badge.svg\" alt=\"CodeQL Analysis\"/></a>\n <a href=\"https://github.com/EchterAlsFake/xvideos_api/actions/workflows/sync-tests.yml\"><img src=\"https://github.com/EchterAlsFake/xvideos_api/actions/workflows/sync-tests.yml/badge.svg\" alt=\"Sync API Tests\"/></a>\n <a href=\"https://github.com/EchterAlsFake/xvideos_api/actions/workflows/async-tests.yml\"><img src=\"https://github.com/EchterAlsFake/xvideos_api/actions/workflows/async-tests.yml/badge.svg?branch=async\" alt=\"Async Branch API Tests\"></a>\n</div>\n\n# Description\nXVideos API is an API for xvideos.com. It allows you to fetch information from videos using regexes and requests.\n\n# Disclaimer\n> [!IMPORTANT] \n> XVideos API is in violation to the ToS of xvideos.com!\n> If you are the website owner of xvideos.com, contact me at my E-Mail, and I'll take this repository immediately offline.\n> EchterAlsFake@proton.me\n\n# Quickstart\n\n### Have a look at the [Documentation](https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/XVideos.md) for more details\n- Install the library with `pip install xvideos_api`\n\n\n```python\nfrom xvideos_api import Client\n# Initialize a Client object\nclient = Client()\n\n# Fetch a video\nvideo_object = client.get_video(\"<insert_url_here>\")\n\n# Information from Video objects\nprint(video_object.title)\nprint(video_object.likes)\n# Download the video\n\nvideo_object.download(downloader=\"threaded\", quality=\"best\", path=\"your_output_path + filename\")\n\n# SEE DOCUMENTATION FOR MORE\n```\n\n> [!NOTE]\n> XVideos API can also be used from the command line. Do: xvideos_api -h to see the options\n# Changelog\nSee [Changelog](https://github.com/EchterAlsFake/xvideos_api/blob/master/README/Changelog.md) for more details.\n\n# Support (Donations)\nI am developing all my projects entirely for free. I do that because I have fun and I don't want\nto charge 30\u20ac like other people do.\n\nHowever, if you find my work useful, please consider donating something. A tiny amount such as 1\u20ac\nmeans a lot to me.\n\nPaypal: https://paypal.me/EchterAlsFake\n<br>XMR (Monero): `46xL2reuanxZgFxXBBaoagiEJK9c7bL7aiwKNR15neyX2wUsX2QVzkeRMVG2Cro44qLUNYvsP1BQa12KPbNat2ML41nyEeq`\n\n\n# Contribution\nDo you see any issues or having some feature requests? Simply open an Issue or talk\nin the discussions.\n\nPull requests are also welcome.\n\n# License\nLicensed under the LGPLv3 License\n<br>Copyright (C) 2023\u20132025 Johannes Habel\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "A Python API for the Porn Site xvideos.com",
"version": "1.5.3",
"project_urls": {
"Homepage": "https://github.com/EchterAlsFake/xvideos_api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c43dca6a0d2edbdc857c73325091e5bc44887d7d0929245f318c602819ba77f",
"md5": "68039b9ddbe777c6ea8fd2c1d1cf9287",
"sha256": "1846584c7856668d753a1745c6947954af5b21a49e93c98cce70a009f6ce9299"
},
"downloads": -1,
"filename": "xvideos_api-1.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68039b9ddbe777c6ea8fd2c1d1cf9287",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14001,
"upload_time": "2025-01-10T13:16:40",
"upload_time_iso_8601": "2025-01-10T13:16:40.312097Z",
"url": "https://files.pythonhosted.org/packages/5c/43/dca6a0d2edbdc857c73325091e5bc44887d7d0929245f318c602819ba77f/xvideos_api-1.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a184266aada3644936f797f5e86a28e422fffc5171fd1d4ad7a77bd7b83431a",
"md5": "2a76be0804fbdd2346f5e6f4236c805e",
"sha256": "862820cba23f17873a69c00a71db2ab03859c3676c999f2c83c96c62f460887e"
},
"downloads": -1,
"filename": "xvideos_api-1.5.3.tar.gz",
"has_sig": false,
"md5_digest": "2a76be0804fbdd2346f5e6f4236c805e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12856,
"upload_time": "2025-01-10T13:16:48",
"upload_time_iso_8601": "2025-01-10T13:16:48.361316Z",
"url": "https://files.pythonhosted.org/packages/8a/18/4266aada3644936f797f5e86a28e422fffc5171fd1d4ad7a77bd7b83431a/xvideos_api-1.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 13:16:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EchterAlsFake",
"github_project": "xvideos_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xvideos-api"
}