webscout 1.0.4

Search for words, documents, images, news, maps, and text translation using the DuckDuckGo.com search engine.

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.

⚠️ Warning: use AsyncWEBS in asynchronous code

Table of Contents

• Table of Contents
• Install
• CLI version
• Duckduckgo search operators
• Regions
• WEBS and AsyncWEBS classes
• Exceptions
• 1. text() - text search by duckduckgo.com
• 2. answers() - instant answers by duckduckgo.com
• 3. images() - image search by duckduckgo.com
• 4. videos() - video search by duckduckgo.com
• 5. news() - news search by duckduckgo.com
• 6. maps() - map search by duckduckgo.com
• 7. translate() - translation by duckduckgo.com
• 8. suggestions() - suggestions by duckduckgo.com

Install

pip install -U webscout

CLI version

python -m webscout --help

CLI examples: Go To 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

Regions

expand

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

---

Go To TOP

WEBS and AsyncWEBS classes

The WEBS and AsyncWEBS classes are used to retrieve search results from DuckDuckGo.com. To use the AsyncWEBS class, you can perform asynchronous operations using Python's asyncio library. To initialize an instance of the WEBS or AsyncWEBS classes, you can provide the following optional arguments:

class WEBS:
    """webscout class to get search results from duckduckgo.com

    Args:
        headers (dict, optional): Dictionary of headers for the HTTP client. Defaults to None.
        proxies (Union[dict, str], optional): Proxies for the HTTP client (can be dict or str). Defaults to None.
        timeout (int, optional): Timeout value for the HTTP client. Defaults to 10.
    """

Here is an example of initializing the WEBS class:

from webscout import WEBS

with WEBS() as WEBS:
    results = [r for r in WEBS.text("python programming", max_results=5)]
    print(results)

Here is an example of initializing the AsyncWEBS class:

import asyncio
import logging
import sys
from itertools import chain
from random import shuffle

import requests
from webscout import AsyncWEBS

# bypass curl-cffi NotImplementedError in windows https://curl-cffi.readthedocs.io/en/latest/faq/
if sys.platform.lower().startswith("win"):
    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

def get_words():
    word_site = "https://www.mit.edu/~ecprice/wordlist.10000"
    resp = requests.get(word_site)
    words = resp.text.splitlines()
    return words

async def aget_results(word):
    async with AsyncWEBS(proxies=proxies) as WEBS:
        results = [r async for r in WEBS.text(word, max_results=None)]
        return results

async def main():
    words = get_words()
    shuffle(words)
    tasks = []
    for word in words[:10]:
        tasks.append(aget_results(word))
    results = await asyncio.gather(*tasks)
    print(f"Done")
    for r in chain.from_iterable(results):
        print(r)
    

if __name__ == "__main__":
    logging.basicConfig(level=logging.DEBUG)
    asyncio.run(main())

It is important to note that the WEBS and AsyncWEBS classes should always be used as a context manager (with statement). This ensures proper resource management and cleanup, as the context manager will automatically handle opening and closing the HTTP client connection.

Exceptions

Exceptions:

• WebscoutE: Raised when there is a generic exception during the API request.

1. text() - text search by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    for r in WEBS.text('live free or die', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
        print(r)

# Searching for pdf files
with WEBS() as WEBS:
    for r in WEBS.text('russia filetype:pdf', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
        print(r)

2. answers() - instant answers by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    for r in WEBS.answers("sun"):
        print(r)

3. images() - image search by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    keywords = 'butterfly'
    WEBS_images_gen = WEBS.images(
      keywords,
      region="wt-wt",
      safesearch="off",
      size=None,
      color="Monochrome",
      type_image=None,
      layout=None,
      license_image=None,
      max_results=100,
    )
    for r in WEBS_images_gen:
        print(r)

4. videos() - video search by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    keywords = 'tesla'
    WEBS_videos_gen = WEBS.videos(
      keywords,
      region="wt-wt",
      safesearch="off",
      timelimit="w",
      resolution="high",
      duration="medium",
      max_results=100,
    )
    for r in WEBS_videos_gen:
        print(r)

5. news() - news search by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    keywords = 'holiday'
    WEBS_news_gen = WEBS.news(
      keywords,
      region="wt-wt",
      safesearch="off",
      timelimit="m",
      max_results=20
    )
    for r in WEBS_news_gen:
        print(r)

6. maps() - map search by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    for r in WEBS.maps("school", place="anantnag", max_results=50):
        print(r)

7. translate() - translation by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    keywords = 'school'
    r = WEBS.translate(keywords, to="de")
    print(r)

8. suggestions() - suggestions by duckduckgo.com

from webscout import WEBS

with WEBS() as WEBS:
    for r in WEBS.suggestions("fly"):
        print(r)