Adspower Local API

https://localapi-doc-en.adspower.com/
Admin
Adspower Local API provides programmatic access to manage browser profiles, proxies, groups,...
Tokens:46,712
Snippets:244
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### API Response Examples

Source: https://localapi-doc-en.adspower.com/docs/EAGz8D

Examples of successful and failed JSON responses for the category list request.

```json
//Operation succeeded
{
    "data": {
        "list": [
            {
                "id": "XXX", // Application Category ID
                "name": "XXX",// Application Category Name
                "remark": "XXX"// Application Category Remarks
            }
        ],
        "page": 1,
        "page_size": 10
    },
    "code": 0,
    "msg": "Success"
}

//Operation failed
{
"code":-1,
"data":{},
"msg":"failed"
}
```

--------------------------------

### Close Browser V2 Response Examples

Source: https://localapi-doc-en.adspower.com/docs/Close-Browser-V2

Examples of successful and failed operation responses from the API.

```json
// Operation succeeded
{
  "code":0,
  "msg":"success"
}

// Operation failed
{
  "code":-1,
  "msg":"failed"
}
```

--------------------------------

### Start and Automate Browser Profile with Python Playwright

Source: https://localapi-doc-en.adspower.com/docs/K4IsTq

Uses httpx to request the browser start via the Local API and Playwright to connect to the browser instance.

```python
import httpx
from playwright.sync_api import sync_playwright
LOCAL_API_BASE = "http://127.0.0.1:50325"
Browser_ID = "XXX"
apiKey = "your_api_key_here"  # 定义 API Key 作为 token
headers = {
    'Authorization': f'Bearer {apiKey}'
}
response = httpx.post(f"{LOCAL_API_BASE}/api/v2/browser-profile/start", 
                     headers=headers,
                     json={
                         "profile_id": Browser_ID,
                         "last_opened_tabs": "0",
                         "proxy_detection": "0",
                     })
if response.status_code == 200:
    data = response.json()
    print(data['data']['ws']['puppeteer'])
    with sync_playwright() as playwright:
        browser = playwright.chromium.connect_over_cdp(data['data']['ws']['puppeteer'])
        defaultContext = browser.contexts[0]
        page = defaultContext.pages[0]
        page.goto("https://www.browserscan.net")
        print(page.title())
        page.wait_for_timeout(10000)
        browser.close()
```

--------------------------------

### Check Browser Status V2 Response Examples

Source: https://localapi-doc-en.adspower.com/docs/Check-Browser-Status-V2

Examples of successful and failed responses from the browser status check API.

```json
//Operation succeeded
{
  "code":0,
  "msg":"success",
  "data":{
    "status": "Active",   // profile has been opend "Active" ，if not "Inactive"
    "ws":{
      "selenium":"127.0.0.1:xxxx",    //Browser debug interface，can be used for selenium automation
      "puppeteer":"ws://127.0.0.1:xxxx/devtools/browser/xxxxxx"   //Browser debug interface，can be used for puppeteer automation
    },
"debug_port":"xxxxx", 
"webdriver":"xxxxxxx" 
  }
}

//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### Start and Automate Browser Profile with Javascript Puppeteer

Source: https://localapi-doc-en.adspower.com/docs/K4IsTq

Uses axios to trigger the browser start via the Local API and Puppeteer to connect and perform automation tasks.

```javascript

const axios = require('axios');
const puppeteer = require('puppeteer-core');
const apiKey = 'your_api_key_here'; // 定义 API Key 作为 token
axios.get('http://local.adspower.net:50325/api/v1/browser/start?user_id=XXX', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
}).then(async (res) => {
  console.log(res.data);
  if(res.data.code === 0 && res.data.data.ws && res.data.data.ws.puppeteer) {
    try{
      const browser = await puppeteer.connect(
        {browserWSEndpoint: res.data.data.ws.puppeteer, defaultViewport:null});
        const page = await browser.newPage();
        await page.goto('https://www.adspower.io');
        await page.screenshot({ path: './adspower.png' });
        await browser.close();
    } catch(err){
        console.log(err.message);
    }
  }
}).catch((err) => {
    console.log(err)
})
```

--------------------------------

### Delete Cache V2 Response Examples

Source: https://localapi-doc-en.adspower.com/docs/Delete-Cache-V2

Examples of successful and failed API responses. The operation fails if any browsers are currently open.

```json
  //Operation succeeded
  {
  "code":0,
  "msg":"success"
  }

  //If the current user has an open browser, the execution will fail
  {
  "code":-1,
  "msg":"There are currently open browsers, please close them before deleting the cache"
  }
