https://github.com/browserstack/api

Spec of latest BrowserStack JavaScript testing api
https://github.com/browserstack/api

Last synced: about 1 year ago
JSON representation

Spec of latest BrowserStack JavaScript testing api

• Host: GitHub
• URL: https://github.com/browserstack/api
• Owner: browserstack
• Created: 2011-10-11T13:10:47.000Z (over 14 years ago)
• Default Branch: v5
• Last Pushed: 2023-07-03T12:13:28.000Z (over 2 years ago)
• Last Synced: 2025-03-19T06:51:43.631Z (about 1 year ago)
• Homepage: https://www.browserstack.com/javascript-testing-api
• Size: 64.5 KB
• Stars: 120
• Watchers: 34
• Forks: 37
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# API Overview

The following denotes the HTTPS-based API for [BrowserStack](https://www.browserstack.com). It provides browser-as-a-service for automated cross-browser testing. The goal is to provide a simple service which can easily be used by any browser testing framework.

## Authentication

All methods need to authenticate who you are, before spawning browser workers and deleting a worker for example. Authentication is done using your username and the BrowserStack access key within the HTTP request.

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5

```

> Note: _A `401 Unauthorized` response is received if an unauthorized request is made._

## Schema

All requests are made to `https://api.browserstack.com/VERSION/` and all returned data is done so in JSON-format. This documentation outlines version 5.

```bash

curl -i -u "username:access_key" https://api.browserstack.com/5

```

Response:

```http

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf8

Status: 200 OK

X-API-Version: 5

{}

```

All date formats are given in ISO-8601 which can be processed natively with `Date.parse` in compatible JavaScript environments.

## Error Handling

All requests are pre-processed and validated. This section outlines how we handle errors within the API and respond to them.

All API requests are validated. The following is an example output for a required parameter that wasn't given.

```http

HTTP/1.1 422 Unprocessable Entity

Content-Length: 136

{

  "message": "Validation Failed",

  "errors": [

    {

      "field": "type",

      "code": "required"

    }

  ]

}

```

Possible error codes are `required` and `invalid`.

## HTTP Verbs

The API is kept concise and simple by making use of relevant HTTP verbs on each request. The specifications for these are vague and their use within this API is specific but in general, we follow the following rules:

* `HEAD` - Performs the request to assess the status of a resource and expects no content response.

* `GET` - Used to retrieve resources.

* `POST` - Used to create new resources.

* `PUT` - Used to update resources.

* `DELETE` - Used to delete resources.

# API v5 Documentation

## Getting Available Browsers

Fetches all available browsers.

```http

GET /browsers

```

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/browsers

```

Output:

```javascript

{

  'Windows':

    {

      '10':

        [

          {

            "browser": "chrome",

            "browser_version": "83.0"

          },

          {

            "browser": "chrome",

            "browser_version": "84.0"

          },

          {

            "browser": "chrome",

            "browser_version": "85.0 beta"

          },

          {

            "browser": "ie",

            "browser_version": "11.0"

          },

          {

            "browser": "edge",

            "browser_version": "insider preview"

          }...

        ],

    },

  'OS X':

    {

      'Catalina':

        [

          {

            "browser": "chrome",

            "browser_version": "85.0 beta"

          },

          {

            "browser": "edge",

            "browser_version": "85.0 beta"

          },

          {

            "browser": "safari",

            "browser_version": "13.1"

          },

          {

            "browser": "firefox",

            "browser_version": "79.0"

          },

          {

            "browser": "firefox",

            "browser_version": "80.0 beta"

          }...

        ],

      }...

    },

}

```

A flat parameter can also be passed to get browsers in a flat structure

```http

GET /browsers?flat=true

```

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/browsers?flat=true

```

Output:

