Spotted something off?Report on Discord
api reference
request.get
Send a GET request through a real browser session with full support for cookies, proxies, local storage, and custom headers.
Updated May 30, 2025
Make a GET request through a real browser session with full support for cookies, proxies, local storage, and more.
Session Timeout: A session will automatically expire 200 seconds after the last request.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string | Yes | The target URL to fetch. |
session |
string | No | Use an existing browser session. If not provided, a temporary instance is created and destroyed after the request. |
cookiejar |
array | No | Accepts an array of cookie objects to be set before visiting the page. Example: [{ "name": "cookie1", "value": "value1", "domain": "domain.com", "path": "/" }] |
cookies |
string | No | Raw cookie string to be injected before page load. Example: _ga=GA1.1.143964650.1682153807; _fbp=fb.1.1711313596391.220282865 |
proxy |
string | No | Use a custom proxy. Supports http://, socks4://, or socks5://. Authentication is supported. Example: http://username:[email protected]:8888. Ignored if session is set — use session-specific proxy in sessions.create instead. |
proxyCountry |
string | No | Select a specific country when using the built-in rotating proxies. Example: "UnitedStates" |
customHeaders |
object | No | Override default browser headers. Example: { "auth": "value" } |
includeImages |
boolean | No | Set to true to return a list of all image URLs found on the page. |
includeLinks |
boolean | No | Set to true to return a list of all hyperlinks found on the page. |
requestType |
string | No | Choose between "browser" (default full browser) and "request" (faster, no rendering). Automatically sets appropriate headers unless customHeaders is used. |
localStorage |
object | No | Set key-value pairs in the browser's localStorage before loading the page. Example: { "ac": "dsjfh84hfdsfk", "onboarding": "false" } |
Important Note
If you're using a Cloudflare clearance cookie, make sure the User-Agent used in your headers exactly matches the one used during clearance. Mismatched headers will trigger a challenge page.
Advanced Options
These optional parameters control the output format, browser configuration, and session behavior. They work on request.get, request.post, and the other request commands.
| Parameter | Type | Required | Description |
|---|---|---|---|
markdown |
boolean | No | Return the page converted to Markdown in solution.markdown. Respects includeImages / includeLinks. Combine with filter: ["markdown"] to return only the Markdown. |
pdf |
boolean | No | Render the loaded page to a PDF. The PDF is returned base64-encoded in the response. |
pageUrl |
string | No | Page-first fetch: load this URL first to establish a real session and cookies, then fetch the target url from within that browser context. Useful when an API endpoint depends on cookies or state established by a normal page visit. |
build |
string | array | No | Select the browser build: ff144, ff146, cl146, ff147, ff148, ff149, or ff150. Pass an array (e.g. ["ff148", "ff150"]) to select from available browser builds for compatibility testing. Defaults to the newest build. |
forceUniqueFingerprint |
boolean | No | Use a fresh browser configuration for this request. Useful for compatibility testing and isolated runs. Uses more resources. |
webrtcIpv4 |
string | No | IPv4 address to align WebRTC network settings with when forceUniqueFingerprint is enabled. Defaults to the proxy's IPv4. |
webrtcIpv6 |
string | No | IPv6 address to align WebRTC network settings with when forceUniqueFingerprint is enabled. Defaults to an IPv6 derived from the proxy, if available. |
captchaMethod |
string | No | Interactive challenge handling mode when automaticallySolveCaptchas is enabled. "token" (default) uses the integrated service; "click" handles the step interactively within the browser. |
overwriteLocale |
string | No | Force navigator.language, navigator.languages, and the Accept-Language header to this locale (e.g. "en-US") instead of auto-detecting it from the proxy IP's country. |
Return the page as Markdown
bash8 lines
Return the page as a PDF
bash7 lines
Page-first fetch (session warm-up)
Load a normal page to acquire cookies/session, then fetch a protected API endpoint from inside the same browser:
bash7 lines
Pin or randomize the browser build
bash7 lines
Force a unique fingerprint
bash7 lines
Force a specific locale
bash8 lines
Request
json4 lines
Response
json65 lines