```

--------------------------------

### Open Browser API return data example

Source: https://localapi-doc-en.adspower.com/docs/FFMFMf

Example JSON response from the Open Browser API. On success, the data object contains ws.selenium and ws.puppeteer debug interfaces, debug_port, and webdriver path. On failure, code is -1 with an empty data object.

```json
//Operation succeeded
{
  "code":0,
  "data":{
    "ws":{
      "selenium":"127.0.0.1:xxxx",    //Browser debug interface, used for selenium automation
      "puppeteer":"ws://127.0.0.1:xxxx/devtools/browser/xxxxxx"  //Browser debug interface, used for puppeteer automation
    },
    "debug_port": "xxxx", //debug port
    "webdriver": "C:\\xxxx\\chromedriver.exe" //webdriver path
  },
  "msg":"success"
}

//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### Browser Status Response Examples

Source: https://localapi-doc-en.adspower.com/docs/Check-Browser-Status-crossdevices

JSON response structures for different scenarios: profile opened, profile not opened, and operation failure.

```json
// Operation succeeded, the profile is opened. 
{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "user_id": "xxx", //profile id
            "account": "user_xxx" //account of the user who opened the profile
        },
        {
            "user_id": "xxx", //profile id
            "account": "user_xxx" //account of the user who opened the profile
        }
    ]
}
```

```json
// Operation succeeded, the profile is not opened. 
{
    "code": 0,
    "msg": "success",
    "data": []
}
```

```json
// Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### GET /api/v2/browser-profile/active

Source: https://localapi-doc-en.adspower.com/docs/Check-Browser-Status-V2

Checks the startup status of a browser profile. Requires either profile_id or profile_no. Returns status and debugging connection details.

```APIDOC
## GET /api/v2/browser-profile/active

### Description
Checks the startup status of a browser profile. Requires either profile_id or profile_no.

### Method
GET

### Endpoint
/api/v2/browser-profile/active

### Parameters
#### Query Parameters
- **profile_id** (text) - Optional - Unique profile ID, generated after creating the profile. One of profile_id or profile_no must be provided.
- **profile_no** (text) - Optional - Check by profile No. Priority will be given to profile id when profile id has been passed. One of profile_id or profile_no must be provided.

### Response
#### Success Response (200)
- **code** (number) - 0 for success
- **msg** (string) - "success"
- **data** (object) - Contains status and debugging info
  - **status** (string) - "Active" if profile is opened, otherwise "Inactive"
  - **ws** (object) - WebSocket debugging endpoints
    - **selenium** (string) - Browser debug interface for Selenium automation
    - **puppeteer** (string) - Browser debug interface for Puppeteer automation
  - **debug_port** (string) - Debug port
  - **webdriver** (string) - Webdriver information

#### Response Example
{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "Active",
    "ws": {
      "selenium": "127.0.0.1:xxxx",
      "puppeteer": "ws://127.0.0.1:xxxx/devtools/browser/xxxxxx"
    },
    "debug_port": "xxxxx",
    "webdriver": "xxxxxxx"
  }
}

#### Error Response
- **code** (number) - -1 for failure
- **msg** (string) - "failed"
- **data** (object) - Empty object

#### Error Response Example
{
  "code": -1,
  "data": {},
  "msg": "failed"
}
```

--------------------------------

### API Response Formats

Source: https://localapi-doc-en.adspower.com/docs/Update-Profile-Info-V2

Examples of JSON responses for successful and failed operations.

```json
//Operation succeeded
{
  "code": 0,
  "data": {
  }      
  "msg": "Success"
}
        
//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### Fingerprint Configuration JSON Object

Source: https://localapi-doc-en.adspower.com/docs/Awy6Dg

