Functions
	get_client_id ()

	init (engine_settings=None)

	request (query, params)

	response (resp)

Variables
dict	about

list	categories = ['music']

bool	paging = True

str	url = 'https://api-v2.soundcloud.com/'

tuple	search_url

	cid_re = re.compile(r'client_id:"([^"]*)"', re.I \| re.U)

str	guest_client_id = ''

Detailed Description

 Soundcloud (Music)

Function Documentation

◆ get_client_id()

searx.engines.soundcloud.get_client_id ( )

Definition at line 44 of file soundcloud.py.

def get_client_id():
    resp = http_get("https://soundcloud.com")
 
    if resp.ok:
        tree = html.fromstring(resp.content)
        # script_tags has been moved from /assets/app/ to /assets/ path.  I
        # found client_id in https://a-v2.sndcdn.com/assets/49-a0c01933-3.js
        script_tags = tree.xpath("//script[contains(@src, '/assets/')]")
        app_js_urls = [script_tag.get('src') for script_tag in script_tags if script_tag is not None]
 
        # extracts valid app_js urls from soundcloud.com content
        for app_js_url in app_js_urls[::-1]:
            # gets app_js and searches for the clientid
            resp = http_get(app_js_url)
            if resp.ok:
                cids = cid_re.search(resp.content.decode())
                if cids is not None and len(cids.groups()):
                    return cids.groups()[0]
    logger.warning("Unable to fetch guest client_id from SoundCloud, check parser!")
    return ""
 
 

Referenced by searx.engines.soundcloud.init().

Here is the caller graph for this function:

◆ init()

searx.engines.soundcloud.init ( engine_settings = None )

Definition at line 66 of file soundcloud.py.

def init(engine_settings=None):  # pylint: disable=unused-argument
    global guest_client_id  # pylint: disable=global-statement
    # api-key
    guest_client_id = get_client_id()
 
 
# do search-request

References searx.engines.soundcloud.get_client_id().

Here is the call graph for this function:

◆ request()

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

Definition at line 73 of file soundcloud.py.

def request(query, params):
    offset = (params['pageno'] - 1) * 20
 
    params['url'] = search_url.format(query=urlencode({'q': query}), offset=offset, client_id=guest_client_id)
 
    return params

◆ response()

searx.engines.soundcloud.response ( resp )

Definition at line 81 of file soundcloud.py.

def response(resp):
    results = []
    search_res = loads(resp.text)
 
    # parse results
    for result in search_res.get('collection', []):
 
        if result['kind'] in ('track', 'playlist'):
            uri = quote_plus(result['uri'])
            res = {
                'url': result['permalink_url'],
                'title': result['title'],
                'content': result['description'] or '',
                'publishedDate': parser.parse(result['last_modified']),
                'iframe_src': "https://w.soundcloud.com/player/?url=" + uri,
            }
            img_src = result['artwork_url'] or result['user']['avatar_url']
            if img_src:
                res['img_src'] = img_src
            results.append(res)
 
    return results

Variable Documentation

◆ about

dict searx.engines.soundcloud.about

Initial value:

=  {
    "website": 'https://soundcloud.com',
    "wikidata_id": 'Q568769',
    "official_api_documentation": 'https://developers.soundcloud.com/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 14 of file soundcloud.py.

◆ categories

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

Definition at line 24 of file soundcloud.py.

◆ cid_re

searx.engines.soundcloud.cid_re = re.compile(r'client_id:"([^"]*)"', re.I | re.U)

Definition at line 40 of file soundcloud.py.

◆ guest_client_id

str searx.engines.soundcloud.guest_client_id = ''

Definition at line 41 of file soundcloud.py.

◆ paging

bool searx.engines.soundcloud.paging = True

Definition at line 25 of file soundcloud.py.

◆ search_url

tuple searx.engines.soundcloud.search_url