```javascript

[  

  {

    "os": "Windows",

    "os_version": "10",

    "browser": "chrome",

    "device": null,

    "browser_version": "84.0",

    "real_mobile": null

  },

  {

    "os": "Windows",

    "os_version": "10",

    "browser": "edge",

    "device": null,

    "browser_version": "85.0 beta",

    "real_mobile": null

  },

  {

    "os": "OS X",

    "os_version": "Catalina",

    "browser": "firefox",

    "device": null,

    "browser_version": "79.0",

    "real_mobile": null

  },

  {

    "os": "OS X",

    "os_version": "Catalina",

    "browser": "firefox",

    "device": null,

    "browser_version": "80.0 beta",

    "real_mobile": null

  }....

]

```

## Create a New Browser Worker

A browser worker is simply a new browser instance. A user can start multiple browser worker at a time.

All browser workers when created are pushed in a queue and they run when their turn comes. We make sure that your browser worker starts running as soon as possible. Your testing time is calculated from the time when browser worker starts running.

```http

POST /worker

```

> Note: _This call requires authentication. A `401 Unauthorized` response is given if an unauthorized request is made._

For example:

```bash

curl -u "username:access_key" -X POST -d '{"os":"OS X","os_version":"Mojave","url":"https://browserstack.com","browser":"chrome","browser_version":"75.0"}' https://api.browserstack.com/5/worker -H 'content-type: application/json'

```

Response:

```bash

{"id":123456789,"url":"https://browserstack.com"}

```

