.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
searx.engines.soundcloud Namespace Reference

Functions

 request (query, params)
 response (resp)
 init (engine_settings)
str|None get_client_id ()

Variables

dict about
list categories = ["music"]
bool paging = True
str search_url = "https://api-v2.soundcloud.com/search"
 cid_re = re.compile(r'client_id:"([^"]*)"', re.I | re.U)
int results_per_page = 10
str soundcloud_facet = "model"
dict app_locale_map

Detailed Description

SoundCloud is a German audio streaming service.

Function Documentation

◆ get_client_id()

str | None searx.engines.soundcloud.get_client_id ( )

Definition at line 123 of file soundcloud.py.

123def get_client_id() -> str | None:
124
125 client_id = ""
126 url = "https://soundcloud.com"
127 resp = http_get(url, timeout=10)
128
129 if not resp.ok:
130 logger.error("init: GET %s failed", url)
131 return client_id
132
133 tree = html.fromstring(resp.content)
134 script_tags = tree.xpath("//script[contains(@src, '/assets/')]")
135 app_js_urls = [tag.get("src") for tag in script_tags if tag is not None]
136
137 # extracts valid app_js urls from soundcloud.com content
138
139 for url in app_js_urls[::-1]:
140
141 # gets app_js and search for the client_id
142 resp = http_get(url)
143
144 if not resp.ok:
145 logger.error("init: app_js GET %s failed", url)
146 continue
147
148 cids = cid_re.search(resp.content.decode())
149 if cids and len(cids.groups()):
150 client_id = cids.groups()[0]
151 break
152
153 if client_id:
154 logger.info("using client_id '%s' for soundclud queries", client_id)
155 else:
156 logger.warning("missing valid client_id for soundclud queries")
157 return client_id or None

Referenced by request().

Here is the caller graph for this function:

◆ init()

searx.engines.soundcloud.init ( engine_settings)

Definition at line 118 of file soundcloud.py.

118def init(engine_settings): # pylint: disable=unused-argument
119 global CACHE # pylint: disable=global-statement
120 CACHE = EngineCache(engine_settings["name"]) # type:ignore
121
122

◆ request()

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

Definition at line 57 of file soundcloud.py.

57def request(query, params):
58
59 # missing attributes: user_id, app_version
60 # - user_id=451561-497874-703312-310156
61 # - app_version=1740727428
62
63 guest_client_id = CACHE.get("guest_client_id")
64 if guest_client_id is None:
65 guest_client_id = get_client_id()
66 if guest_client_id:
67 CACHE.set(key="guest_client_id", value=guest_client_id)
68
69 args = {
70 "q": query,
71 "offset": (params['pageno'] - 1) * results_per_page,
72 "limit": results_per_page,
73 "facet": soundcloud_facet,
74 "client_id": guest_client_id,
75 "app_locale": app_locale_map.get(params["language"].split("-")[0], "en"),
76 }
77
78 params['url'] = f"{search_url}?{urlencode(args)}"
79 return params
80
81

References get_client_id().

Here is the call graph for this function:

◆ response()

searx.engines.soundcloud.response ( resp)

Definition at line 82 of file soundcloud.py.

82def response(resp):
83 results = []
84 data = resp.json()
85
86 for result in data.get("collection", []):
87
88 if result["kind"] in ("track", "playlist"):
89 url = result.get("permalink_url")
90 if not url:
91 continue
92 uri = quote_plus(result.get("uri"))
93 content = [
94 result.get("description"),
95 result.get("label_name"),
96 ]
97 res = {
98 "url": url,
99 "title": result["title"],
100 "content": " / ".join([c for c in content if c]),
101 "publishedDate": parser.parse(result["last_modified"]),
102 "iframe_src": "https://w.soundcloud.com/player/?url=" + uri,
103 "views": result.get("likes_count"),
104 }
105 thumbnail = result["artwork_url"] or result["user"]["avatar_url"]
106 res["thumbnail"] = thumbnail or None
107 length = int(result.get("duration", 0) / 1000)
108 if length:
109 length = datetime.timedelta(seconds=length)
110 res["length"] = length
111 res["views"] = result.get("playback_count", 0) or None
112 res["author"] = result.get("user", {}).get("full_name") or None
113 results.append(res)
114
115 return results
116
117

Variable Documentation

◆ about

dict searx.engines.soundcloud.about
Initial value:
1= {
2 "website": "https://soundcloud.com",
3 "wikidata_id": "Q568769",
4 "official_api_documentation": "https://developers.soundcloud.com/docs/api/guide",
5 "use_official_api": False,
6 "require_api_key": False,
7 "results": 'JSON',
8}

Definition at line 15 of file soundcloud.py.

◆ app_locale_map

dict searx.engines.soundcloud.app_locale_map
Initial value:
1= {
2 "de": "de",
3 "en": "en",
4 "es": "es",
5 "fr": "fr",
6 "oc": "fr",
7 "it": "it",
8 "nl": "nl",
9 "pl": "pl",
10 "szl": "pl",
11 "pt": "pt_BR",
12 "pap": "pt_BR",
13 "sv": "sv",
14}

Definition at line 37 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 32 of file soundcloud.py.

◆ paging

bool searx.engines.soundcloud.paging = True

Definition at line 25 of file soundcloud.py.

◆ results_per_page

int searx.engines.soundcloud.results_per_page = 10

Definition at line 33 of file soundcloud.py.

◆ search_url

str searx.engines.soundcloud.search_url = "https://api-v2.soundcloud.com/search"

Definition at line 27 of file soundcloud.py.

◆ soundcloud_facet

str searx.engines.soundcloud.soundcloud_facet = "model"

Definition at line 35 of file soundcloud.py.