Functions
	request (query, params)

	response (resp)

Variables
dict	about

list	categories = ['videos', 'music']

bool	paging = False

	api_key = None

str	base_url = 'https://www.googleapis.com/youtube/v3/search'

str	search_url = base_url + '?part=snippet&{query}&maxResults=20&key={api_key}'

str	base_youtube_url = 'https://www.youtube.com/watch?v='

Detailed Description

 Youtube (Videos)

Function Documentation

◆ request()

searx.engines.youtube_api.request	(		query,
			params )

Definition at line 34 of file youtube_api.py.

def request(query, params):
    params['url'] = search_url.format(query=urlencode({'q': query}), api_key=api_key)
 
    # add language tag if specified
    if params['language'] != 'all':
        params['url'] += '&relevanceLanguage=' + params['language'].split('-')[0]
 
    return params
 
 
# get response from search-request

◆ response()

searx.engines.youtube_api.response ( resp )

Definition at line 45 of file youtube_api.py.

def response(resp):
    results = []
 
    search_results = loads(resp.text)
 
    if 'error' in search_results and 'message' in search_results['error']:
        raise SearxEngineAPIException(search_results['error']['message'])
 
    # return empty array if there are no results
    if 'items' not in search_results:
        return []
 
    # parse results
    for result in search_results['items']:
        if "videoId" not in result["id"]:
            # ignore channels
            continue
 
        videoid = result['id']['videoId']
 
        title = result['snippet']['title']
        content = ''
        thumbnail = ''
 
        pubdate = result['snippet']['publishedAt']
        publishedDate = parser.parse(pubdate)
 
        thumbnail = result['snippet']['thumbnails']['high']['url']
 
        content = result['snippet']['description']
 
        url = base_youtube_url + videoid
 
        # append result
        results.append(
            {
                'url': url,
                'title': title,
                'content': content,
                'template': 'videos.html',
                'publishedDate': publishedDate,
                'iframe_src': "https://www.youtube-nocookie.com/embed/" + videoid,
                'thumbnail': thumbnail,
            }
        )
 
    # return results
    return results

Variable Documentation

◆ about

dict searx.engines.youtube_api.about

Initial value:

=  {
    "website": 'https://www.youtube.com/',
    "wikidata_id": 'Q866',
    "official_api_documentation": 'https://developers.google.com/youtube/v3/docs/search/list?apix=true',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 13 of file youtube_api.py.

◆ api_key

searx.engines.youtube_api.api_key = None

Definition at line 25 of file youtube_api.py.

◆ base_url

str searx.engines.youtube_api.base_url = 'https://www.googleapis.com/youtube/v3/search'

Definition at line 28 of file youtube_api.py.

◆ base_youtube_url

str searx.engines.youtube_api.base_youtube_url = 'https://www.youtube.com/watch?v='

Definition at line 30 of file youtube_api.py.

◆ categories

list searx.engines.youtube_api.categories = ['videos', 'music']

Definition at line 23 of file youtube_api.py.

◆ paging

bool searx.engines.youtube_api.paging = False

Definition at line 24 of file youtube_api.py.

◆ search_url

str searx.engines.youtube_api.search_url = base_url + '?part=snippet&{query}&maxResults=20&key={api_key}'

Definition at line 29 of file youtube_api.py.

Functions

Variables