Example of the required JSON object for fingerprint_config. Note that an empty object {} is not permitted.

```json
{
"automatic_timezone": "1",
"language": ["en-US","en","zh-CN","zh"],
"ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141",
"flash": "block",
"webrtc": "disabled"
}
```

--------------------------------

### Create Browser Profile Response

Source: https://localapi-doc-en.adspower.com/docs/New-Profile-V2

Example response for successful and failed profile creation. On success, returns profile_id and profile_no. On failure, returns code -1 and a failure message.

```json
//Operation succeeded
{
    "data": {
        "profile_id": "xxxx", // Profile ID
        "profile_no": "xxxx" // Profile No.
    },
    "code": 0,
    "msg": "Success"
}
        
//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### POST /api/v1/user/create

Source: https://localapi-doc-en.adspower.com/docs/XDhI2D

Creates a browser profile with account and password, cookie, proxy, and fingerprint settings. Returns the profile ID upon successful creation.

```APIDOC
## POST /api/v1/user/create

### Description
Create browser profiles, configuring account and password on platforms, cookie, proxy ID, proxy information, fingerprints and so on. Upon successful creation of a browser profile, profile ID will be returned.

### Method
POST

### Endpoint
/api/v1/user/create

### Parameters
#### Body Parameters (JSON)
- **name** (text) - Optional - The name of the account, no more than 100 characters.
- **domain_name** (text) - Optional - Domain name of user's account platform, such as facebook.com, amazon.com... Will open when clicking Open.
- **open_urls** (list) - Optional - Other urls when opening browser. If leaving it empty, will open the domain name url.
- **repeat_config** (list) - Optional - Account deduplication. Default setting: Allow duplication. 0: Allow duplication; 2: Deduplication based on the account name/password; 3: Deduplication based on cookie; 4: Deduplication based on c_user (c_user is a specific tag for Facebook).
- **username** (text) - Optional - Fill in at least one of the following: username/password or cookie information. If username/password duplication is allowed, leave here empty.
- **password** (text) - Optional - Fill in at least one of the following: username/password or cookie information. If username/password duplication is allowed, leave here empty.
- **fakey** (text) - Optional - Enter the 2FA-key. This applies to online 2FA code generator, which works similarly to authenticators.
- **cookie** (text) - Optional - Fill in at least one of the following: username/password or cookie information. If username/password repeat is allowed, leave here empty. Format: JSON.
- **ignore_cookie_error** (text) - Optional - 0: When the cookie verification fails, the cookie format is incorrectly returned directly; 1: When the cookie verification fails, filter out the data in the wrong format and keep the cookie in the correct format. Only supports netspace. Should upgrade to V2.4.6.6 or above.
- **group_id** (text) - Required - Add to corresponding group. 0: Ungrouped.
- **ip** (text) - Optional - Proxy IP used for an account to log in. Fill in when proxy software is lumauto or oxylabs.
- **country** (text) - Optional - Country or region your lumauto and oxylabs account belongs to. Without lumauto and oxylabs IP please enter country.
- **region** (text) - Optional - State or province where account logged in, optional.
- **city** (text) - Optional - City where account logged in, optional.
- **remark** (text) - Optional - Remarks to describe accounts.
- **ipchecker** (text) - Optional - IP query channel, support to determine ip2location, ipapi. Should upgrade to V2.6.3.8 or above.
- **sys_app_cate_id** (text) - Optional - Passable application category ID, 0 for follow team application. Need to upgrade to version V2.6.6.5 and above.
- **user_proxy_config** (userProxyConfig) - Either one of the two fields, proxyid, is required. - Account proxy configuration, for details please see parameter object userPorxyConfig.
- **proxyid** (text) - Either user_proxy_config or user_proxy_config is required. - Can be passed proxy id or random (randomize a proxy).
- **fingerprint_config** (fingerprintConfig) - Required - Account fingerprint configuration, for details please see parameter object fingerprintConfig.

