API Endpoints

The base url for all endpoints is https://rebrowser.net/api

All endpoints require a parameter apiKey which could be found on Dashboard / API.

Usage example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
fetch('https://rebrowser.net/api/startRun?apiKey=API_KEY&profileId=PROFILE_ID')
  .then(response => {
    console.log(response)
    /*
    {
      run: {
        id: 1337,
        secretToken: 'xxx',
        browserWSEndpoint: 'wss://ws.rebrowser.net/...',
        cdpEndpoints: {
          version: 'https://ws.rebrowser.net/cdp/json/version?secretToken=xxx',
          list: 'https://ws.rebrowser.net/cdp/json/list?secretToken=xxx'
        }
      }
    }
    */
  })

GET /startRun

Start a new run. Return ID of the run, WS endpoints.

Available parameters
profileId

Profile ID, can be found on Dashboard / Profiles.

If this param is missing, your first available profile will be picked automatically.

startRun via WebSockets

You can also call startRun via WebSockets. It could be useful, for example, with Puppeteer, when you just want to replace browserWSEndpoint and don't write any extra code.

For WebSockets endpoints, use wss://ws.rebrowser.net/

Take a look at the example below. You can use all the same parameters as in startRun.

1
2
3
4
5
6
const rebrowserParams = {
  apiKey: 'YOUR_API_KEY',
}
const browser = await puppeteer.connect({
  browserWSEndpoint: `wss://ws.rebrowser.net/?${new URLSearchParams(rebrowserParams)}`,
})

GET /finishRun

Finish the run. All CDP sessions will be immediately disconnected.

Available parameters
runIdrequired

Run ID, can be found on Dashboard / Runs.

GET /api/cleanProfileData

Remove all profile data of the specific profile, including cookies, localStorage and other.

Available parameters
profileIdrequired

Profile ID, can be found on Dashboard / Profiles.

unlinkBrowser

Pass 1 if you would like to unlink the profile from the browser. This will lead to picking up a new browser on the next run of the profile.

GET /getProfileData

Get all profile data of the specific profile, including cookies, localStorage and other.

Available parameters
profileIdrequired

Profile ID, can be found on Dashboard / Profiles.

filterByDomain

Return only data related to the specific domain. Helps to make response smaller if your profile has a lot of data and you just need cookies for some specific website.

← Best Practices
Custom CDP Methods →