| Name | duckduckgo-search JSON |
| Version |
3.8.1
JSON |
| download |
| home_page | |
| Summary | Search for words, documents, images, news, maps and text translation using the DuckDuckGo.com search engine. |
| upload_time | 2023-06-03 07:40:05 |
| maintainer | |
| docs_url | None |
| author | deedy5 |
| requires_python | >=3.7 |
| license | MIT License |
| keywords |
python
duckduckgo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
 [](https://github.com/deedy5/duckduckgo_search/releases) [](https://pypi.org/project/duckduckgo-search)
# Duckduckgo_search<a name="TOP"></a>
Search for words, documents, images, videos, news, maps and text translation using the DuckDuckGo.com search engine. Downloading files and images to a local hard drive.
## Table of Contents
* [Install](#install)
* [CLI version](#cli-version)
* [Duckduckgo search operators](#duckduckgo-search-operators)
* [Regions](#regions)
* [Using proxy](#using-proxy)
* [1. text() - text search](#1-text---text-search-by-by-duckduckgocom)
* [2. answers() - instant answers](#2-answers---instant-answers-by-duckduckgocom)
* [3. images() - image search](#3-images---image-search-by-duckduckgocom)
* [4. videos() - video search](#4-videos---video-search-by-duckduckgocom)
* [5. news() - news search](#5-news---news-search-by-duckduckgocom)
* [6. maps() - map search](#6-maps---map-search-by-duckduckgocom)
* [7. translate() - translation](#7-translate---translation-by-duckduckgocom)
* [8. suggestions() - suggestions](#8-suggestions---suggestions-by-duckduckgocom)
## Install
```python
pip install -U duckduckgo_search
```
## CLI version
```python3
ddgs --help
```
or
```python3
python -m duckduckgo_search --help
```
CLI examples:
```python3
# text search
ddgs text -k 'ayrton senna'
# find and download pdf files
ddgs text -k "russia filetype:pdf" -m 50 -d
# find and download xls files from a specific site
ddgs text -k 'sanctions filetype:xls site:gov.ua' -m 50 -d
# find and download any xls files from a specific site
ddgs text -k 'filetype:xls site:mos.ru' -m 50 -d
# find and download images
ddgs images -k "yuri kuklachev cat theatre" -m 500 -s off -d
# get latest news
ddgs news -k "ukraine war" -s off -t d -m 10
```
[Go To TOP](#TOP)
## Duckduckgo search operators
| Keywords 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
wt-wt for No region
___
</details>
[Go To TOP](#TOP)
## Using proxy
*1. The easiest way. Launch the Tor Browser*
```python3
from duckduckgo_search import DDGS
with DDGS(proxies="socks5://localhost:9150", timeout=20) as ddgs:
for r in ddgs.text("something you need"):
print(r)
```
*2. Use any proxy server* (*example with [iproyal residential proxies](https://iproyal.com?r=residential_proxies)*)
```python3
from duckduckgo_search import DDGS
with DDGS(proxies="socks5://user:password@geo.iproyal.com:32325", timeout=20) as ddgs:
for r in ddgs.text("something you need"):
print(r)
```
[Go To TOP](#TOP)
## 1. text() - text search by duckduckgo.com
`html` and `lite` backend differ from `api`:</br>
* don't do an extra request first to get vqd,</br>
* use POST requests,</br>
* pause 0.75 seconds between paginations.</br>
If you use `html` or `lite` backend, pause at least 0.75 seconds between text() calls.
Otherwise the site will return a 403 status code after a few requests and block your ip for a few seconds.
```python
def text(
keywords: str,
region: str = "wt-wt",
safesearch: str = "moderate",
timelimit: Optional[str] = None,
backend: str = "api",
) -> Iterator[dict]:
"""DuckDuckGo text search generator. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m, y. Defaults to None.
backend: api, html, lite. Defaults to api.
api - collect data from https://duckduckgo.com,
html - collect data from https://html.duckduckgo.com,
lite - collect data from https://lite.duckduckgo.com.
Yields:
dict with search results.
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
for r in ddgs.text('live free or die', region='wt-wt', safesearch='Off', timelimit='y'):
print(r)
# Searching for pdf files
with DDGS() as ddgs:
for r in ddgs.text('russia filetype:pdf', region='wt-wt', safesearch='Off', timelimit='y'):
print(r)
# Using lite backend and limit the number of results to 10
from itertools import islice
with DDGS() as ddgs:
ddgs_gen = ddgs.text("notes from a dead house", backend="lite")
for r in islice(ddgs_gen, 10):
print(r)
```
[Go To TOP](#TOP)
## 2. answers() - instant answers by duckduckgo.com
```python
def answers(keywords: str) -> Generator[dict, None, None]:
"""DuckDuckGo instant answers. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
Yields:
dict with instant answers results.
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
for r in ddgs.answers("sun"):
print(r)
```
[Go To TOP](#TOP)
## 3. images() - image search by duckduckgo.com
```python
def images(
keywords: str,
region: str = "wt-wt",
safesearch: str = "moderate",
timelimit: Optional[str] = None,
size: Optional[str] = None,
color: Optional[str] = None,
type_image: Optional[str] = None,
layout: Optional[str] = None,
license_image: Optional[str] = None,
) -> Iterator[dict]:
"""DuckDuckGo images search. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: Day, Week, Month, Year. Defaults to None.
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.
Yields:
dict with image search results.
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
keywords = 'butterfly'
ddgs_images_gen = ddgs.images(
keywords,
region="wt-wt",
safesearch="Off",
size=None,
color="Monochrome",
type_image=None,
layout=None,
license_image=None,
)
for r in ddgs_images_gen:
print(r)
```
[Go To TOP](#TOP)
## 4. videos() - video search by duckduckgo.com
```python
def videos(
keywords: str,
region: str = "wt-wt",
safesearch: str = "moderate",
timelimit: Optional[str] = None,
resolution: Optional[str] = None,
duration: Optional[str] = None,
license_videos: Optional[str] = None,
) -> Iterator[dict]:
"""DuckDuckGo videos search. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m. Defaults to None.
resolution: high, standart. Defaults to None.
duration: short, medium, long. Defaults to None.
license_videos: creativeCommon, youtube. Defaults to None.
Yields:
dict with videos search results
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
keywords = 'tesla'
ddgs_videos_gen = ddgs.videos(
keywords,
region="wt-wt",
safesearch="Off",
timelimit="w",
resolution="high",
duration="medium",
)
for r in ddgs_videos_gen:
print(r)
```
[Go To TOP](#TOP)
## 5. news() - news search by duckduckgo.com
```python
def news(
keywords: str,
region: str = "wt-wt",
safesearch: str = "moderate",
timelimit: Optional[str] = None,
) -> Iterator[dict]:
"""DuckDuckGo news search. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
safesearch: on, moderate, off. Defaults to "moderate".
timelimit: d, w, m. Defaults to None.
Yields:
dict with news search results.
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
keywords = 'How soon the sun will die'
ddgs_news_gen = ddgs.news(
keywords,
region="wt-wt",
safesearch="Off",
timelimit="m",
)
for r in ddgs_news_gen:
print(r)
```
[Go To TOP](#TOP)
## 6. maps() - map search by duckduckgo.com
```python
def maps(
keywords,
place: Optional[str] = None,
street: Optional[str] = None,
city: Optional[str] = None,
county: Optional[str] = None,
state: Optional[str] = None,
country: Optional[str] = None,
postalcode: Optional[str] = None,
latitude: Optional[str] = None,
longitude: Optional[str] = None,
radius: int = 0,
) -> Iterator[dict]:
"""DuckDuckGo maps search. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query
place: if set, the other parameters are not used. Defaults to None.
street: house number/street. Defaults to None.
city: city of search. Defaults to None.
county: county of search. Defaults to None.
state: state of search. Defaults to None.
country: country of search. Defaults to None.
postalcode: postalcode of search. Defaults to None.
latitude: geographic coordinate (north–south position). Defaults to None.
longitude: geographic coordinate (east–west position); if latitude and
longitude are set, the other parameters are not used. Defaults to None.
radius: expand the search square by the distance in kilometers. Defaults to 0.
Yields:
dict with maps search results
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
for r in ddgs.maps("school", place="Uganda"):
print(r)
```
[Go To TOP](#TOP)
## 7. translate() - translation by duckduckgo.com
```python
def translate(
self,
keywords: str,
from_: Optional[str] = None,
to: str = "en",
) -> Optional[dict]:
"""DuckDuckGo translate
Args:
keywords: string or a list of strings to translate
from_: translate from (defaults automatically). Defaults to None.
to: what language to translate. Defaults to "en".
Returns:
dict with translated keywords.
"""
```
***Example***
```python
from duckduckgo_search import DDGS
with DDGS() as ddgs:
keywords = 'school'
r = ddgs.translate(keywords, to="de")
print(r)
```
[Go To TOP](#TOP)
## 8. suggestions() - suggestions by duckduckgo.com
```python
def suggestions(
keywords,
region: str = "wt-wt",
) -> Iterator[dict]:
"""DuckDuckGo suggestions. Query params: https://duckduckgo.com/params
Args:
keywords: keywords for query.
region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to "wt-wt".
Yields:
dict with suggestions results.
"""
```
***Example***
```python3
from duckduckgo_search import DDGS
with DDGS() as ddgs:
for r in ddgs.suggestions("fly)
print(r)
```
[Go To TOP](#TOP)
Raw data
{
"_id": null,
"home_page": "",
"name": "duckduckgo-search",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,duckduckgo",
"author": "deedy5",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7a/cb/4b259c6d753d71329130cbedd3b49f69b809bd4f39ed8ee84e0a7f106068/duckduckgo_search-3.8.1.tar.gz",
"platform": null,
"description": " [](https://github.com/deedy5/duckduckgo_search/releases) [](https://pypi.org/project/duckduckgo-search)\n# Duckduckgo_search<a name=\"TOP\"></a>\n\nSearch for words, documents, images, videos, news, maps and text translation using the DuckDuckGo.com search engine. Downloading files and images to a local hard drive.\n\n## Table of Contents\n* [Install](#install)\n* [CLI version](#cli-version)\n* [Duckduckgo search operators](#duckduckgo-search-operators)\n* [Regions](#regions)\n* [Using proxy](#using-proxy)\n* [1. text() - text search](#1-text---text-search-by-by-duckduckgocom)\n* [2. answers() - instant answers](#2-answers---instant-answers-by-duckduckgocom)\n* [3. images() - image search](#3-images---image-search-by-duckduckgocom)\n* [4. videos() - video search](#4-videos---video-search-by-duckduckgocom)\n* [5. news() - news search](#5-news---news-search-by-duckduckgocom)\n* [6. maps() - map search](#6-maps---map-search-by-duckduckgocom)\n* [7. translate() - translation](#7-translate---translation-by-duckduckgocom)\n* [8. suggestions() - suggestions](#8-suggestions---suggestions-by-duckduckgocom)\n\n## Install\n```python\npip install -U duckduckgo_search\n```\n\n## CLI version\n\n```python3\nddgs --help\n```\nor\n```python3\npython -m duckduckgo_search --help\n```\n\nCLI examples:\n```python3\n# text search\nddgs text -k 'ayrton senna'\n# find and download pdf files\nddgs text -k \"russia filetype:pdf\" -m 50 -d\n# find and download xls files from a specific site\nddgs text -k 'sanctions filetype:xls site:gov.ua' -m 50 -d\n# find and download any xls files from a specific site\nddgs text -k 'filetype:xls site:mos.ru' -m 50 -d\n# find and download images\nddgs images -k \"yuri kuklachev cat theatre\" -m 500 -s off -d\n# get latest news\nddgs news -k \"ukraine war\" -s off -t d -m 10\n```\n[Go To TOP](#TOP)\n\n## Duckduckgo search operators\n\n| Keywords 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 wt-wt for No region\n___\n</details>\n\n[Go To TOP](#TOP)\n\n## Using proxy\n*1. The easiest way. Launch the Tor Browser*\n```python3\nfrom duckduckgo_search import DDGS\n\nwith DDGS(proxies=\"socks5://localhost:9150\", timeout=20) as ddgs:\n for r in ddgs.text(\"something you need\"):\n print(r)\n```\n*2. Use any proxy server* (*example with [iproyal residential proxies](https://iproyal.com?r=residential_proxies)*)\n```python3\nfrom duckduckgo_search import DDGS\n\nwith DDGS(proxies=\"socks5://user:password@geo.iproyal.com:32325\", timeout=20) as ddgs:\n for r in ddgs.text(\"something you need\"):\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n## 1. text() - text search by duckduckgo.com\n`html` and `lite` backend differ from `api`:</br>\n* don't do an extra request first to get vqd,</br>\n* use POST requests,</br>\n* pause 0.75 seconds between paginations.</br>\n\nIf you use `html` or `lite` backend, pause at least 0.75 seconds between text() calls. \nOtherwise the site will return a 403 status code after a few requests and block your ip for a few seconds.\n```python\ndef text(\n keywords: str,\n region: str = \"wt-wt\",\n safesearch: str = \"moderate\",\n timelimit: Optional[str] = None,\n backend: str = \"api\",\n) -> Iterator[dict]:\n \"\"\"DuckDuckGo text search generator. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to \"wt-wt\".\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m, y. Defaults to None.\n backend: api, html, lite. Defaults to api.\n api - collect data from https://duckduckgo.com,\n html - collect data from https://html.duckduckgo.com,\n lite - collect data from https://lite.duckduckgo.com.\n Yields:\n dict with search results.\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n for r in ddgs.text('live free or die', region='wt-wt', safesearch='Off', timelimit='y'):\n print(r)\n\n# Searching for pdf files\nwith DDGS() as ddgs:\n for r in ddgs.text('russia filetype:pdf', region='wt-wt', safesearch='Off', timelimit='y'):\n print(r)\n\n# Using lite backend and limit the number of results to 10\nfrom itertools import islice\n\nwith DDGS() as ddgs:\n ddgs_gen = ddgs.text(\"notes from a dead house\", backend=\"lite\")\n for r in islice(ddgs_gen, 10):\n print(r)\n```\n\n\n[Go To TOP](#TOP)\n\n## 2. answers() - instant answers by duckduckgo.com\n\n```python\ndef answers(keywords: str) -> Generator[dict, None, None]:\n \"\"\"DuckDuckGo instant answers. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n\n Yields:\n dict with instant answers results.\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n for r in ddgs.answers(\"sun\"):\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n## 3. images() - image search by duckduckgo.com\n\n```python\ndef images(\n keywords: str,\n region: str = \"wt-wt\",\n safesearch: str = \"moderate\",\n timelimit: Optional[str] = None,\n size: Optional[str] = None,\n color: Optional[str] = None,\n type_image: Optional[str] = None,\n layout: Optional[str] = None,\n license_image: Optional[str] = None,\n) -> Iterator[dict]:\n \"\"\"DuckDuckGo images search. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to \"wt-wt\".\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: Day, Week, Month, Year. Defaults to None.\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 Yields:\n dict with image search results.\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n keywords = 'butterfly'\n ddgs_images_gen = ddgs.images(\n keywords,\n region=\"wt-wt\",\n safesearch=\"Off\",\n size=None,\n color=\"Monochrome\",\n type_image=None,\n layout=None,\n license_image=None,\n )\n for r in ddgs_images_gen:\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n## 4. videos() - video search by duckduckgo.com\n\n```python\ndef videos(\n keywords: str,\n region: str = \"wt-wt\",\n safesearch: str = \"moderate\",\n timelimit: Optional[str] = None,\n resolution: Optional[str] = None,\n duration: Optional[str] = None,\n license_videos: Optional[str] = None,\n) -> Iterator[dict]:\n \"\"\"DuckDuckGo videos search. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to \"wt-wt\".\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m. Defaults to None.\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 Yields:\n dict with videos search results\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n keywords = 'tesla'\n ddgs_videos_gen = ddgs.videos(\n keywords,\n region=\"wt-wt\",\n safesearch=\"Off\",\n timelimit=\"w\",\n resolution=\"high\",\n duration=\"medium\",\n )\n for r in ddgs_videos_gen:\n print(r)\n```\n\n\n[Go To TOP](#TOP)\n\n## 5. news() - news search by duckduckgo.com\n\n```python\ndef news(\n keywords: str,\n region: str = \"wt-wt\",\n safesearch: str = \"moderate\",\n timelimit: Optional[str] = None,\n) -> Iterator[dict]:\n \"\"\"DuckDuckGo news search. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to \"wt-wt\".\n safesearch: on, moderate, off. Defaults to \"moderate\".\n timelimit: d, w, m. Defaults to None.\n\n Yields:\n dict with news search results.\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n keywords = 'How soon the sun will die'\n ddgs_news_gen = ddgs.news(\n keywords,\n region=\"wt-wt\",\n safesearch=\"Off\",\n timelimit=\"m\",\n )\n for r in ddgs_news_gen:\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n## 6. maps() - map search by duckduckgo.com\n\n```python\ndef maps(\n keywords,\n place: Optional[str] = None,\n street: Optional[str] = None,\n city: Optional[str] = None,\n county: Optional[str] = None,\n state: Optional[str] = None,\n country: Optional[str] = None,\n postalcode: Optional[str] = None,\n latitude: Optional[str] = None,\n longitude: Optional[str] = None,\n radius: int = 0,\n ) -> Iterator[dict]:\n \"\"\"DuckDuckGo maps search. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query\n place: if set, the other parameters are not used. Defaults to None.\n street: house number/street. Defaults to None.\n city: city of search. Defaults to None.\n county: county of search. Defaults to None.\n state: state of search. Defaults to None.\n country: country of search. Defaults to None.\n postalcode: postalcode of search. Defaults to None.\n latitude: geographic coordinate (north\u2013south position). Defaults to None.\n longitude: geographic coordinate (east\u2013west position); if latitude and\n longitude are set, the other parameters are not used. Defaults to None.\n radius: expand the search square by the distance in kilometers. Defaults to 0.\n\n Yields:\n dict with maps search results\n\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n for r in ddgs.maps(\"school\", place=\"Uganda\"):\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n## 7. translate() - translation by duckduckgo.com\n\n```python\ndef translate(\n self,\n keywords: str,\n from_: Optional[str] = None,\n to: str = \"en\",\n) -> Optional[dict]:\n \"\"\"DuckDuckGo translate\n\n Args:\n keywords: string or a list of strings to translate\n from_: translate from (defaults automatically). Defaults to None.\n to: what language to translate. Defaults to \"en\".\n\n Returns:\n dict with translated keywords.\n \"\"\"\n```\n***Example***\n```python\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n keywords = 'school'\n r = ddgs.translate(keywords, to=\"de\")\n print(r)\n```\n\n[Go To TOP](#TOP)\n\n\n## 8. suggestions() - suggestions by duckduckgo.com\n\n```python\ndef suggestions(\n keywords,\n region: str = \"wt-wt\",\n) -> Iterator[dict]:\n \"\"\"DuckDuckGo suggestions. Query params: https://duckduckgo.com/params\n\n Args:\n keywords: keywords for query.\n region: wt-wt, us-en, uk-en, ru-ru, etc. Defaults to \"wt-wt\".\n\n Yields:\n dict with suggestions results.\n \"\"\"\n```\n***Example***\n```python3\nfrom duckduckgo_search import DDGS\n\nwith DDGS() as ddgs:\n for r in ddgs.suggestions(\"fly)\n print(r)\n```\n\n[Go To TOP](#TOP)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Search for words, documents, images, news, maps and text translation using the DuckDuckGo.com search engine.",
"version": "3.8.1",
"project_urls": {
"Homepage": "https://github.com/deedy5/duckduckgo_search"
},
"split_keywords": [
"python",
"duckduckgo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11c096aa4e4b36554c626e2be2d20ee8287ddf199a843c5cebf91c4b16a2dfd3",
"md5": "23001342f692c9f6d5b269b640f72e95",
"sha256": "76e8348473802387a7293259a84c993641ce312c20b85d317f60a1a9d43a530e"
},
"downloads": -1,
"filename": "duckduckgo_search-3.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23001342f692c9f6d5b269b640f72e95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17957,
"upload_time": "2023-06-03T07:40:03",
"upload_time_iso_8601": "2023-06-03T07:40:03.259462Z",
"url": "https://files.pythonhosted.org/packages/11/c0/96aa4e4b36554c626e2be2d20ee8287ddf199a843c5cebf91c4b16a2dfd3/duckduckgo_search-3.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7acb4b259c6d753d71329130cbedd3b49f69b809bd4f39ed8ee84e0a7f106068",
"md5": "75771683ea0f822609efcaa047cf8f74",
"sha256": "20787d8c0d73794b32c4ef18da94b87b53c0275bcaa16d1a028a612949320463"
},
"downloads": -1,
"filename": "duckduckgo_search-3.8.1.tar.gz",
"has_sig": false,
"md5_digest": "75771683ea0f822609efcaa047cf8f74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20280,
"upload_time": "2023-06-03T07:40:05",
"upload_time_iso_8601": "2023-06-03T07:40:05.503774Z",
"url": "https://files.pythonhosted.org/packages/7a/cb/4b259c6d753d71329130cbedd3b49f69b809bd4f39ed8ee84e0a7f106068/duckduckgo_search-3.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-03 07:40:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deedy5",
"github_project": "duckduckgo_search",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "duckduckgo-search"
}