### Request Example
{
  "name": "user A",
  "domain_name": "facebook.com",
  "open_urls": ["http://www.baidu.com","https://www.google.com"],
  "repeat_config": [2,3],
  "username": "myusername",
  "password": "123456",
  "fakey": "xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx",
  "cookie": "[ { \"domain\": \".baidu.com\", \"expirationDate\": 1724188800, \"name\": \"BAIDUID\", \"path\": \"/\", \"sameSite\": \"unspecified\", \"secure\": true, \"value\": \"xxxxxxxxxx\", \"id\": 1 } ]",
  "ignore_cookie_error": 1,
  "group_id": "100",
  "ip": "xxx.xxx.xxx.xxx",
  "country": "us",
  "region": "xx",
  "city": "xx",
  "remark": "This is remark.",
  "ipchecker": "ip2location",
  "sys_app_cate_id": 82,
  "user_proxy_config": {"proxy_type":"http","proxy_host":"123.0.0.1","proxy_port":"12","proxy_user":"12","proxy_password":"12","proxy_soft":"luminati"},
  "proxyid": "xxx",
  "fingerprint_config": {"automatic_timezone": "1","language": ["en-US","en"],"flash": "block","fonts": ["all"],"webrtc": "disabled","ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36"}
}

### Response
#### Success Response (200)
- **code** (int) - 0 indicates success.
- **data** (object) - Contains the profile ID.
  - **id** (string) - Unique ID after importing account.
- **msg** (string) - Success message.

#### Response Example
{
  "code": 0,
  "data": {
    "id":"xxxxxxx"
  },
  "msg": "Success"
}

#### Error Response
- **code** (int) - Non-zero indicates failure.
- **data** (object) - Empty object.
- **msg** (string) - Error message.

#### Error Response Example
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### GET /api/v2/category/list

Source: https://localapi-doc-en.adspower.com/docs/Check-Category-List-V2

Query the list of extension categories. You can get the category ID or the specific category details.

```APIDOC
## GET /api/v2/category/list

### Description
Query the list of extension categories. You can get the category ID or the specific category details.

### Method
GET

### Endpoint
/api/v2/category/list

### Parameters
#### Query Parameters
- **category_id** (text) - Optional - Extension category_id
- **page** (text) - Optional - Page number, default 1, to view the data of which pages.
- **limit** (text) - Optional - Default 1, how many values are returned per page, range 1 to 100.

### Response
#### Success Response (200)
- **data.list** (array) - List of categories
  - **category_id** (string) - Extension category id
  - **category_name** (string) - Category name
  - **remark** (string) - Category remark
- **data.page** (integer) - Current page number
- **data.page_size** (integer) - Number of items per page
- **code** (integer) - Response code, 0 for success
- **msg** (string) - Response message

#### Response Example
{
    "data": {
        "list": [
            {
                "category_id": "XXX",
                "category_name": "XXX",
                "remark": "XXX"
            }
        ],
        "page": 1,
        "page_size": 10
    },
    "code": 0,
    "msg": "Success"
}

#### Error Response
- **code** (integer) - Error code, -1 for failure
- **data** (object) - Empty object
- **msg** (string) - Error message

#### Error Response Example
{
    "code": -1,
    "data": {},
    "msg": "failed"
}
```

--------------------------------

### POST /api/v1/browser/cloud-active

Source: https://localapi-doc-en.adspower.com/docs/Check-Browser-Status-crossdevices

Checks the startup status of browser profiles. Specify profile IDs to query, supports cross-device queries. Up to 100 profiles can be checked in a single request.

```APIDOC
## POST /api/v1/browser/cloud-active

### Description
Checks the startup status of the browser. You need to specify the profile ID. Supports cross-device queries. Up to 100 profiles can be checked in a single query. If "Multi Device mode" is on, the specific status cannot be checked. The return content is the same as 'The profile is not opened'.

### Method
POST

### Endpoint
/api/v1/browser/cloud-active

### Parameters
#### Request Body
- **user_ids** (text) - Required - Unique profile ID, generated after creating the profile.

### Request Example
```
POST /api/v1/browser/cloud-active
{
  "user_ids": "xxx"
}
```

### Response
#### Success Response (200)
- **code** (number) - 0 for success.
- **msg** (string) - "success" on success.
- **data** (array) - List of opened profiles. Each item contains:
  - **user_id** (string) - Profile ID.
  - **account** (string) - Account of the user who opened the profile.

#### Response Example
```
// Operation succeeded, the profile is opened.
{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "user_id": "xxx", //profile id
            "account": "user_xxx" //account of the user who opened the profile
        },
        {
            "user_id": "xxx", //profile id
            "account": "user_xxx" //account of the user who opened the profile
        }
    ]
}

