diff --git a/README.md b/README.md index 962510f..17e61b4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +**Note:** This version of the BrowserStack API has been deprecated. Please use [BrowserStack API v4.0](https://github.com/browserstack/api) # API Overview The following denotes the HTTP-based API for [BrowserStack](http://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. @@ -172,3 +173,31 @@ This method will return the list of workers whose status is either `queue` or `r } ... ] ``` + + +## Getting API Status +If you want to know the status of your API, use the following method + + GET /status + +This will return the current status of API, like how much API time has been used and how many workers are runnning parallely. + +```javascript + { + used_time: '4235.4', + total_available_time: '6000', + running_windows_sessions: '1', + windows_sessions_limit: '1' + running_mac_sessions: '1', + mac_sessions_limit: '2' + } +``` +The time returned is in seconds. + +If a user runs out of API time, all requests will return following response + +```javascript + { + message: "You have run out of API time" + } +```