Skip to content

Commit 1c9941d

Browse files
jjsaunierjjsaunier
committed
Update API documentation for version 0.11.1
1 parent e0d813d commit 1c9941d

2 files changed

Lines changed: 72 additions & 120 deletions

File tree

‎docs/scrapfly/client.html‎

Lines changed: 36 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1703,45 +1703,38 @@ <h3>Class variables</h3>
17031703
def cloud_browser_unblock(
17041704
self,
17051705
url: str,
1706-
proxy_pool: Optional[str] = None,
17071706
country: Optional[str] = None,
17081707
os: Optional[str] = None,
17091708
browser_brand: Optional[str] = None,
1709+
session: Optional[str] = None,
17101710
timeout: Optional[int] = None,
17111711
browser_timeout: Optional[int] = None,
1712-
headers: Optional[Dict] = None,
1713-
body: Optional[str] = None,
1714-
method: Optional[str] = None,
17151712
enable_mcp: Optional[bool] = None,
17161713
debug: Optional[bool] = None,
17171714
) -&gt; Dict:
17181715
&#34;&#34;&#34;
17191716
Bypass anti-bot protection and get a ready-to-use browser session.
1717+
1718+
Unblock always uses a residential proxy (no proxy pool selection) and
1719+
always performs a GET — the endpoint&#39;s purpose is to harvest cookies /
1720+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
1721+
HTTP requests.
1722+
17201723
:param url: Target URL to navigate to and bypass protection
1721-
:param proxy_pool: Proxy pool: &#39;datacenter&#39; or &#39;residential&#39;
1722-
:param country: ISO country code for proxy geolocation
1724+
:param country: ISO country code for residential proxy geolocation
17231725
:param os: Operating system fingerprint: &#39;linux&#39;, &#39;windows&#39;, &#39;macos&#39;
17241726
:param browser_brand: Browser brand fingerprint: &#39;chrome&#39;, &#39;edge&#39;, &#39;brave&#39;, &#39;opera&#39;
1727+
:param session: Named session for reconnection — reuses the existing ASP
1728+
session when one exists and disables auto-close on disconnect
17251729
:param timeout: Navigation timeout in seconds (max 300)
17261730
:param browser_timeout: Browser session timeout in seconds (max 1800)
1727-
:param headers: Custom request headers
1728-
:param body: Request body for POST/PUT/PATCH requests
1729-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
17301731
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
17311732
:param debug: When True, the session is recorded and accessible via
17321733
cloud_browser_playback / cloud_browser_video using the returned run_id
17331734
:return: dict with ws_url, session_id, run_id
17341735
&#34;&#34;&#34;
1735-
proxy_pool_map = {
1736-
&#39;datacenter&#39;: &#39;public_datacenter_pool&#39;,
1737-
&#39;residential&#39;: &#39;public_residential_pool&#39;,
1738-
}
1739-
17401736
json_body = {&#39;url&#39;: url}
17411737

1742-
if proxy_pool is not None:
1743-
json_body[&#39;proxy_pool&#39;] = proxy_pool_map.get(proxy_pool, proxy_pool)
1744-
17451738
if country is not None:
17461739
json_body[&#39;country&#39;] = country
17471740

@@ -1751,21 +1744,15 @@ <h3>Class variables</h3>
17511744
if browser_brand is not None:
17521745
json_body[&#39;browser_brand&#39;] = browser_brand
17531746

1747+
if session is not None:
1748+
json_body[&#39;session&#39;] = session
1749+
17541750
if timeout is not None:
17551751
json_body[&#39;timeout&#39;] = timeout
17561752

17571753
if browser_timeout is not None:
17581754
json_body[&#39;browser_timeout&#39;] = browser_timeout
17591755

1760-
if headers is not None:
1761-
json_body[&#39;headers&#39;] = headers
1762-
1763-
if body is not None:
1764-
json_body[&#39;body&#39;] = body
1765-
1766-
if method is not None:
1767-
json_body[&#39;method&#39;] = method
1768-
17691756
if enable_mcp is not None:
17701757
json_body[&#39;enable_mcp&#39;] = enable_mcp
17711758

@@ -3027,7 +3014,7 @@ <h2 id="example">Example</h2>
30273014
:return: dict with 'sessions' list and 'total' count</p></div>
30283015
</dd>
30293016
<dt id="scrapfly.client.ScrapflyClient.cloud_browser_unblock"><code class="name flex">
3030-
<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>proxy_pool: str | None = None,<br>country: str | None = None,<br>os: str | None = None,<br>browser_brand: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>headers: Dict | None = None,<br>body: str | None = None,<br>method: str | None = None,<br>enable_mcp: bool | None = None,<br>debug: bool | None = None) ‑> Dict</span>
3017+
<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>country: str | None = None,<br>os: str | None = None,<br>browser_brand: str | None = None,<br>session: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>enable_mcp: bool | None = None,<br>debug: bool | None = None) ‑> Dict</span>
30313018
</code></dt>
30323019
<dd>
30333020
<details class="source">
@@ -3037,45 +3024,38 @@ <h2 id="example">Example</h2>
30373024
<pre><code class="python">def cloud_browser_unblock(
30383025
self,
30393026
url: str,
3040-
proxy_pool: Optional[str] = None,
30413027
country: Optional[str] = None,
30423028
os: Optional[str] = None,
30433029
browser_brand: Optional[str] = None,
3030+
session: Optional[str] = None,
30443031
timeout: Optional[int] = None,
30453032
browser_timeout: Optional[int] = None,
3046-
headers: Optional[Dict] = None,
3047-
body: Optional[str] = None,
3048-
method: Optional[str] = None,
30493033
enable_mcp: Optional[bool] = None,
30503034
debug: Optional[bool] = None,
30513035
) -&gt; Dict:
30523036
&#34;&#34;&#34;
30533037
Bypass anti-bot protection and get a ready-to-use browser session.
3038+
3039+
Unblock always uses a residential proxy (no proxy pool selection) and
3040+
always performs a GET — the endpoint&#39;s purpose is to harvest cookies /
3041+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
3042+
HTTP requests.
3043+
30543044
:param url: Target URL to navigate to and bypass protection
3055-
:param proxy_pool: Proxy pool: &#39;datacenter&#39; or &#39;residential&#39;
3056-
:param country: ISO country code for proxy geolocation
3045+
:param country: ISO country code for residential proxy geolocation
30573046
:param os: Operating system fingerprint: &#39;linux&#39;, &#39;windows&#39;, &#39;macos&#39;
30583047
:param browser_brand: Browser brand fingerprint: &#39;chrome&#39;, &#39;edge&#39;, &#39;brave&#39;, &#39;opera&#39;
3048+
:param session: Named session for reconnection — reuses the existing ASP
3049+
session when one exists and disables auto-close on disconnect
30593050
:param timeout: Navigation timeout in seconds (max 300)
30603051
:param browser_timeout: Browser session timeout in seconds (max 1800)
3061-
:param headers: Custom request headers
3062-
:param body: Request body for POST/PUT/PATCH requests
3063-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
30643052
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
30653053
:param debug: When True, the session is recorded and accessible via
30663054
cloud_browser_playback / cloud_browser_video using the returned run_id
30673055
:return: dict with ws_url, session_id, run_id
30683056
&#34;&#34;&#34;
3069-
proxy_pool_map = {
3070-
&#39;datacenter&#39;: &#39;public_datacenter_pool&#39;,
3071-
&#39;residential&#39;: &#39;public_residential_pool&#39;,
3072-
}
3073-
30743057
json_body = {&#39;url&#39;: url}
30753058

3076-
if proxy_pool is not None:
3077-
json_body[&#39;proxy_pool&#39;] = proxy_pool_map.get(proxy_pool, proxy_pool)
3078-
30793059
if country is not None:
30803060
json_body[&#39;country&#39;] = country
30813061

@@ -3085,21 +3065,15 @@ <h2 id="example">Example</h2>
30853065
if browser_brand is not None:
30863066
json_body[&#39;browser_brand&#39;] = browser_brand
30873067

3068+
if session is not None:
3069+
json_body[&#39;session&#39;] = session
3070+
30883071
if timeout is not None:
30893072
json_body[&#39;timeout&#39;] = timeout
30903073

30913074
if browser_timeout is not None:
30923075
json_body[&#39;browser_timeout&#39;] = browser_timeout
30933076

3094-
if headers is not None:
3095-
json_body[&#39;headers&#39;] = headers
3096-
3097-
if body is not None:
3098-
json_body[&#39;body&#39;] = body
3099-
3100-
if method is not None:
3101-
json_body[&#39;method&#39;] = method
3102-
31033077
if enable_mcp is not None:
31043078
json_body[&#39;enable_mcp&#39;] = enable_mcp
31053079

@@ -3123,17 +3097,19 @@ <h2 id="example">Example</h2>
31233097

31243098
return response.json()</code></pre>
31253099
</details>
3126-
<div class="desc"><p>Bypass anti-bot protection and get a ready-to-use browser session.
3127-
:param url: Target URL to navigate to and bypass protection
3128-
:param proxy_pool: Proxy pool: 'datacenter' or 'residential'
3129-
:param country: ISO country code for proxy geolocation
3100+
<div class="desc"><p>Bypass anti-bot protection and get a ready-to-use browser session.</p>
3101+
<p>Unblock always uses a residential proxy (no proxy pool selection) and
3102+
always performs a GET — the endpoint's purpose is to harvest cookies /
3103+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
3104+
HTTP requests.</p>
3105+
<p>:param url: Target URL to navigate to and bypass protection
3106+
:param country: ISO country code for residential proxy geolocation
31303107
:param os: Operating system fingerprint: 'linux', 'windows', 'macos'
31313108
:param browser_brand: Browser brand fingerprint: 'chrome', 'edge', 'brave', 'opera'
3109+
:param session: Named session for reconnection — reuses the existing ASP
3110+
session when one exists and disables auto-close on disconnect
31323111
:param timeout: Navigation timeout in seconds (max 300)
31333112
:param browser_timeout: Browser session timeout in seconds (max 1800)
3134-
:param headers: Custom request headers
3135-
:param body: Request body for POST/PUT/PATCH requests
3136-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
31373113
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
31383114
:param debug: When True, the session is recorded and accessible via
31393115
cloud_browser_playback / cloud_browser_video using the returned run_id

‎docs/scrapfly/index.html‎

Lines changed: 36 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -12224,45 +12224,38 @@ <h3>Ancestors</h3>
1222412224
def cloud_browser_unblock(
1222512225
self,
1222612226
url: str,
12227-
proxy_pool: Optional[str] = None,
1222812227
country: Optional[str] = None,
1222912228
os: Optional[str] = None,
1223012229
browser_brand: Optional[str] = None,
12230+
session: Optional[str] = None,
1223112231
timeout: Optional[int] = None,
1223212232
browser_timeout: Optional[int] = None,
12233-
headers: Optional[Dict] = None,
12234-
body: Optional[str] = None,
12235-
method: Optional[str] = None,
1223612233
enable_mcp: Optional[bool] = None,
1223712234
debug: Optional[bool] = None,
1223812235
) -&gt; Dict:
1223912236
&#34;&#34;&#34;
1224012237
Bypass anti-bot protection and get a ready-to-use browser session.
12238+
12239+
Unblock always uses a residential proxy (no proxy pool selection) and
12240+
always performs a GET — the endpoint&#39;s purpose is to harvest cookies /
12241+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
12242+
HTTP requests.
12243+
1224112244
:param url: Target URL to navigate to and bypass protection
12242-
:param proxy_pool: Proxy pool: &#39;datacenter&#39; or &#39;residential&#39;
12243-
:param country: ISO country code for proxy geolocation
12245+
:param country: ISO country code for residential proxy geolocation
1224412246
:param os: Operating system fingerprint: &#39;linux&#39;, &#39;windows&#39;, &#39;macos&#39;
1224512247
:param browser_brand: Browser brand fingerprint: &#39;chrome&#39;, &#39;edge&#39;, &#39;brave&#39;, &#39;opera&#39;
12248+
:param session: Named session for reconnection — reuses the existing ASP
12249+
session when one exists and disables auto-close on disconnect
1224612250
:param timeout: Navigation timeout in seconds (max 300)
1224712251
:param browser_timeout: Browser session timeout in seconds (max 1800)
12248-
:param headers: Custom request headers
12249-
:param body: Request body for POST/PUT/PATCH requests
12250-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
1225112252
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
1225212253
:param debug: When True, the session is recorded and accessible via
1225312254
cloud_browser_playback / cloud_browser_video using the returned run_id
1225412255
:return: dict with ws_url, session_id, run_id
1225512256
&#34;&#34;&#34;
12256-
proxy_pool_map = {
12257-
&#39;datacenter&#39;: &#39;public_datacenter_pool&#39;,
12258-
&#39;residential&#39;: &#39;public_residential_pool&#39;,
12259-
}
12260-
1226112257
json_body = {&#39;url&#39;: url}
1226212258

12263-
if proxy_pool is not None:
12264-
json_body[&#39;proxy_pool&#39;] = proxy_pool_map.get(proxy_pool, proxy_pool)
12265-
1226612259
if country is not None:
1226712260
json_body[&#39;country&#39;] = country
1226812261

@@ -12272,21 +12265,15 @@ <h3>Ancestors</h3>
1227212265
if browser_brand is not None:
1227312266
json_body[&#39;browser_brand&#39;] = browser_brand
1227412267

12268+
if session is not None:
12269+
json_body[&#39;session&#39;] = session
12270+
1227512271
if timeout is not None:
1227612272
json_body[&#39;timeout&#39;] = timeout
1227712273

1227812274
if browser_timeout is not None:
1227912275
json_body[&#39;browser_timeout&#39;] = browser_timeout
1228012276

12281-
if headers is not None:
12282-
json_body[&#39;headers&#39;] = headers
12283-
12284-
if body is not None:
12285-
json_body[&#39;body&#39;] = body
12286-
12287-
if method is not None:
12288-
json_body[&#39;method&#39;] = method
12289-
1229012277
if enable_mcp is not None:
1229112278
json_body[&#39;enable_mcp&#39;] = enable_mcp
1229212279

@@ -13548,7 +13535,7 @@ <h2 id="example">Example</h2>
1354813535
:return: dict with 'sessions' list and 'total' count</p></div>
1354913536
</dd>
1355013537
<dt id="scrapfly.ScrapflyClient.cloud_browser_unblock"><code class="name flex">
13551-
<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>proxy_pool: str | None = None,<br>country: str | None = None,<br>os: str | None = None,<br>browser_brand: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>headers: Dict | None = None,<br>body: str | None = None,<br>method: str | None = None,<br>enable_mcp: bool | None = None,<br>debug: bool | None = None) ‑> Dict</span>
13538+
<span>def <span class="ident">cloud_browser_unblock</span></span>(<span>self,<br>url: str,<br>country: str | None = None,<br>os: str | None = None,<br>browser_brand: str | None = None,<br>session: str | None = None,<br>timeout: int | None = None,<br>browser_timeout: int | None = None,<br>enable_mcp: bool | None = None,<br>debug: bool | None = None) ‑> Dict</span>
1355213539
</code></dt>
1355313540
<dd>
1355413541
<details class="source">
@@ -13558,45 +13545,38 @@ <h2 id="example">Example</h2>
1355813545
<pre><code class="python">def cloud_browser_unblock(
1355913546
self,
1356013547
url: str,
13561-
proxy_pool: Optional[str] = None,
1356213548
country: Optional[str] = None,
1356313549
os: Optional[str] = None,
1356413550
browser_brand: Optional[str] = None,
13551+
session: Optional[str] = None,
1356513552
timeout: Optional[int] = None,
1356613553
browser_timeout: Optional[int] = None,
13567-
headers: Optional[Dict] = None,
13568-
body: Optional[str] = None,
13569-
method: Optional[str] = None,
1357013554
enable_mcp: Optional[bool] = None,
1357113555
debug: Optional[bool] = None,
1357213556
) -&gt; Dict:
1357313557
&#34;&#34;&#34;
1357413558
Bypass anti-bot protection and get a ready-to-use browser session.
13559+
13560+
Unblock always uses a residential proxy (no proxy pool selection) and
13561+
always performs a GET — the endpoint&#39;s purpose is to harvest cookies /
13562+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
13563+
HTTP requests.
13564+
1357513565
:param url: Target URL to navigate to and bypass protection
13576-
:param proxy_pool: Proxy pool: &#39;datacenter&#39; or &#39;residential&#39;
13577-
:param country: ISO country code for proxy geolocation
13566+
:param country: ISO country code for residential proxy geolocation
1357813567
:param os: Operating system fingerprint: &#39;linux&#39;, &#39;windows&#39;, &#39;macos&#39;
1357913568
:param browser_brand: Browser brand fingerprint: &#39;chrome&#39;, &#39;edge&#39;, &#39;brave&#39;, &#39;opera&#39;
13569+
:param session: Named session for reconnection — reuses the existing ASP
13570+
session when one exists and disables auto-close on disconnect
1358013571
:param timeout: Navigation timeout in seconds (max 300)
1358113572
:param browser_timeout: Browser session timeout in seconds (max 1800)
13582-
:param headers: Custom request headers
13583-
:param body: Request body for POST/PUT/PATCH requests
13584-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
1358513573
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
1358613574
:param debug: When True, the session is recorded and accessible via
1358713575
cloud_browser_playback / cloud_browser_video using the returned run_id
1358813576
:return: dict with ws_url, session_id, run_id
1358913577
&#34;&#34;&#34;
13590-
proxy_pool_map = {
13591-
&#39;datacenter&#39;: &#39;public_datacenter_pool&#39;,
13592-
&#39;residential&#39;: &#39;public_residential_pool&#39;,
13593-
}
13594-
1359513578
json_body = {&#39;url&#39;: url}
1359613579

13597-
if proxy_pool is not None:
13598-
json_body[&#39;proxy_pool&#39;] = proxy_pool_map.get(proxy_pool, proxy_pool)
13599-
1360013580
if country is not None:
1360113581
json_body[&#39;country&#39;] = country
1360213582

@@ -13606,21 +13586,15 @@ <h2 id="example">Example</h2>
1360613586
if browser_brand is not None:
1360713587
json_body[&#39;browser_brand&#39;] = browser_brand
1360813588

13589+
if session is not None:
13590+
json_body[&#39;session&#39;] = session
13591+
1360913592
if timeout is not None:
1361013593
json_body[&#39;timeout&#39;] = timeout
1361113594

1361213595
if browser_timeout is not None:
1361313596
json_body[&#39;browser_timeout&#39;] = browser_timeout
1361413597

13615-
if headers is not None:
13616-
json_body[&#39;headers&#39;] = headers
13617-
13618-
if body is not None:
13619-
json_body[&#39;body&#39;] = body
13620-
13621-
if method is not None:
13622-
json_body[&#39;method&#39;] = method
13623-
1362413598
if enable_mcp is not None:
1362513599
json_body[&#39;enable_mcp&#39;] = enable_mcp
1362613600

@@ -13644,17 +13618,19 @@ <h2 id="example">Example</h2>
1364413618

1364513619
return response.json()</code></pre>
1364613620
</details>
13647-
<div class="desc"><p>Bypass anti-bot protection and get a ready-to-use browser session.
13648-
:param url: Target URL to navigate to and bypass protection
13649-
:param proxy_pool: Proxy pool: 'datacenter' or 'residential'
13650-
:param country: ISO country code for proxy geolocation
13621+
<div class="desc"><p>Bypass anti-bot protection and get a ready-to-use browser session.</p>
13622+
<p>Unblock always uses a residential proxy (no proxy pool selection) and
13623+
always performs a GET — the endpoint's purpose is to harvest cookies /
13624+
clearance tokens via an ASP-bypass navigation, not to proxy arbitrary
13625+
HTTP requests.</p>
13626+
<p>:param url: Target URL to navigate to and bypass protection
13627+
:param country: ISO country code for residential proxy geolocation
1365113628
:param os: Operating system fingerprint: 'linux', 'windows', 'macos'
1365213629
:param browser_brand: Browser brand fingerprint: 'chrome', 'edge', 'brave', 'opera'
13630+
:param session: Named session for reconnection — reuses the existing ASP
13631+
session when one exists and disables auto-close on disconnect
1365313632
:param timeout: Navigation timeout in seconds (max 300)
1365413633
:param browser_timeout: Browser session timeout in seconds (max 1800)
13655-
:param headers: Custom request headers
13656-
:param body: Request body for POST/PUT/PATCH requests
13657-
:param method: HTTP method: GET, POST, PUT, PATCH, DELETE
1365813634
:param enable_mcp: Enable MCP streamable-HTTP endpoint on the session
1365913635
:param debug: When True, the session is recorded and accessible via
1366013636
cloud_browser_playback / cloud_browser_video using the returned run_id

0 commit comments

Comments
 (0)