// Operation succeeded, the profile is not opened.
{
    "code": 0,
    "msg": "success",
    "data": []
}

// Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```
```

--------------------------------

### GET /api/v1/application/list

Source: https://localapi-doc-en.adspower.com/docs/EAGz8D

Query the list of application categories. You can get the application category ID to create profiles and edit profile information.

```APIDOC
## GET /api/v1/application/list

### Description
Query the list of application categories. You can get the application category ID to create profiles and edit profile information.

### Method
GET

### Endpoint
/api/v1/application/list

### Parameters
#### Query Parameters
- **page** (text) - Optional - Page default 1 first page. Example: 1
- **page_size** (text) - Optional - Default 1 per page. Example: 10

### Response
#### Success Response (200)
- **data.list** (array) - List of application categories
  - **id** (string) - Application Category ID
  - **name** (string) - Application Category Name
  - **remark** (string) - Application Category Remarks
- **data.page** (integer) - Current page number
- **data.page_size** (integer) - Number of items per page
- **code** (integer) - Response code, 0 for success
- **msg** (string) - Response message

#### Response Example
{
  "data": {
    "list": [
      {
        "id": "XXX",
        "name": "XXX",
        "remark": "XXX"
      }
    ],
    "page": 1,
    "page_size": 10
  },
  "code": 0,
  "msg": "Success"
}

#### Error Response
{
  "code": -1,
  "data": {},
  "msg": "failed"
}
```

--------------------------------

### POST /api/v2/browser-profile/create

Source: https://localapi-doc-en.adspower.com/docs/New-Profile-V2

Creates a new browser profile with specified account, proxy, and fingerprint settings. Returns the profile ID and profile number upon success.

```APIDOC
## POST /api/v2/browser-profile/create

### Description
Create browser profiles, configuring account and password on platforms, cookie, proxy ID, proxy information, fingerprints and so on. Upon successful creation of a browser profile, profile ID will be returned.

### Method
POST

### Endpoint
/api/v2/browser-profile/create

### Parameters
#### Body Parameters (JSON)
- **name** (text) - Optional - The name of the account, no more than 100 characters. Example: "user A"
- **group_id** (text) - Required - Add to corresponding group. 0: Ungrouped. Example: "100"
- **remark** (text) - Optional - Remarks to describe accounts.
- **platform** (text) - Optional - Platform name, e.g., "facebook.com".
- **username** (text) - Optional - Platform account username. Fill in at least one of the following: username/password or cookie information. It's not necessary to fill in if duplication is allowed. Example: "myusername"
- **password** (text) - Optional - Platform account password. Fill in at least one of the following: username/password or cookie information. It's not necessary to fill in if duplication is allowed. Example: "123456"
- **fakey** (text) - Optional - Enter the 2FA-key. This applies to online 2FA code generator, which works similarly to Google Authenticators. Example: "xxxx xxxx xxxx xxxx xxxx"
- **cookie** (text) - Optional - Fill in at least one of the following: username/password or cookie information. It's not necessary to fill in if duplication is allowed. Format: JSON, Netscape. Example: [ { "domain": ".baidu.com", "expirationDate": 1724188800, "name": "BAIDUID", "path": "/", "sameSite": "unspecified", "secure": true, "value": "xxxxxxxxxx", "id": 1 } ]
- **repeat_config** (list) - Optional - Account deduplication. Default setting: Allow duplication. 0: Allow duplication; 2: Deduplication based on the account name/password; 3: Deduplication based on cookie; 4: Deduplication based on c_user (c_user is a specific tag for Facebook). Example: [2,3]
- **ignore_cookie_error** (text) - Optional - Handling of Cookie Verification Failures. 0: Return an error directly; 1: Filter out the data in the wrong format and keep the cookie in the correct format. Only supports Netscape format. Default: 0. Example: "1"
- **tabs** (list) - Optional - The URL address that the profile accesses on startup; If left blank, only the URL specified in the platform will be opened by default. Example: ["http://www.baidu.com","https://www.google.com"]
- **user_proxy_config** (object) - Optional - Proxy configuration, refer to userProxyConfig. Either user_proxy_config or proxyid is required. Example: {"proxy_type":"http","proxy_host":"123.0.0.1","proxy_port":"12","proxy_user":"12","proxy_password":"12","proxy_soft":"luminati"}
- **proxyid** (text) - Optional - Proxy ID or enter "random" to choose a saved proxy randomly. Either user_proxy_config or proxyid is required. Example: "XXX"
- **ip** (text) - Optional - Proxy IP used for an account to log in. Fill in when proxy software is lumauto or oxylabs. Example: "xxx.xxx.xxx.xxx"
- **country** (text) - Optional - Country or region your proxy belongs to. For lumauto and oxylabs IP please enter country if there is no IP. Example: "us"
- **region** (text) - Optional - State or province where the proxy belongs. Example: "xx"
- **city** (text) - Optional - City where proxy belongs to. Example: "xx"
- **ipchecker** (text) - Optional - IP query channel, support to determine ip2location, ipapi. Example: "ip2location"
- **sys_app_cate_id** (text) - Optional - Passable application category ID, 0 for follow team application. Default: 0. Example: "82"
- **fingerprint_config** (Object) - Required - Account fingerprint configuration, for details please see fingerprint_config. Example: {"automatic_timezone": "1","language": ["en-US","en"],"flash": "block","fonts": ["all"],"webrtc": "disabled","ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36"}

