Local API

1. Introduction

Local API allows users to read and write configuration information, start and close the browser, search for account and so on. For details, please see http://apidoc.adspower.net/localapi/local-api-v1-en.html.

2. How to Use AdsPower Local API

2.1 Get access to AdsPower Local API

2.2 Start AdsPower and log in

2.3 Go to Account Management-> Settings to see API status

2.4 AdsPower Local API list

3. How to Use API-key and Headless

3.1 AdsPower allows to start headless mode with headless and API-key

Note: Before starting make sure that the AdsPower version is v 3.3.2 or above, kernel version is v 2.4.2.8 or above and you have the access to Local API.

  • headless: A parameter to start headless mode
  • API-key: Credential to use Local API in headless service and allow to control Local API on multiple devices with one account at the same time. One account with a unique API-key,

3.2 Account management-> Obtain the API-key in settings

3.3 Use command in command lines and API-key to start headless mode

3.3.1 Make sure that you opened CMD or Terminal in your AdsPower main content

Note: On Windows devices the path usually is “C:\Program Files (x86)\AdsPower”

3.3.2 Start command lines

For headless mode the following parameters can be passed in:

ParameterNecessary or notRemarks
–headlessYESValue=true, means in headless mode
–api-keyYESCredential to use Local API in headless mode
–api-portNODesignated API-port for Local API
Windows devices: AdsPower.exe --headless=true --api-key=XXXX  --api-port=50325
MacOS devices: /Applications/adsPower.app/Contents/MacOS/Adspower --args --headless=true --api-key=XXXX  --api-port=50325

After starting users can see returned Local API address in command lines

FAQ: 

Q: Is it possible to start GUI mode and headless mode on the same device at the same time?

A: No.

Q: If API-key changes, does the API, called by the old value, still work?

A: No. Message that the API-key is invalid will be returned. One account only matches one unique API-Key. After resetting API-key, the old value becomes invalid, please keep it well.

Q: How to reset API-key?

A: Account Management-> Setting-> Local API-> Reset API-key. After resetting please keep it well.

Q: If API-key changed, can users update API-key for those underway services?

A: No. Users should close services first and use the new API-key to start services.

Q: How to close the service?

A: Users can close the service by clicking Ctrl+c (under CMD) or closing a command window

Q: What is the difference while starting Local API in headless mode and GUI mode?

A: 1. In GUI mode one account can only log in on one device.

2. Using API-key one account can log in on many devices at the same time. If users want to execute automation on many devices with one account, they can use Local API with the help of headless and API-key.