Skip to main content
POST
/
make-request
Execute a browser request to your website
curl --request POST \
  --url https://base.scrapexlabs.com/api/make-request/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "proxy_type": "standard",
  "proxy_country": "ad",
  "proxy_session_id": "mysession12",
  "proxy_session_lifetime": 300,
  "solve_cf_captcha": false,
  "js_instructions": [
    {
      "click": ".class1"
    }
  ],
  "stop_instructions_on_fail": false,
  "return_html": false,
  "return_cookies": false,
  "return_screenshot": false,
  "screenshot_full_page": false,
  "screenshot_selector": ".promoSection",
  "proxy_url": "user:[email protected]:8080",
  "locale_code": "en-us",
  "block_ads": false,
  "block_images": false,
  "device": "desktop",
  "custom_cookies": [
    {
      "name": "<string>",
      "value": "<string>",
      "path": "/hello",
      "domain": "example.com",
      "secure": true,
      "httpOnly": true,
      "expiry": 1711466833,
      "sameSite": "Strict"
    }
  ],
  "window_width": 1920,
  "window_height": 1080,
  "dark_mode": false
}
'
{
  "request_cost": 123,
  "current_concurrency": 123,
  "api_credits_balance": 123,
  "html": "<string>",
  "cookies": {
    "name": "cookie1",
    "value": "somevalue"
  },
  "screenshot": "<string>",
  "instructions_report": {
    "action": "click",
    "success": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string<uri>
required
Required string length: 1 - 2083
​
proxy_type
enum<string>
default:standard
Available options:
custom,
standard,
premium,
stealth
​
proxy_country
enum<string> | null
Available options:
ad,
ae,
af,
ag,
ai,
al,
am,
ao,
ar,
at,
au,
aw,
az,
ba,
bb,
bd,
be,
bf,
bg,
bh,
bi,
bj,
bm,
bn,
bo,
br,
bs,
bt,
bw,
by,
bz,
ca,
cd,
cg,
ch,
ci,
cl,
cm,
cn,
co,
cr,
cu,
cv,
cw,
cy,
cz,
de,
dk,
dm,
do,
dz,
ec,
ee,
eg,
es,
et,
fi,
fj,
fr,
ga,
gb,
gd,
ge,
gf,
gg,
gh,
gi,
gp,
gr,
gt,
gu,
gy,
hk,
hn,
hr,
ht,
hu,
id,
ie,
il,
im,
in,
iq,
ir,
is,
it,
je,
jm,
jo,
jp,
ke,
kg,
kh,
km,
kn,
kr,
kw,
ky,
kz,
la,
lb,
lc,
lk,
lr,
ls,
lt,
lu,
lv,
ly,
ma,
mc,
md,
me,
mf,
mg,
mk,
ml,
mm,
mn,
mo,
mq,
mr,
mt,
mu,
mv,
mw,
mx,
my,
mz,
na,
nc,
ng,
ni,
nl,
no,
np,
nz,
om,
pa,
pe,
pg,
ph,
pk,
pl,
pr,
ps,
pt,
py,
qa,
re,
ro,
rs,
ru,
rw,
sa,
sc,
sd,
se,
sg,
si,
sk,
sl,
sn,
so,
sr,
sv,
sx,
sy,
sz,
tc,
tg,
th,
tj,
tm,
tn,
tr,
tt,
tw,
tz,
ua,
ug,
us,
uy,
uz,
vc,
ve,
vg,
vi,
vn,
ye,
za,
zm,
zw
​
proxy_session_id
string | null
Required string length: 6 - 24
Example:

"mysession12"

​
proxy_session_lifetime
integer | null
default:180
Required range: 180 <= x <= 600
Example:

300

​
solve_cf_captcha
boolean
default:false
​
js_instructions
Js Instructions · object[] | null
Example:
[{ "click": ".class1" }]
​
stop_instructions_on_fail
boolean
default:false
​
return_html
boolean
default:false
​
return_cookies
boolean
default:false
​
return_screenshot
boolean
default:false
​
screenshot_full_page
boolean
default:false
​
screenshot_selector
string | null
Maximum string length: 1000
Example:

".promoSection"

​
proxy_url
string | null
Example:

"user:[email protected]:8080"

​
locale_code
string | null
Maximum string length: 6
Example:

"en-us"

​
block_ads
boolean
default:false
​
block_images
boolean
default:false
​
device
enum<string>
default:desktop
Available options:
desktop,
mobile
​
custom_cookies
CustomCookie · object[]
Maximum array length: 100
​
window_width
integer | null
default:1920
Required range: 100 <= x <= 5120
​
window_height
integer | null
default:1080
Required range: 100 <= x <= 2880
​
dark_mode
boolean
default:false

Response

Successful Response

​
request_cost
integer
required
​
current_concurrency
integer
required
​
api_credits_balance
integer
required
​
html
string | null
​
cookies
Cookies · object[] | null
Example:
{ "name": "cookie1", "value": "somevalue" }
​
screenshot
string | null
​
instructions_report
Instructions Report · object[] | null
Example:
{ "action": "click", "success": true }