### Request Example
{
  "name": "user A",
  "group_id": "100",
  "remark": "",
  "platform": "facebook.com",
  "username": "myusername",
  "password": "123456",
  "fakey": "xxxx xxxx xxxx xxxx xxxx",
  "cookie": [ { "domain": ".baidu.com", "expirationDate": 1724188800, "name": "BAIDUID", "path": "/", "sameSite": "unspecified", "secure": true, "value": "xxxxxxxxxx", "id": 1 } ],
  "repeat_config": [2,3],
  "ignore_cookie_error": "1",
  "tabs": ["http://www.baidu.com","https://www.google.com"],
  "user_proxy_config": {"proxy_type":"http","proxy_host":"123.0.0.1","proxy_port":"12","proxy_user":"12","proxy_password":"12","proxy_soft":"luminati"},
  "proxyid": "XXX",
  "ip": "xxx.xxx.xxx.xxx",
  "country": "us",
  "region": "xx",
  "city": "xx",
  "ipchecker": "ip2location",
  "sys_app_cate_id": "82",
  "fingerprint_config": {"automatic_timezone": "1","language": ["en-US","en"],"flash": "block","fonts": ["all"],"webrtc": "disabled","ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36"}
}

### Response
#### Success Response (200)
- **data** (object) - Contains profile_id and profile_no.
  - **profile_id** (string) - Profile ID.
  - **profile_no** (string) - Profile No.
- **code** (integer) - 0 for success.
- **msg** (string) - "Success".

#### Response Example
{
  "data": {
    "profile_id": "xxxx",
    "profile_no": "xxxx"
  },
  "code": 0,
  "msg": "Success"
}

#### Error Response
- **code** (integer) - -1 for failure.
- **data** (object) - Empty object.
- **msg** (string) - "failed".

#### Error Response Example
{
  "code": -1,
  "data": {},
  "msg": "failed"
}
```

--------------------------------

### POST /api/v2/browser-profile/start

Source: https://localapi-doc-en.adspower.com/docs/Open-Browser-V2

Opens a browser profile and returns the debug interface for Selenium and Puppeteer automation. Requires a profile ID and returns WebSocket endpoints, debug port, and webdriver path.

```APIDOC
## POST /api/v2/browser-profile/start

### Description
To open a browser, you need to specify the profile ID. After a successful launch, you can obtain the browser's debug interface for executing Selenium and Puppeteer automation. Selenium requires the use of a Webdriver that matches the corresponding browser's core version. Ensure that your application is updated to version 3.4.1 or higher. After launching the browser, you can retrieve the path to the corresponding Webdriver from the return value.

