Functions
	request (query, params)

	response (resp)

Variables
dict	about

list	categories = ['music']

bool	paging = True

	api_client_id = None

	api_client_secret = None

str	url = 'https://api.spotify.com/'

str	search_url = url + 'v1/search?{query}&type=track&offset={offset}'

Detailed Description

Spotify (Music)

Function Documentation

◆ request()

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

Definition at line 34 of file spotify.py.

def request(query, params):
    offset = (params['pageno'] - 1) * 20
 
    params['url'] = search_url.format(query=urlencode({'q': query}), offset=offset)
 
    r = http_post(
        'https://accounts.spotify.com/api/token',
        data={'grant_type': 'client_credentials'},
        headers={
            'Authorization': 'Basic '
            + base64.b64encode("{}:{}".format(api_client_id, api_client_secret).encode()).decode()
        },
    )
    j = loads(r.text)
    params['headers'] = {'Authorization': 'Bearer {}'.format(j.get('access_token'))}
 
    return params
 
 
# get response from search-request

References searx.format.

◆ response()

searx.engines.spotify.response ( resp )

Definition at line 54 of file spotify.py.

def response(resp):
    results = []
 
    search_res = loads(resp.text)
 
    # parse results
    for result in search_res.get('tracks', {}).get('items', {}):
        if result['type'] == 'track':
            title = result['name']
            link = result['external_urls']['spotify']
            content = '{} - {} - {}'.format(result['artists'][0]['name'], result['album']['name'], result['name'])
 
            # append result
            results.append(
                {
                    'url': link,
                    'title': title,
                    'iframe_src': "https://embed.spotify.com/?uri=spotify:track:" + result['id'],
                    'content': content,
                }
            )
 
    # return results
    return results

References searx.format.

Variable Documentation

◆ about

dict searx.engines.spotify.about

Initial value:

=  {
    "website": 'https://www.spotify.com',
    "wikidata_id": 'Q689141',
    "official_api_documentation": 'https://developer.spotify.com/web-api/search-item/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 13 of file spotify.py.

◆ api_client_id

searx.engines.spotify.api_client_id = None

Definition at line 25 of file spotify.py.

◆ api_client_secret

searx.engines.spotify.api_client_secret = None

Definition at line 26 of file spotify.py.

◆ categories

list searx.engines.spotify.categories = ['music']

Definition at line 23 of file spotify.py.

◆ paging

bool searx.engines.spotify.paging = True

Definition at line 24 of file spotify.py.

◆ search_url

str searx.engines.spotify.search_url = url + 'v1/search?{query}&type=track&offset={offset}'

Definition at line 30 of file spotify.py.

◆ url

str searx.engines.spotify.url = 'https://api.spotify.com/'

Definition at line 29 of file spotify.py.

Functions

Variables