| Name | ddgs JSON |
| Version |
9.5.1
JSON |
| download |
| home_page | None |
| Summary | Dux Distributed Global Search. A metasearch library that aggregates results from diverse web search services. |
| upload_time | 2025-08-01 10:10:00 |
| maintainer | None |
| docs_url | None |
| author | deedy5 |
| requires_python | >=3.9 |
| license | MIT License |
| keywords |
python
search
metasearch
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
 [](https://github.com/deedy5/ddgs/releases) [](https://pypi.org/project/ddgs) [](https://pypistats.org/packages/ddgs)
# DDGS | Dux Distributed Global Search<a name="TOP"></a>
A metasearch library that aggregates results from diverse web search services.
## Table of Contents
* [Install](#install)
* [CLI version](#cli-version)
* [DDGS search operators](#ddgs-search-operators)
* [Regions](#regions)
* [Engines](#engines)
* [Tips](#tips)
* [DDGS class](#ddgs-class)
* [Proxy](#proxy)
* [Exceptions](#exceptions)
* [1. text()](#1-text)
* [2. images()](#2-images)
* [3. videos()](#3-videos)
* [4. news()](#4-news)
* [5. books()](#5-books)
* [Disclaimer](#disclaimer)
## Install
```python
pip install -U ddgs
```
## CLI version
```python3
ddgs --help
```
CLI examples:
a) text:
- *query='neurophysiology of the flickering light perception'*
- *region='cn'*
- *language='zh'*
- *max_results=5*
- *backend='google, brave'*
- *proxy='socks5h://127.0.0.1:9150'* ('tb' is an alias for the Tor browser)
`ddgs text -q 'neurophysiology of the flickering light perception' -r cn-zh -m 5 -b google -b brave -pr tb`
b) news:
- *query='etna eraption'*
- *region='it'*
- *language='it'*
- *max_results=10*
`ddgs news -q 'etna eruption' -r it-it -m 10`
c) books:
- *query='dolphins cousteau'*
- *max_results=100*
- *output='csv'* (save as csv file)
`ddgs books -q 'dolphins cousteau' -m 100 -o /tmp/books.csv`
[Go To TOP](#TOP)
## DDGS search operators
| Query example | Result|
| --- | --- |
| cats dogs | Results about cats or dogs |
| "cats and dogs" | Results for exact term "cats and dogs". If no results are found, related results are shown. |
| cats -dogs | Fewer dogs in results |
| cats +dogs | More dogs in results |
| cats filetype:pdf | PDFs about cats. Supported file types: pdf, doc(x), xls(x), ppt(x), html |
| dogs site:example.com | Pages about dogs from example.com |
| cats -site:example.com | Pages about cats, excluding example.com |
| intitle:dogs | Page title includes the word "dogs" |
| inurl:cats | Page url includes the word "cats" |
[Go To TOP](#TOP)
## Regions
<details>
<summary>expand</summary>
xa-ar for Arabia
xa-en for Arabia (en)
ar-es for Argentina
au-en for Australia
at-de for Austria
be-fr for Belgium (fr)
be-nl for Belgium (nl)
br-pt for Brazil
bg-bg for Bulgaria
ca-en for Canada
ca-fr for Canada (fr)
ct-ca for Catalan
cl-es for Chile
cn-zh for China
co-es for Colombia
hr-hr for Croatia
cz-cs for Czech Republic
dk-da for Denmark
ee-et for Estonia
fi-fi for Finland
fr-fr for France
de-de for Germany
gr-el for Greece
hk-tzh for Hong Kong
hu-hu for Hungary
in-en for India
id-id for Indonesia
id-en for Indonesia (en)
ie-en for Ireland
il-he for Israel
it-it for Italy
jp-jp for Japan
kr-kr for Korea
lv-lv for Latvia
lt-lt for Lithuania
xl-es for Latin America
my-ms for Malaysia
my-en for Malaysia (en)
mx-es for Mexico
nl-nl for Netherlands
nz-en for New Zealand
no-no for Norway
pe-es for Peru
ph-en for Philippines
ph-tl for Philippines (tl)
pl-pl for Poland
pt-pt for Portugal
ro-ro for Romania
ru-ru for Russia
sg-en for Singapore
sk-sk for Slovak Republic
sl-sl for Slovenia
za-en for South Africa
es-es for Spain
se-sv for Sweden
ch-de for Switzerland (de)
ch-fr for Switzerland (fr)
ch-it for Switzerland (it)
tw-tzh for Taiwan
th-th for Thailand
tr-tr for Turkey
ua-uk for Ukraine
uk-en for United Kingdom
us-en for United States
ue-es for United States (es)
ve-es for Venezuela
vn-vi for Vietnam
___
</details>
[Go To TOP](#TOP)
## Engines
| DDGS function | Available backends |
| --------------|:-------------------|
| text() | `bing`, `brave`, `duckduckgo`, `google`, `mojeek`, `mullvad_brave`, `mullvad_google`, `yandex`, `yahoo`, `wikipedia`|
| images() | `duckduckgo` |
| videos() | `duckduckgo` |
| news() | `duckduckgo`, `yahoo` |
| books() | `annasarchive` |
[Go To TOP](#TOP)
## Tips
⚠️ **For optimal usage, keep `backend='auto'`** (the default) and specify the desired number of results with `max_results`. This allows the library to automatically handle temporary backend unavailability.
The library considers:
- Duplicate providers (e.g., yahoo = bing, mullvad_google = google, etc.)
- Result repeatability, prioritizing frequently repeated positions
- Wikipedia summaries at the top of results, if available
To customize the search engine order, provide the backends as a comma-separated string (for example: `backend="google, brave, yahoo"`). The library will query them in order, falling back to the next one if an error occurs.
The library works in parallel, adjusting concurrent requests based on `max_results`. This ensures efficient and fast retrieval. You can change the maximum number of threads using the parameter `DDGS.threads` (for example, `DDGS.threads = 20`).
Note that a single query returns results from one page (`page=1`) of the selected backends; iterate over pages for more results. Setting `max_results` to None returns all unique collected results.
The `region` parameter also has a strong influence on the quality of the search. Set it as `{country}-{language}`: `ar-es`, `pl-pl`, `cn-zh`, etc.
Note that some backends may be temporarily unavailable due to ratelimiting or ISP blockages in certain countries. In such cases, using a proxy server can help bypass these restrictions.
[Go To TOP](#TOP)
## DDGS class
```python3
class DDGS:
"""Dux Distributed Global Search. A metasearch library that aggregates results from diverse web search services.
Args:
proxy (str, optional): proxy for the HTTP client, supports http/https/socks5 protocols.
example: "http://user:pass@example.com:3128". Defaults to None.
timeout (int, optional): Timeout value for the HTTP client. Defaults to 5.
verify (bool): SSL verification when making the request. Defaults to True.
"""
```
Here is an example of initializing the DDGS class.
```python3
from ddgs import DDGS
results = DDGS().text("python programming", max_results=5)
print(results)
```
[Go To TOP](#TOP)
## Proxy
Package supports http/https/socks proxies. Example: `http://user:pass@example.com:3128`.
Use a rotating proxy. Otherwise, use a new proxy with each DDGS class initialization.
*1. The easiest way. Launch the Tor Browser*
```python3
ddgs = DDGS(proxy="tb", timeout=10) # "tb" is an alias for "socks5h://127.0.0.1:9150"
results = ddgs.text("something you need", max_results=50)
```
*2. Use any proxy server*
```python3
ddgs = DDGS(proxy="socks5h://user:password@1.2.3.4:8080", timeout=10)
results = ddgs.text("something you need", max_results=50)
```
*3. The proxy can also be set using the `DDGS_PROXY` environment variable.*
```python3
export DDGS_PROXY="socks5h://user:password@1.2.3.4:8080"
```
[Go To TOP](#TOP)
## Exceptions
```python
from ddgs.exceptions import (
DDGSException,
RatelimitException,
TimeoutException,
)
```
Exceptions:
- `DDGSException`: Base exception for ddgs errors.
- `RatelimitException`: Inherits from DDGSException, raised for exceeding API request rate limits.
- `TimeoutException`: Inherits from DDGSException, raised for API request timeouts.
[Go To TOP](#TOP)
## 1. text()
```python
def text(
query: str,
region: str = "us-en",
safesearch: str = "moderate",
timelimit: str | None = None,
max_results: int | None = 10,
page: int = 1,
backend: str = "auto",
) -> list[dict[str, str]]:
"""DDGS text metasearch.
Args:
query: text search query.
region: us-en, uk-en, ru-ru, etc. Defaults to us-en.
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m, y. Defaults to None.
max_results: maximum number of results. Defaults to 10.
page: page of results. Defaults to 1.
backend: A single or comma-delimited backends. Defaults to "auto".
Returns:
List of dictionaries with search results.
"""
```
***Example***
```python
results = DDGS().text('live free or die', region='us-en', safesearch='off', timelimit='y', page=1, backend="auto")
# Searching for pdf files
results = DDGS().text('russia filetype:pdf', region='us-en', safesearch='off', timelimit='y', page=1, backend="auto")
print(results)
[
{
"title": "News, sport, celebrities and gossip | The Sun",
"href": "https://www.thesun.co.uk/",
"body": "Get the latest news, exclusives, sport, celebrities, showbiz, politics, business and lifestyle from The Sun",
}, ...
]
```
[Go To TOP](#TOP)
## 2. images()
```python
def images(
query: str,
region: str = "us-en",
safesearch: str = "moderate",
timelimit: str | None = None,
max_results: int | None = 10,
page: int = 1,
backend: str = "auto",
size: str | None = None,
color: str | None = None,
type_image: str | None = None,
layout: str | None = None,
license_image: str | None = None,
) -> list[dict[str, str]]:
"""DDGS images metasearch.
Args:
query: images search query.
region: us-en, uk-en, ru-ru, etc. Defaults to us-en.
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m, y. Defaults to None.
max_results: maximum number of results. Defaults to 10.
page: page of results. Defaults to 1.
backend: A single or comma-delimited backends. Defaults to "auto".
size: Small, Medium, Large, Wallpaper. Defaults to None.
color: color, Monochrome, Red, Orange, Yellow, Green, Blue,
Purple, Pink, Brown, Black, Gray, Teal, White. Defaults to None.
type_image: photo, clipart, gif, transparent, line.
Defaults to None.
layout: Square, Tall, Wide. Defaults to None.
license_image: any (All Creative Commons), Public (PublicDomain),
Share (Free to Share and Use), ShareCommercially (Free to Share and Use Commercially),
Modify (Free to Modify, Share, and Use), ModifyCommercially (Free to Modify, Share, and
Use Commercially). Defaults to None.
Returns:
List of dictionaries with images search results.
"""
```
***Example***
```python
results = DDGS().images(
query="butterfly",
region="us-en",
safesearch="off",
timelimit="m",
page=1,
backend="auto",
size=None,
color="Monochrome",
type_image=None,
layout=None,
license_image=None,
)
print(images)
[
{
"title": "File:The Sun by the Atmospheric Imaging Assembly of NASA's Solar ...",
"image": "https://upload.wikimedia.org/wikipedia/commons/b/b4/The_Sun_by_the_Atmospheric_Imaging_Assembly_of_NASA's_Solar_Dynamics_Observatory_-_20100819.jpg",
"thumbnail": "https://tse4.mm.bing.net/th?id=OIP.lNgpqGl16U0ft3rS8TdFcgEsEe&pid=Api",
"url": "https://en.wikipedia.org/wiki/File:The_Sun_by_the_Atmospheric_Imaging_Assembly_of_NASA's_Solar_Dynamics_Observatory_-_20100819.jpg",
"height": 3860,
"width": 4044,
"source": "Bing",
}, ...
]
```
[Go To TOP](#TOP)
## 3. videos()
```python
def videos(
query: str,
region: str = "us-en",
safesearch: str = "moderate",
timelimit: str | None = None,
max_results: int | None = 10,
page: int = 1,
backend: str = "auto",
resolution: str | None = None,
duration: str | None = None,
license_videos: str | None = None,
) -> list[dict[str, str]]:
"""DDGS videos metasearch.
Args:
query: videos search query.
region: us-en, uk-en, ru-ru, etc. Defaults to us-en.
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m. Defaults to None.
max_results: maximum number of results. Defaults to 10.
page: page of results. Defaults to 1.
backend: A single or comma-delimited backends. Defaults to "auto".
resolution: high, standart. Defaults to None.
duration: short, medium, long. Defaults to None.
license_videos: creativeCommon, youtube. Defaults to None.
Returns:
List of dictionaries with videos search results.
"""
```
***Example***
```python
results = DDGS().videos(
query="cars",
region="us-en",
safesearch="off",
timelimit="w",
page=1,
backend="auto",
resolution="high",
duration="medium",
)
print(results)
[
{
"content": "https://www.youtube.com/watch?v=6901-C73P3g",
"description": "Watch the Best Scenes of popular Tamil Serial #Meena that airs on Sun TV. Watch all Sun TV serials immediately after the TV telecast on Sun NXT app. *Free for Indian Users only Download here: Android - http://bit.ly/SunNxtAdroid iOS: India - http://bit.ly/sunNXT Watch on the web - https://www.sunnxt.com/ Two close friends, Chidambaram ...",
"duration": "8:22",
"embed_html": '<iframe width="1280" height="720" src="https://www.youtube.com/embed/6901-C73P3g?autoplay=1" frameborder="0" allowfullscreen></iframe>',
"embed_url": "https://www.youtube.com/embed/6901-C73P3g?autoplay=1",
"image_token": "6c070b5f0e24e5972e360d02ddeb69856202f97718ea6c5d5710e4e472310fa3",
"images": {
"large": "https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api",
"medium": "https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api",
"motion": "",
"small": "https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api",
},
"provider": "Bing",
"published": "2024-07-03T05:30:03.0000000",
"publisher": "YouTube",
"statistics": {"viewCount": 29059},
"title": "Meena - Best Scenes | 02 July 2024 | Tamil Serial | Sun TV",
"uploader": "Sun TV",
}, ...
]
```
[Go To TOP](#TOP)
## 4. news()
```python
def news(
query: str,
region: str = "us-en",
safesearch: str = "moderate",
timelimit: str | None = None,
max_results: int | None = 10,
page: int = 1,
backend: str = "auto",
) -> list[dict[str, str]]:
"""DDGS news metasearch.
Args:
query: news search query.
region: us-en, uk-en, ru-ru, etc. Defaults to us-en.
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m. Defaults to None.
max_results: maximum number of results. Defaults to 10.
page: page of results. Defaults to 1.
backend: A single or comma-delimited backends. Defaults to "auto".
Returns:
List of dictionaries with news search results.
"""
```
***Example***
```python
results = DDGS().news(query="sun", region="us-en", safesearch="off", timelimit="m", page=1, backend="auto")
print(results)
[
{
"date": "2024-07-03T16:25:22+00:00",
"title": "Murdoch's Sun Endorses Starmer's Labour Day Before UK Vote",
"body": "Rupert Murdoch's Sun newspaper endorsed Keir Starmer and his opposition Labour Party to win the UK general election, a dramatic move in the British media landscape that illustrates the country's shifting political sands.",
"url": "https://www.msn.com/en-us/money/other/murdoch-s-sun-endorses-starmer-s-labour-day-before-uk-vote/ar-BB1plQwl",
"image": "https://img-s-msn-com.akamaized.net/tenant/amp/entityid/BB1plZil.img?w=2000&h=1333&m=4&q=79",
"source": "Bloomberg on MSN.com",
}, ...
]
```
[Go To TOP](#TOP)
## 5. books()
```python
def books(
query: str,
max_results: int | None = 10,
page: int = 1,
backend: str = "auto",
) -> list[dict[str, str]]:
"""DDGS books metasearch.
Args:
query: news search query.
max_results: maximum number of results. Defaults to 10.
page: page of results. Defaults to 1.
backend: A single or comma-delimited backends. Defaults to "auto".
Returns:
List of dictionaries with news search results.
"""
```
***Example***
```python
results = DDGS().books(query="sea wolf jack london", page=1, backend="auto")
print(results)
[
{
'title': 'The Sea-Wolf',
'author': 'Jack London',
'publisher': 'DigiCat, 2022',
'info': 'English [en], .epub, 🚀/zlib, 0.5MB, 📗 Book (unknown)',
'url': 'https://annas-archive.li/md5/574f6556f1df6717de4044e36c7c2782',
'thumbnail': 'https://s3proxy.cdn-zlib.sk//covers299/collections/userbooks/da4954486be7c2b2b9f70b2aa5bcf01292de3ea510b5656f892821950ded9ada.jpg',
}, ...
]
```
[Go To TOP](#TOP)
## Disclaimer
This library is for educational purposes only.
Raw data
{
"_id": null,
"home_page": null,
"name": "ddgs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "python, search, metasearch",
"author": "deedy5",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1e/7d/d0929e3a8f40d977fb6423fb7de80afd513ffacc3d7abf071bcb4e227fc0/ddgs-9.5.1.tar.gz",
"platform": null,
"description": " [](https://github.com/deedy5/ddgs/releases) [](https://pypi.org/project/ddgs) [](https://pypistats.org/packages/ddgs)\n# DDGS | Dux Distributed Global Search<a name=\"TOP\"></a>\n\nA metasearch library that aggregates results from diverse web search services.\n\n\n## Table of Contents\n* [Install](#install)\n* [CLI version](#cli-version)\n* [DDGS search operators](#ddgs-search-operators)\n* [Regions](#regions)\n* [Engines](#engines)\n* [Tips](#tips)\n* [DDGS class](#ddgs-class)\n* [Proxy](#proxy)\n* [Exceptions](#exceptions)\n* [1. text()](#1-text)\n* [2. images()](#2-images)\n* [3. videos()](#3-videos)\n* [4. news()](#4-news)\n* [5. books()](#5-books)\n* [Disclaimer](#disclaimer)\n\n## Install\n```python\npip install -U ddgs\n```\n\n## CLI version\n\n```python3\nddgs --help\n```\nCLI examples:\n\na) text:\n - *query='neurophysiology of the flickering light perception'*\n - *region='cn'*\n - *language='zh'*\n - *max_results=5*\n - *backend='google, brave'*\n - *proxy='socks5h://127.0.0.1:9150'* ('tb' is an alias for the Tor browser)\n\n`ddgs text -q 'neurophysiology of the flickering light perception' -r cn-zh -m 5 -b google -b brave -pr tb`\n\nb) news:\n - *query='etna eraption'*\n - *region='it'*\n - *language='it'*\n - *max_results=10*\n\n`ddgs news -q 'etna eruption' -r it-it -m 10`\n\nc) books:\n - *query='dolphins cousteau'*\n - *max_results=100*\n - *output='csv'* (save as csv file)\n\n`ddgs books -q 'dolphins cousteau' -m 100 -o /tmp/books.csv`\n\n[Go To TOP](#TOP)\n\n## DDGS search operators\n\n| Query example |\tResult|\n| --- | --- |\n| cats dogs |\tResults about cats or dogs |\n| \"cats and dogs\" |\tResults for exact term \"cats and dogs\". If no results are found, related results are shown. |\n| cats -dogs |\tFewer dogs in results |\n| cats +dogs |\tMore dogs in results |\n| cats filetype:pdf |\tPDFs about cats. Supported file types: pdf, doc(x), xls(x), ppt(x), html |\n| dogs site:example.com |\tPages about dogs from example.com |\n| cats -site:example.com |\tPages about cats, excluding example.com |\n| intitle:dogs |\tPage title includes the word \"dogs\" |\n| inurl:cats |\tPage url includes the word \"cats\" |\n\n[Go To TOP](#TOP)\n\n## Regions\n<details>\n <summary>expand</summary>\n\n xa-ar for Arabia\n xa-en for Arabia (en)\n ar-es for Argentina\n au-en for Australia\n at-de for Austria\n be-fr for Belgium (fr)\n be-nl for Belgium (nl)\n br-pt for Brazil\n bg-bg for Bulgaria\n ca-en for Canada\n ca-fr for Canada (fr)\n ct-ca for Catalan\n cl-es for Chile\n cn-zh for China\n co-es for Colombia\n hr-hr for Croatia\n cz-cs for Czech Republic\n dk-da for Denmark\n ee-et for Estonia\n fi-fi for Finland\n fr-fr for France\n de-de for Germany\n gr-el for Greece\n hk-tzh for Hong Kong\n hu-hu for Hungary\n in-en for India\n id-id for Indonesia\n id-en for Indonesia (en)\n ie-en for Ireland\n il-he for Israel\n it-it for Italy\n jp-jp for Japan\n kr-kr for Korea\n lv-lv for Latvia\n lt-lt for Lithuania\n xl-es for Latin America\n my-ms for Malaysia\n my-en for Malaysia (en)\n mx-es for Mexico\n nl-nl for Netherlands\n nz-en for New Zealand\n no-no for Norway\n pe-es for Peru\n ph-en for Philippines\n ph-tl for Philippines (tl)\n pl-pl for Poland\n pt-pt for Portugal\n ro-ro for Romania\n ru-ru for Russia\n sg-en for Singapore\n sk-sk for Slovak Republic\n sl-sl for Slovenia\n za-en for South Africa\n es-es for Spain\n se-sv for Sweden\n ch-de for Switzerland (de)\n ch-fr for Switzerland (fr)\n ch-it for Switzerland (it)\n tw-tzh for Taiwan\n th-th for Thailand\n tr-tr for Turkey\n ua-uk for Ukraine\n uk-en for United Kingdom\n us-en for United States\n ue-es for United States (es)\n ve-es for Venezuela\n vn-vi for Vietnam\n___\n</details>\n\n[Go To TOP](#TOP)\n\n## Engines\n\n| DDGS function | Available backends |\n| --------------|:-------------------|\n| text() | `bing`, `brave`, `duckduckgo`, `google`, `mojeek`, `mullvad_brave`, `mullvad_google`, `yandex`, `yahoo`, `wikipedia`|\n| images() | `duckduckgo` |\n| videos() | `duckduckgo` |\n| news() | `duckduckgo`, `yahoo` |\n| books() | `annasarchive` |\n\n[Go To TOP](#TOP)\n\n## Tips\n\n\u26a0\ufe0f **For optimal usage, keep `backend='auto'`** (the default) and specify the desired number of results with `max_results`. This allows the library to automatically handle temporary backend unavailability.\n\nThe library considers:\n\n - Duplicate providers (e.g., yahoo = bing, mullvad_google = google, etc.)\n - Result repeatability, prioritizing frequently repeated positions\n - Wikipedia summaries at the top of results, if available\n\nTo customize the search engine order, provide the backends as a comma-separated string (for example: `backend=\"google, brave, yahoo\"`). The library will query them in order, falling back to the next one if an error occurs.\n\nThe library works in parallel, adjusting concurrent requests based on `max_results`. This ensures efficient and fast retrieval. You can change the maximum number of threads using the parameter `DDGS.threads` (for example, `DDGS.threads = 20`).\n\nNote that a single query returns results from one page (`page=1`) of the selected backends; iterate over pages for more results. Setting `max_results` to None returns all unique collected results.\n\nThe `region` parameter also has a strong influence on the quality of the search. Set it as `{country}-{language}`: `ar-es`, `pl-pl`, `cn-zh`, etc.\n\nNote that some backends may be temporarily unavailable due to ratelimiting or ISP blockages in certain countries. In such cases, using a proxy server can help bypass these restrictions.\n\n[Go To TOP](#TOP)\n\n## DDGS class\n\n```python3\nclass DDGS:\n \"\"\"Dux Distributed Global Search. A metasearch library that aggregates results from diverse web search services.\n\n Args:\n proxy (str, optional): proxy for the HTTP client, supports http/https/socks5 protocols.\n example: \"http://user:pass@example.com:3128\". Defaults to None.\n timeout (int, optional): Timeout value for the HTTP client. Defaults to 5.\n verify (bool): SSL verification when making the request. Defaults to True.\n \"\"\"\n```\n\nHere is an example of initializing the DDGS class.\n```python3\nfrom ddgs import DDGS\n\nresults = DDGS().text(\"python programming\", max_results=5)\nprint(results)\n```\n\n[Go To TOP](#TOP)\n\n## Proxy\n\nPackage supports http/https/socks proxies. Example: `http://user:pass@example.com:3128`.\nUse a rotating proxy. Otherwise, use a new proxy with each DDGS class initialization.\n\n*1. The easiest way. Launch the Tor Browser*\n```python3\nddgs = DDGS(proxy=\"tb\", timeout=10) # \"tb\" is an alias for \"socks5h://127.0.0.1:9150\"\nresults = ddgs.text(\"something you need\", max_results=50)\n```\n*2. Use any proxy server*\n```python3\nddgs = DDGS(proxy=\"socks5h://user:password@1.2.3.4:8080\", timeout=10)\nresults = ddgs.text(\"something you need\", max_results=50)\n```\n*3. The proxy can also be set using the `DDGS_PROXY` environment variable.*\n```python3\nexport DDGS_PROXY=\"socks5h://user:password@1.2.3.4:8080\"\n```\n\n[Go To TOP](#TOP)\n\n## Exceptions\n\n```python\nfrom ddgs.exceptions import (\n DDGSException,\n RatelimitException,\n TimeoutException,\n)\n```\n\nExceptions:\n- `DDGSException`: Base exception for ddgs errors.\n- `RatelimitException`: Inherits from DDGSException, raised for exceeding API request rate limits.\n- `TimeoutException`: Inherits from DDGSException, raised for API request timeouts.\n\n[Go To TOP](#TOP)\n\n## 1. text()\n\n```python\ndef text(\n query: str,\n region: str = \"us-en\",\n safesearch: str = \"moderate\",\n timelimit: str | None = None,\n max_results: int | None = 10,\n page: int = 1,\n backend: str = \"auto\",\n) -> list[dict[str, str]]:\n \"\"\"DDGS text metasearch.\n\n Args:\n query: text search query.\n region: us-en, uk-en, ru-ru, etc. Defaults to us-en.\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m, y. Defaults to None.\n max_results: maximum number of results. Defaults to 10.\n page: page of results. Defaults to 1.\n backend: A single or comma-delimited backends. Defaults to \"auto\".\n\n Returns:\n List of dictionaries with search results.\n \"\"\"\n```\n***Example***\n```python\nresults = DDGS().text('live free or die', region='us-en', safesearch='off', timelimit='y', page=1, backend=\"auto\")\n# Searching for pdf files\nresults = DDGS().text('russia filetype:pdf', region='us-en', safesearch='off', timelimit='y', page=1, backend=\"auto\")\nprint(results)\n[\n {\n \"title\": \"News, sport, celebrities and gossip | The Sun\",\n \"href\": \"https://www.thesun.co.uk/\",\n \"body\": \"Get the latest news, exclusives, sport, celebrities, showbiz, politics, business and lifestyle from The Sun\",\n }, ...\n]\n```\n\n[Go To TOP](#TOP)\n\n## 2. images()\n\n```python\ndef images(\n query: str,\n region: str = \"us-en\",\n safesearch: str = \"moderate\",\n timelimit: str | None = None,\n max_results: int | None = 10,\n page: int = 1,\n backend: str = \"auto\",\n size: str | None = None,\n color: str | None = None,\n type_image: str | None = None,\n layout: str | None = None,\n license_image: str | None = None,\n) -> list[dict[str, str]]:\n \"\"\"DDGS images metasearch.\n\n Args:\n query: images search query.\n region: us-en, uk-en, ru-ru, etc. Defaults to us-en.\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m, y. Defaults to None.\n max_results: maximum number of results. Defaults to 10.\n page: page of results. Defaults to 1.\n backend: A single or comma-delimited backends. Defaults to \"auto\".\n size: Small, Medium, Large, Wallpaper. Defaults to None.\n color: color, Monochrome, Red, Orange, Yellow, Green, Blue,\n Purple, Pink, Brown, Black, Gray, Teal, White. Defaults to None.\n type_image: photo, clipart, gif, transparent, line.\n Defaults to None.\n layout: Square, Tall, Wide. Defaults to None.\n license_image: any (All Creative Commons), Public (PublicDomain),\n Share (Free to Share and Use), ShareCommercially (Free to Share and Use Commercially),\n Modify (Free to Modify, Share, and Use), ModifyCommercially (Free to Modify, Share, and\n Use Commercially). Defaults to None.\n\n Returns:\n List of dictionaries with images search results.\n \"\"\"\n```\n***Example***\n```python\nresults = DDGS().images(\n query=\"butterfly\",\n region=\"us-en\",\n safesearch=\"off\",\n timelimit=\"m\",\n page=1,\n backend=\"auto\",\n size=None,\n color=\"Monochrome\",\n type_image=None,\n layout=None,\n license_image=None,\n)\nprint(images)\n[\n {\n \"title\": \"File:The Sun by the Atmospheric Imaging Assembly of NASA's Solar ...\",\n \"image\": \"https://upload.wikimedia.org/wikipedia/commons/b/b4/The_Sun_by_the_Atmospheric_Imaging_Assembly_of_NASA's_Solar_Dynamics_Observatory_-_20100819.jpg\",\n \"thumbnail\": \"https://tse4.mm.bing.net/th?id=OIP.lNgpqGl16U0ft3rS8TdFcgEsEe&pid=Api\",\n \"url\": \"https://en.wikipedia.org/wiki/File:The_Sun_by_the_Atmospheric_Imaging_Assembly_of_NASA's_Solar_Dynamics_Observatory_-_20100819.jpg\",\n \"height\": 3860,\n \"width\": 4044,\n \"source\": \"Bing\",\n }, ...\n]\n```\n\n[Go To TOP](#TOP)\n\n## 3. videos()\n\n```python\ndef videos(\n query: str,\n region: str = \"us-en\",\n safesearch: str = \"moderate\",\n timelimit: str | None = None,\n max_results: int | None = 10,\n page: int = 1,\n backend: str = \"auto\",\n resolution: str | None = None,\n duration: str | None = None,\n license_videos: str | None = None,\n) -> list[dict[str, str]]:\n \"\"\"DDGS videos metasearch.\n\n Args:\n query: videos search query.\n region: us-en, uk-en, ru-ru, etc. Defaults to us-en.\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m. Defaults to None.\n max_results: maximum number of results. Defaults to 10.\n page: page of results. Defaults to 1.\n backend: A single or comma-delimited backends. Defaults to \"auto\".\n resolution: high, standart. Defaults to None.\n duration: short, medium, long. Defaults to None.\n license_videos: creativeCommon, youtube. Defaults to None.\n\n Returns:\n List of dictionaries with videos search results.\n \"\"\"\n```\n***Example***\n```python\nresults = DDGS().videos(\n query=\"cars\",\n region=\"us-en\",\n safesearch=\"off\",\n timelimit=\"w\",\n page=1,\n backend=\"auto\",\n resolution=\"high\",\n duration=\"medium\",\n)\nprint(results)\n[\n {\n \"content\": \"https://www.youtube.com/watch?v=6901-C73P3g\",\n \"description\": \"Watch the Best Scenes of popular Tamil Serial #Meena that airs on Sun TV. Watch all Sun TV serials immediately after the TV telecast on Sun NXT app. *Free for Indian Users only Download here: Android - http://bit.ly/SunNxtAdroid iOS: India - http://bit.ly/sunNXT Watch on the web - https://www.sunnxt.com/ Two close friends, Chidambaram ...\",\n \"duration\": \"8:22\",\n \"embed_html\": '<iframe width=\"1280\" height=\"720\" src=\"https://www.youtube.com/embed/6901-C73P3g?autoplay=1\" frameborder=\"0\" allowfullscreen></iframe>',\n \"embed_url\": \"https://www.youtube.com/embed/6901-C73P3g?autoplay=1\",\n \"image_token\": \"6c070b5f0e24e5972e360d02ddeb69856202f97718ea6c5d5710e4e472310fa3\",\n \"images\": {\n \"large\": \"https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api\",\n \"medium\": \"https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api\",\n \"motion\": \"\",\n \"small\": \"https://tse4.mm.bing.net/th?id=OVF.JWBFKm1u%2fHd%2bz2e1GitsQw&pid=Api\",\n },\n \"provider\": \"Bing\",\n \"published\": \"2024-07-03T05:30:03.0000000\",\n \"publisher\": \"YouTube\",\n \"statistics\": {\"viewCount\": 29059},\n \"title\": \"Meena - Best Scenes | 02 July 2024 | Tamil Serial | Sun TV\",\n \"uploader\": \"Sun TV\",\n }, ...\n]\n```\n\n[Go To TOP](#TOP)\n\n## 4. news()\n\n```python\ndef news(\n query: str,\n region: str = \"us-en\",\n safesearch: str = \"moderate\",\n timelimit: str | None = None,\n max_results: int | None = 10,\n page: int = 1,\n backend: str = \"auto\",\n) -> list[dict[str, str]]:\n \"\"\"DDGS news metasearch.\n\n Args:\n query: news search query.\n region: us-en, uk-en, ru-ru, etc. Defaults to us-en.\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m. Defaults to None.\n max_results: maximum number of results. Defaults to 10.\n page: page of results. Defaults to 1.\n backend: A single or comma-delimited backends. Defaults to \"auto\".\n\n Returns:\n List of dictionaries with news search results.\n \"\"\"\n```\n***Example***\n```python\nresults = DDGS().news(query=\"sun\", region=\"us-en\", safesearch=\"off\", timelimit=\"m\", page=1, backend=\"auto\")\nprint(results)\n[\n {\n \"date\": \"2024-07-03T16:25:22+00:00\",\n \"title\": \"Murdoch's Sun Endorses Starmer's Labour Day Before UK Vote\",\n \"body\": \"Rupert Murdoch's Sun newspaper endorsed Keir Starmer and his opposition Labour Party to win the UK general election, a dramatic move in the British media landscape that illustrates the country's shifting political sands.\",\n \"url\": \"https://www.msn.com/en-us/money/other/murdoch-s-sun-endorses-starmer-s-labour-day-before-uk-vote/ar-BB1plQwl\",\n \"image\": \"https://img-s-msn-com.akamaized.net/tenant/amp/entityid/BB1plZil.img?w=2000&h=1333&m=4&q=79\",\n \"source\": \"Bloomberg on MSN.com\",\n }, ...\n]\n```\n\n[Go To TOP](#TOP)\n\n## 5. books()\n\n```python\ndef books(\n query: str,\n max_results: int | None = 10,\n page: int = 1,\n backend: str = \"auto\",\n) -> list[dict[str, str]]:\n \"\"\"DDGS books metasearch.\n\n Args:\n query: news search query.\n max_results: maximum number of results. Defaults to 10.\n page: page of results. Defaults to 1.\n backend: A single or comma-delimited backends. Defaults to \"auto\".\n\n Returns:\n List of dictionaries with news search results.\n \"\"\"\n```\n***Example***\n```python\nresults = DDGS().books(query=\"sea wolf jack london\", page=1, backend=\"auto\")\nprint(results)\n[\n {\n 'title': 'The Sea-Wolf',\n 'author': 'Jack London',\n 'publisher': 'DigiCat, 2022',\n 'info': 'English [en], .epub, \ud83d\ude80/zlib, 0.5MB, \ud83d\udcd7 Book (unknown)',\n 'url': 'https://annas-archive.li/md5/574f6556f1df6717de4044e36c7c2782',\n 'thumbnail': 'https://s3proxy.cdn-zlib.sk//covers299/collections/userbooks/da4954486be7c2b2b9f70b2aa5bcf01292de3ea510b5656f892821950ded9ada.jpg',\n }, ...\n]\n```\n\n[Go To TOP](#TOP)\n\n## Disclaimer\n\nThis library is for educational purposes only.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Dux Distributed Global Search. A metasearch library that aggregates results from diverse web search services.",
"version": "9.5.1",
"project_urls": {
"Homepage": "https://github.com/deedy5/ddgs"
},
"split_keywords": [
"python",
" search",
" metasearch"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a30aecb484ed63f6c3b7444294e7736061b0feaef472feac951924717dbc9156",
"md5": "574d2c5ca9c3b04e460f64ac8ff1ea98",
"sha256": "59467b29d92a781bf3aa22fb1bea613c7f8280a0760b4033610f787b472b4109"
},
"downloads": -1,
"filename": "ddgs-9.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "574d2c5ca9c3b04e460f64ac8ff1ea98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 36342,
"upload_time": "2025-08-01T10:09:59",
"upload_time_iso_8601": "2025-08-01T10:09:59.582210Z",
"url": "https://files.pythonhosted.org/packages/a3/0a/ecb484ed63f6c3b7444294e7736061b0feaef472feac951924717dbc9156/ddgs-9.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e7dd0929e3a8f40d977fb6423fb7de80afd513ffacc3d7abf071bcb4e227fc0",
"md5": "c86c6406ef3c00924288dbd73fa9df0c",
"sha256": "cfb721c1191fe30df648d62564c2acfdcb5035adc9f2ed7985b5c4ef8adb733e"
},
"downloads": -1,
"filename": "ddgs-9.5.1.tar.gz",
"has_sig": false,
"md5_digest": "c86c6406ef3c00924288dbd73fa9df0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 32606,
"upload_time": "2025-08-01T10:10:00",
"upload_time_iso_8601": "2025-08-01T10:10:00.490000Z",
"url": "https://files.pythonhosted.org/packages/1e/7d/d0929e3a8f40d977fb6423fb7de80afd513ffacc3d7abf071bcb4e227fc0/ddgs-9.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 10:10:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deedy5",
"github_project": "ddgs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ddgs"
}
