🎉 Try Our Residential Proxies @ 1.25$/GB 🎉

REST API Reference

Thispage contains all the documentation for our REST API endpoints.

https://api.blitzbrowser.com

This is the origin to interact with our REST API endpoints.

x-api-key: ${ACCESS_KEY} Required

The access key is required connect to our REST API. The access key can be the same one used to connect to our browsers. It's important to keep your access keys private to prevent unauthorized access. You can create your access key from the access keys dashboard.

User Data

GET /user-data/${USER_DATA_ID}

Download the latest version of the user data related to the ID. If no user data exist, it returns 404.

POST /user-data/${USER_DATA_ID}

Upload the user data related to the ID. If the user data already exists, it will override the existing version.

The ID has to match the regex /^[a-zA-Z0-9-_]{1,64}$/. The user data has to be a gzip tar .tar.gz file. You have to send the user data with a form data body into the key file. The content type header has to be application/octet-stream.

DELETE /user-data/${USER_DATA_ID}

Delete the user data related to the ID.