### Method
POST

### Endpoint
/api/v2/browser-profile/start

### Parameters
#### Body Parameters (JSON)
- **profile_id** (text) - Required - Unique profile ID, generated after creating profile. Example: h1yynkm
- **profile_no** (text) - Optional - Priority will be given to profile id when profile id is filled. Example: 123
- **launch_args** (list) - Optional - Browser startup parameters. If launch_args are set both for API and the profile, priority will be given to the ones in API settings. Example: ["--window-position=400,0","--blink-settings=imagesEnabled=false", "--disable-notifications"]
- **headless** (text) - Optional - Whether to open in headless mode, 1: Yes; 0: No(default). Default: 0
- **last_opened_tabs** (text) - Optional - Whether to continue browsing the last opened page: 1: Yes(default), 0: No. Default: 1
- **proxy_detection** (text) - Optional - Whether to open the proxy detection page, 1: Yes(default);0: No. Default: 1
- **password_filling** (text) - Optional - Whether to activate the password filling function. 1: Yes; 0: No(default). Effective only when the profile is opened for the first time. Default: 0
- **password_saving** (text) - Optional - Whether to save the password. 1: Yes; 0: No(default). Only effective on Chrome kernel. Default: 0
- **cdp_mask** (text) - Optional - Whether to mask the cdp detection. 1: Yes (default), 0: No. iOS and Android OS profiles are forced to enable this feature. Default: 1
- **delete_cache** (text) - Optional - Whether to clear the cache after closing the profile. 1: Yes; 0:NO (Default). It is recommended to set this parameter to 1 if there is insufficient disk space. Default: 0
- **device_scale** (text) - Optional - Set the zoom ratio of mobile OS profile. Range 0.1 to 2, 1 is 100%. Only valid for mobile OS and 128 kernel and plus. Example: 1

### Request Example
{
  "profile_id": "h1yynkm",
  "launch_args": ["--window-position=400,0","--blink-settings=imagesEnabled=false", "--disable-notifications"],
  "headless": 0,
  "last_opened_tabs": 1,
  "proxy_detection": 1,
  "password_filling": 0,
  "password_saving": 0,
  "cdp_mask": 1,
  "delete_cache": 0,
  "device_scale": 1
}

### Response
#### Success Response (200)
- **code** (number) - Operation result code, 0 for success.
- **data** (object) - Contains the following fields:
  - **ws** (object) - Browser debug interfaces:
    - **selenium** (string) - Browser debug interface, used for selenium automation. Example: 127.0.0.1:xxxx
    - **puppeteer** (string) - Browser debug interface, used for puppeteer automation. Example: ws://127.0.0.1:xxxx/devtools/browser/xxxxxx
  - **debug_port** (string) - Debug port. Example: xxxx
  - **webdriver** (string) - Webdriver path. Example: C:\\xxxx\\chromedriver.exe
- **msg** (string) - Message, "success" on success.

#### Response Example
//Operation succeeded
{
  "code":0,
  "data":{
    "ws":{
      "selenium":"127.0.0.1:xxxx",
      "puppeteer":"ws://127.0.0.1:xxxx/devtools/browser/xxxxxx"
    },
    "debug_port": "xxxx",
    "webdriver": "C:\\xxxx\\chromedriver.exe"
  },
  "msg":"success"
}

//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```

--------------------------------

### GET /api/v1/browser/start

Source: https://localapi-doc-en.adspower.com/docs/FFMFMf

Opens a browser for a specified profile ID. Returns the browser debug interface for Selenium and Puppeteer automation, along with the debug port and webdriver path.

