Functions
	request (query, params)
	_image_result (result)
	_video_result (result)
	response (resp)

Variables
dict	about
str	base_url = 'https://pixabay.com'
list	categories = ['images']
str	pixabay_type = "images"
bool	paging = True
bool	safesearch = True
bool	time_range_support = True
dict	safesearch_map = {0: 'off', 1: '1', 2: '1'}
dict	time_range_map = {'day': '1d', 'week': '1w', 'month': '1m', 'year': '1y'}
bool	enable_http2 = False

Detailed Description

Pixabay provides royalty-free media (images, videos)

Function Documentation

◆ _image_result()

searx.engines.pixabay._image_result ( result )

protected

Definition at line 56 of file pixabay.py.

def _image_result(result):
    return {
        'template': 'images.html',
        'url': base_url + result["href"],
        # images are sorted in ascending quality
        'thumbnail_src': list(result['sources'].values())[0],
        'img_src': list(result['sources'].values())[-1],
        'title': result.get('name'),
        'content': result.get('description', ''),
    }
 
 

Referenced by response().

Here is the caller graph for this function:

◆ _video_result()

searx.engines.pixabay._video_result ( result )

protected

Definition at line 68 of file pixabay.py.

def _video_result(result):
    return {
        'template': 'videos.html',
        'url': base_url + result["href"],
        # images are sorted in ascending quality
        'thumbnail': result['sources'].get('thumbnail'),
        'iframe_src': result['sources'].get('embed'),
        'title': result.get('name'),
        'content': result.get('description', ''),
        'length': timedelta(seconds=result['duration']),
        'publishedDate': parser.parse(result['uploadDate']),
    }
 
 

Referenced by response().

Here is the caller graph for this function:

◆ request()

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

Definition at line 34 of file pixabay.py.

def request(query, params):
    args = {
        'pagi': params['pageno'],
    }
    if params['time_range']:
        args['date'] = time_range_map[params['time_range']]
 
    params['url'] = f"{base_url}/{pixabay_type}/search/{quote_plus(query)}/?{urlencode(args)}"
    params['headers'] = {
        'User-Agent': gen_useragent() + " Pixabay",
        'Accept': 'application/json',
        'x-bootstrap-cache-miss': '1',
        'x-fetch-bootstrap': '1',
    }
    params['cookies']['g_rated'] = safesearch_map[params['safesearch']]
 
    # prevent automatic redirects to first page on pagination
    params['allow_redirects'] = False
 
    return params
 
 

◆ response()

searx.engines.pixabay.response ( resp )

Definition at line 82 of file pixabay.py.

def response(resp):
    results = []
 
    # if there are no results on this page, we get a redirect
    # to the first page
    if resp.status_code == 302:
        return results
 
    json_data = resp.json()
 
    for result in json_data.get('page', {}).get('results', []):
        if result['mediaType'] in ('photo', 'illustration', 'vector'):
            results.append(_image_result(result))
        elif result['mediaType'] == 'video':
            results.append(_video_result(result))
 
    return results

References _image_result(), and _video_result().

Here is the call graph for this function:

Variable Documentation

◆ about

dict searx.engines.pixabay.about

Initial value:

=  {
    "website": 'https://pixabay.com',
    "wikidata_id": 'Q1746538',
    "official_api_documentation": 'https://pixabay.com/api/docs/',
    "use_official_api": False,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 10 of file pixabay.py.

◆ base_url

str searx.engines.pixabay.base_url = 'https://pixabay.com'

Definition at line 19 of file pixabay.py.

◆ categories

list searx.engines.pixabay.categories = ['images']

Definition at line 20 of file pixabay.py.

◆ enable_http2

bool searx.engines.pixabay.enable_http2 = False

Definition at line 31 of file pixabay.py.

◆ paging

bool searx.engines.pixabay.paging = True

Definition at line 23 of file pixabay.py.

◆ pixabay_type

str searx.engines.pixabay.pixabay_type = "images"

Definition at line 21 of file pixabay.py.

◆ safesearch

bool searx.engines.pixabay.safesearch = True

Definition at line 24 of file pixabay.py.

◆ safesearch_map

dict searx.engines.pixabay.safesearch_map = {0: 'off', 1: '1', 2: '1'}

Definition at line 27 of file pixabay.py.

◆ time_range_map

dict searx.engines.pixabay.time_range_map = {'day': '1d', 'week': '1w', 'month': '1m', 'year': '1y'}

Definition at line 28 of file pixabay.py.

◆ time_range_support

bool searx.engines.pixabay.time_range_support = True

Definition at line 25 of file pixabay.py.

Functions

Variables