localAPI

AdsPower supports Local API, which has functions like reading and writing account configuration information, opening and closing browsers, searching for accounts. Besides, it can cooperate with Selenium and Puppeteer to execute browser operations automatically.

How to Use AdsPower Local API

• Users of AdsPower team collaboration version have access to API
• Start AdsPower, log in the account with API permission
• Go to Account Management-> Setting-> Local API to check the following items
  • API status: Success
  • API address: http://local.adspower.net:50325/ or http://localhost:50325/ (port: 50325, which might change and subjects to the address in the setting).
  • Script can go to Profile Management-> click Settings-> click Cache folder-> local_api file to obtain API address
• Use script or http request tool to invoke Local API, allow to configure account data, browser fingerprint, open or close browser and other operations
• API parameter type: string, Post format: JSON, unnecessary parameters are optional and can not be passed
• Access frequency control for all APIs, max. access frequency: 1 request/second
• Max. times to import account one day: browser environments quantity of your package * 10
• Max. times to open browser one day: browser environments quantity of your package * 10
• At the same time, it supports the mode of no-interface api-key to start the Local API service. For details, see: Help center

What the Local API supports

• API Status
• Browser Operation
  • Open Browser
  • Close Browser
  • Check Open Status
• Group Management
  • Create Group
  • Update Group(coming soon)
  • Query Group
• Profile Management
  • Create Profile
  • Update Profile
  • Query Profile
  • Delete Profile
  • Update Profile Group
  • Delete Profile Cache

API Status

  Basic Information

    Path: /status

    Method: GET

    Description: Used to check the usability of the API

  Returning Data

{
  "code":0,
  "msg":"success"
}

Browser Operation

Open Browser

  Basic Information

    Path: /api/v1/browser/start

    Method: GET

    Description: Used to open browsers and account ID designation is required. After opening users can execute selenium and puppeteer automation operations, using browser debug API. Currently AdsPower is based on Chromium 88. Users should update AdsPower version to v 3.4.1 or above. Besides, selenium should cooperate with specific Webdriver, after starting AdsPower users will receive a return value and then get access to Webdriver using the value.

  Request Parameters

  Query: Nonessential parameter and you may pass it or not

  Returning Data

//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"
}  

Close Browser

  Basic Information

    Path: /api/v1/browser/stop

    Method: GET

    Description: Used to close browsers and account ID designation is required.

  Request Parameters

  Query: Nonessential parameter and you may pass it or not

  Returning Data

{
  "code":0,
  "msg":"success"
}

Check Open Status

  Basic Information

    Path: /api/v1/browser/active

    Method: GET

    Description: Used to check browser open status and account ID designation is required

  Request Parameters

  Query: Nonessential parameter and you may pass it or not

  Returning Data

//Operation succeeded
{
  "code":0,
  "data":{
    "status": "active",    //Open in browser: “active”, Close in browser: “inactive”
    "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
    }
  },
  "msg":"success"
}

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

Group Management

Create Group

  Basic Information

    Path: /api/v1/group/create

    Method: POST

    Description: Used to add group and divide accounts imported into several groups. Group name should be unique. After creating a group there will be a group ID. Group ID 0 is the default setting of system.

  Request Parameters

  Body: Nonessential parameter and you may pass it or not, format of parameter to be passed: JSON

  Returning Data

//Operation succeeded
{
  "code": 0,
  "data": {
    "group_id":"xxxxxxx"  //Group ID after adding group
    "group_name":"group1" //Group name
  }      
  "msg": "Success"
}
        
//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

Update Group(coming soon)

• Coming Soon

Query Group

  Basic Information

    Path: /api/v1/group/list

    Method: GET

    Description: Used to search group information. Group information includes group ID, group name. Group ID 0 is set by default.

  Request Parameters

  Query: Nonessential parameter and you may pass it or not

  Returning Data

//Operation succeeded
{
  "code": 0,
  "data": {
    "list": [
      {
        "group_id": "100",     //Group ID, used to add account
        "group_name": "group1"  //Group name
      },
      {
        "group_id": "101",
        "group_name": "group2"
      }
    ],
    "page": 1,
    "page_size": 10
  },
  "msg": "Success"
}

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

Profile Management

Create Profile

  Basic Information

    Path: /api/v1/user/create

    Method: POST

    Description: Create account, which allows to configure platform account name and password, cookie, proxy, fingerprint and so on. After importing there will be an account ID

  Request Parameters

  Body: Nonessential parameter and you may pass it or not, format of parameter to be passed: JSON

  Returning Data

//Operation succeeded
{
  "code": 0,
  "data": {
    "id":"xxxxxxx"  //Unique ID(user_id) after importing account
  }      
  "msg": "Success"
}
        