```APIDOC
## GET /api/v1/browser/start

### Description
To open a browser, you need to specify the profile ID. After a successful launch, you can obtain the browser's debug interface for executing Selenium and Puppeteer automation. Selenium requires the use of a Webdriver that matches the corresponding browser's core version. Ensure that your application is updated to version 3.4.1 or higher. After launching the browser, you can retrieve the path to the corresponding Webdriver from the return value.

### Method
GET

### Endpoint
/api/v1/browser/start

### Parameters
#### Query Parameters
- **user_id** (string) - Required - Unique profile ID, generated after creating profile. Example: h1yynkm
- **serial_number** (string) - Optional - Priority will be given to user id when user id is filled. Example: 123
- **open_tabs** (integer) - Optional - Open a platform or historical page. 0: Open (Default setting); 1: Close. Default: 0. Example: 1. Should update to V2.4.2.9 or above.
- **ip_tab** (integer) - Optional - Whether to open the ip detection page, 0: not open, 1: open (default). Default: 1. Example: 0. Should update to V2.5.7.9 or above.
- **new_first_tab** (integer) - Optional - Whether to use the new version of the ip detection page: 1: new version, 0: old version (default). Default: 0. Example: 1. Should update to V2.6.6.9 or above.
- **launch_args** (array) - Optional - Browser startup parameters. eg: --blink-settings=imagesEnabled=false: Prohibit image loading. --disable-notifications: Disable notifications. Example: ["--window-position=400,0","--blink-settings=imagesEnabled=false", "--disable-notifications"]. If launch_args are set both for API and the profile, priority will be given to the ones in API settings. Should update to V2.4.6.7 or above.
- **headless** (integer) - Optional - Whether to start the headless browser 0:NO (Default) 1:YES. Default: 0. Example: 1. Should update to V2.4.6.7 or above.
- **disable_password_filling** (integer) - Optional - Whether to disable the function of filling password 0:NO (Default) 1:YES. Default: 0. Example: 1. Should update to V2.4.6.7 or above.
- **clear_cache_after_closing** (integer) - Optional - Whether to delete the cache after closing the browser 0:NO (Default) 1:YES. Default: 0. Example: 1. Should update to V2.4.7.6 or above. If the disk space is insufficient, it is recommended to set this parameter to 1.
- **enable_password_saving** (integer) - Optional - Whether to allow password saving 0:NO (Default) 1:YES. Default: 0. Example: 1. Should update to V2.4.8.7 or above.
- **cdp_mask** (integer) - Optional - Whether to mask the cdp detection. 1: Yes (default), 0: No. Default: 1. Example: 1.
- **device_scale** (number) - Optional - Only valid for mobile OS. Range 0.1 to 2, 1 is 100%. Example: 1.

### Response
#### Success Response (200)
- **code** (integer) - Operation result code. 0 indicates success.
- **data** (object) - Contains the browser debug interfaces and webdriver path.
  - **ws** (object) - Browser debug interfaces.
    - **selenium** (string) - Browser debug interface, used for selenium automation. Example: 127.0.0.1:xxxx
    - **puppeteer** (string) - Browser debug interface, used for puppeteer automation. Example: ws://127.0.0.1:xxxx/devtools/browser/xxxxxx
  - **debug_port** (string) - Debug port. Example: xxxx
  - **webdriver** (string) - Webdriver path. Example: C:\\xxxx\\chromedriver.exe
- **msg** (string) - Message. Example: success

#### Response Example
{
  "code": 0,
  "data": {
    "ws": {
      "selenium": "127.0.0.1:xxxx",
      "puppeteer": "ws://127.0.0.1:xxxx/devtools/browser/xxxxxx"
    },
    "debug_port": "xxxx",
    "webdriver": "C:\\xxxx\\chromedriver.exe"
  },
  "msg": "success"
}

#### Error Response
- **code** (integer) - Error code. -1 indicates failure.
- **data** (object) - Empty object.
- **msg** (string) - Error message. Example: failed

#### Error Response Example
{
  "code": -1,
  "data": {},
  "msg": "failed"
}
```

--------------------------------

### GET /api/v2/category/list endpoint

Source: https://localapi-doc-en.adspower.com/docs/Check-Category-List-V2

The base endpoint for querying the list of extension categories.

```http
GET  /api/v2/category/list
```

--------------------------------

### Delete Profile V2 Response Data

Source: https://localapi-doc-en.adspower.com/docs/Delete-Profile-V2

Examples of successful and failed operation responses.

```json
//Operation succeeded
{
  "code":0,
  "data":{},
  "msg":"success"
}

//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}
```
Tokens:
Raw