Once a worker has been spawned you can then control this browser instance remotely. You can also look at the testing session status at the [Automate Dashboard](https://automate.browserstack.com/dashboard). This will provide you with the general details about the session and a live preview of the remote machine.

### Parameters

A valid request for Desktop OS must contain `os`, `os_version`, `url`, `browser` and `browser_version`.

For Mobile OS, `browser` and `browser_version` are optional.

`timeout` is optional but defaults to 300 seconds.

#### `os`

A valid OS. A list of supported OSs is given using the `GET /browsers`. See the [Getting Available Browsers](#getting-available-browsers) above for details.

#### `os_version`

A valid OS Version. A list of supported OS Versions is given using the `GET /browsers`. See the [Getting Available Browsers](#getting-available-browsers) above for details.

#### `browser`

A valid browser. A list of supported browsers is given using the `GET /browsers`. See the [Getting Available Browsers](#getting-available-browsers) above for details.

#### `device`

A valid device. A list of supported devices is given using the `GET /browsers`. If a device is not provided it defaults to the first device available for that os version. See the [Getting Available Browsers](#getting-available-browsers) above for details.

#### `browser_version`

A valid browser version. A list of supported browser versions is given using the `GET /browsers`.  See the [Getting Available Browsers](#getting-available-browsers) above for details.

#### `(timeout=300)`

Time in seconds before the worker is terminated. The default value is 300 seconds and the minimum value is 60 seconds.

> **IMPORTANT!** Irrespective of the `timeout` parameter, a browser worker is alive for a maximum time of 1800 seconds.

#### `(url)`

A valid url to navigate the browser to.

> Make sure the url is encoded. JavaScript: encodeURI(url), PHP: urlencode($url),

#### `(name)`

Provide a name to the session/worker.

#### `(build)`

Optional name of the build the session is running under.

#### `(project)`

Optional name of the project the build is under.

#### `(browserstack.video)`

Optional flag to enable video recording in your test.

#### `(resolution)`

Set the resolution of VM before the beginning of your test. Available for Desktop only. Default is 1024x768.

| _OS_ | _Supported Resolutions_ |

|:--------|:---------|

|Windows (XP,7)| 800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, 2048x1536|

|Windows (8,8.1,10)| 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, 2048x1536|

|OS X| 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080|

### Response

The response will be returned when the worker has been set up and initialized. This involves loading the HTML data or navigating to the url given depending on the setup parameters. Use the `id` returned to perform any further communications etc.

```http

HTTP/1.1 200 Success

Content-Type: application/json

X-API-Version: 5

{

  "id": "123456789"

}

```

### Screenshots

Use this method to take a screenshot at the current state of the worker.

```http

GET /worker//screenshot(.format)

```

Acceptable formats are `json`, `xml` and `png`. This information can also be provided via the HTTP `Accept` headers: `text/json`, `text/xml`, `image/png` respectively.

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/worker/123456789/screenshot.json

```

## Get Details of all Browser Workers

Returns comprehensive information, such as, worker ID, browser URL, session ID, etc., for all the browser workers you've created. It also returns the current status of the workers, which can be either `queue` or `running`.

 

```http

GET /workers

```

### Example request:

```bash

curl -u "username:access_key" -X GET https://api.browserstack.com/5/workers 

```

 

### Example response:

```javascript

[

  {

   "id": "",

   "status": "running",

   "os": "OS X",

   "os_version": "Mojave",

   "browser": "chrome",

   "browser_version": "75.0",

   "real_mobile": null,

   "device": null,

   "browser_url": "",

   "sessionId": ""

  },

 {

    "id": "",

    "status": "queue",

    "os": "android",

    "os_version": "2.2",

    "device": "Samsung Galaxy S",

    "browser": "Android Browser",

    "browser_version": null,

    "real_mobile": false,

    "browser_url": "",

    "sessionId": ""

  } ...]

```

## Terminating a Browser Worker

Use this method to terminate a worker. Useful if you set the worker up to run indefinitely or if you've received all the information needed and you want to save on credit time.

```http

DELETE  /worker/

```

The `id` is the id returned when you first created the worker. Once called the browser instance will be immediately terminated and will no longer be accessible.

> Note: _This call requires authentication. If the request was made unauthorized a `401 Unauthorized` response is given. Alternatively, if the authorized user is not the owner of the worker or `id` does not exist a `403 Forbidden` response is given. Also, if this request is sent within 60 seconds of starting the worker, the response will be `422 Unprocessable Entity` and the worker will be terminated after 60 seconds of its running time._

For example:

```bash

curl -u "username:access_key" -X DELETE https://api.browserstack.com/5/worker/123456789

```

## Getting Worker Status

Sometimes you will need to check on the status of a worker. Not to be confused with the state of the javascript environment within the worker, this method simply determines whether the worker is in the queue, running or terminated.

```http

GET /worker/

```

> _This call requires authentication. If the request was made unauthorized a `401 Unauthorized` response is given. Alternatively, if the authorized user is not the owner of the worker a `403 Forbidden` response is given._

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/worker/123456789

```

If the worker has been terminated an empty response is given. Otherwise, you get a response with status and browser details.

```javascript

{

  status: 'running',

  browser: 'ie',

  browser_version: '6.0',

  os: 'Windows',

  os_version: 'XP',

  sessionId: "",

  browser_url: ""

}

```

If you want to know the list of your current workers with their status, use the following method.

```http

GET /workers

```

This method will return the list of workers whose status is either `queue` or `running`.

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/workers

```

Response:

```javascript

[

  {

    status: 'running',

    browser: 'ie',

    version: '6.0',

    os: 'Windows',

    os_version: 'XP',

    sessionId: "",

    browser_url: ""

  },

  {

    status: 'queue',

    device: 'Samsung Galaxy Tab 8.9',

    os: 'android',

    os_version: '2.2',

    sessionId: "",

    browser_url: ""

  } ...

]

```

## Getting API Status

If you want to know the status of your API, use the following method

```http

GET /status

```

This will return the current status of API, like how much API time has been used and how many workers are running parallelly. All the paid plans have no time limits, only limit on parallel workers you can create.

For example:

```bash

curl -u "username:access_key" https://api.browserstack.com/5/status

```

```javascript

  {

    used_time: 4235.4,

    total_available_time: 6000,

    running_sessions: 1,

    sessions_limit: 1

  }

```

The time returned is in seconds.

If a user runs out of API time, all requests will return the following response

```javascript

{

  message: "You have run out of API time"

}

```

> **Note**: _You can make up to 1600 API requests every 5 minutes._