//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

Update Profile

  Basic Information

    Path: /api/v1/user/update

    Method: POST

    Description: Edit account to update account username/password, cookie, proxy, fingerprint and so on

  Request Parameters

  Body: Nonessential parameter and you may pass it or not, format of parameter to be passed: JSON

  Returning Data

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

Query Profile

  Basic Information

    Path: /api/v1/user/list

    Method: GET

    Description: View imported account information

  Request Parameters

  Query: Nonessential parameter and you may pass it or not

  Returning Data

//Operation succeeded
{
  "code": 0,
  "data": {
    "list": [
    {
      "serial_number": "1",
      "user_id": "XXX",
      "name": "XXX",
      "group_id": "1",
      "group_name": "XX",
      "domain_name": "facebook.com",
      "username": "username",
      "remark": "remark",
      "created_time": "1612520997", // Timestamp
      "ip": "13.251.172.174",
      "ip_country": "sg",
      "password": "",
      "last_open_time": "1621333030" // Last opened time (Timestamp)
    }],
    "page": 1,
    "page_size": 50
  },
  "msg": "Success"
}
        
//Operation failed
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

Delete Profile

  Basic Information

    Path: /api/v1/user/delete

    Method: POST

    Description: Delete useless accounts, batch deletion is allowed, max. quantity to delete once: 100

  Request Parameters

  Body: Nonessential parameter and you may pass it or not, format of parameter to be passed: JSON

  Returning Data

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

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

Update Profile Group

  Basic Information

    Path: /api/v1/user/regroup

    Method: POST

    Description: Regroup accounts according to ID

  Request Parameters

  Body: Nonessential parameter and you may pass it or not, format of parameter to be passed: JSON

  Returning Data

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

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

Delete Profile Cache

  Basic Information

    Path: /api/v1/user/delete-cache

    Method: POST

    Description: Used to clear all local caches generated by opening the browser. For account security, please be sure to use this interface when the device is not opening the browser. Need to be updated to V2.4.7.4

  Returning Data

//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"
}

Parameter Object

user_proxy_config

  user_proxy_config: Information about account proxy configuration. AdsPower supports frequently used proxy software and protocol.

For user_proxy_config to pass corresponding JSON object is required, for example,

• 911s5
  {"proxy_soft":"911"}
• luminati
  {"proxy_soft":"luminati","proxy_type":"http","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• luminati https
  {"proxy_soft":"luminati","proxy_type":"https","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• luminati socks5 {"proxy_soft":"luminati","proxy_type":"socks5","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• lumauto
  {"proxy_soft":"lumauto","proxy_type":"http","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**","global_config":"0"}
  Note: global_config is optional
  
  • Custom (Default setting)
  • Use luminati dynamic IP in global settings {"proxy_soft":"lumauto","proxy_type":"http","global_config":"1"}
• oxylabsauto
  {"proxy_soft":"oxylabsauto","proxy_type":"http","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xx","proxy_password":"**","global_config":"0"}
  Note: global_config is optional
  
  • Custom (Default setting)
  • Use oxylabs dynamic IP in global settings {"proxy_soft":"oxylabsauto","proxy_type":"http","global_config":"1"}
• socks5
  {"proxy_soft":"other","proxy_type":"socks5","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• http
  {"proxy_soft":"other","proxy_type":"http","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• https
  {"proxy_soft":"other","proxy_type":"https","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• ssh
  {"proxy_soft":"ssh","proxy_type":"socks5","proxy_host":"xxxx","proxy_port":"xx","proxy_user":"xxx","proxy_password":"**"}
• no_proxy
  {"proxy_soft":"no_proxy"}

fingerprint_config

  fingerprint_config: Information about browser fingerprint configuration. AdsPower allows to configure many kinds of fingerprints.

Note: For fingerprint_config to pass JSON object is required, example:

{
    "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"
}
          

random_ua

ua_system: list, not required. If you don’t fill in, it will be random in all systems by default. Support Android, iOS, Windows, Mac OS X , Linux.
ua_version: list, not required. If not filled, it will be random in all versions by default. Each system supports the following versions
for examples:
Windows: ["95", "94", "93","92", "91", "90", "89", "88", "87", "86", "85", "84", "83", "82", "81", "80", "79", "78", "77"]
Mac OS X: ["89", "87", "86", "85", "84", "83", "81", "80", "79", "78"]
Linux: ["89", "88", "86", "85", "84", "83", "81", "80", "79"]
Android: ["95", "94", "93","92", "91", "90", "80", "79", "78", "77", "76", "75", "74", "73"]
iOS: ["95", "94", "93","92", "91", "90"]