Skip to content
API Reference
/
/Proxy Management

Local API (1.0.0)

The MoreLogin API offers a comprehensive and developer-friendly RESTful interface that empowers you to programmatically manage browser profiles, cloud phones, and related resources—enabling seamless automation, scalability, and control.The MoreLogin local API runs on your machine and is accessible at:127.0.0.1:40000

Download OpenAPI description
local-api.json
local-api.yaml
Languages
Servers
Mock server
https://guide.morelogin.com/_mock/api-reference/local-api/local-api
Morelogin Local endponint
http://127.0.0.1:40000

Browser Profile

Operations

Cloud Phone

Operations

Cloud Phone/File Management

Operations

Cloud Phone/App Management

Operations

Cloud Phone/Schedules management

Operations

Proxy Management

Operations

Getting a list of proxies

Request

Bodyapplication/jsonrequired
pageNointeger

Current page number (starts from 1)

Example: 1
pageSizeinteger

Number of items per page

Example: 10
isCloudPhoneProxyboolean

Whether the proxy is for cloud phone usage.

  • true: Exclude local/private IPs (e.g., 127.0.0.1, 360, pia, private ranges)
  • false: Return all proxies
Example: false
proxyCategoryTypeinteger

Proxy category type:

  • 1 = Cloud platform
  • 2 = Self-owned IP
Example: 2
proxyIpstring

Filter by proxy IP address (partial match)

Example: ""
proxyNamestring

Filter by proxy name (partial match)

Example: ""
proxyProvidersArray of integers

List of proxy provider IDs. Supported values:

  • 0 = HTTP
  • 1 = HTTPS
  • 2 = SOCKS5
  • 3 = SSH
  • 4 = Oxylabs
  • 5 = Proxys.io
  • 6 = GeoSurf
  • 7 = Luminati
  • 8 = Lumauto
  • 9 = Oxylabsauto
  • 10 = Trojan
  • 11 = Shadowsocks
  • 12 = vmess
  • 13 = ABCPROXY
  • 14 = LunaProxy
  • 15 = IPHTML
  • 16 = PiaProxy
  • 17 = 922S5
Example: []
proxyStatusinteger

Proxy assignment status:

  • 0 = Normal
  • 1 = Unassigned
  • 2 = Upgrading
  • 3 = Expired
  • 4 = Expiring soon

Note: Self-owned proxies always use status 1.

Example: 1
proxyCheckStatusinteger

Proxy health check status:

  • 0 = Pending
  • 1 = Success
  • 2 = Failed
  • 3 = Unknown error
Example: 1
proxyTypesArray of integers

Proxy protocol types:

  • 0 = HTTP
  • 1 = HTTPS
  • 2 = SOCKS5
  • 3 = SSH
Example: []
curl -i -X POST \
  https://guide.morelogin.com/_mock/api-reference/local-api/local-api/api/proxyInfo/page \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 1,
    "pageSize": 10,
    "isCloudPhoneProxy": false,
    "proxyCategoryType": 2,
    "proxyIp": "",
    "proxyName": "",
    "proxyProviders": [],
    "proxyStatus": 1,
    "proxyCheckStatus": 1,
    "proxyTypes": []
  }'

Responses

Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstringrequired

Error message

dataobjectrequired
data.​currentintegerrequired
data.​dataListArray of objectsrequired
data.​dataList[].​expiryTimeinteger

Expiration time

data.​dataList[].​idinteger

Primary key

data.​dataList[].​proxyCategoryTypeinteger

Proxy type 1:Platform proxy; 2:Self-owned proxy

data.​dataList[].​proxyCheckStatusinteger

Detection status 0-pending detection 1-monitoring success 2-detection failure 3-unknown error

data.​dataList[].​proxyIpstring

Proxy IP

data.​dataList[].​exportIpstring

export IP

data.​dataList[].​countryCodestring

countryCode

data.​dataList[].​proxyNamestring

Proxy Name

data.​dataList[].​proxyProviderinteger

Proxy Provider:default value 0-HTTP 1-HTTPS 2-SOCKS5 3-SSH 4-Oxylabs 5-Proxys.io 7-Luminati 8-Lumauto 9-Oxylabsauto 10-Trojan，11-Shadowsocks 13-ABCPROXY 14-LunaProxy 15-IPHTML 16-PiaProxy 17-922S5

data.​dataList[].​proxyTypeinteger

Proxy Type:0-http 1-https 2-socks5 3-ssh

data.​dataList[].​usernamestring

Proxy username

data.​dataList[].​passwordstring

Proxy password

data.​dataList[].​refreshUrlstring

Proxy refresh URL

data.​pagesintegerrequired
data.​totalintegerrequired
requestIdstringrequired

Operation Request ID

Response
application/json
{
  "code": 0,
  "msg": "string",
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  },
  "requestId": "string"
}

Adding proxy

Request

Bodyapplication/jsonrequired
citystring

City

Example: ""
countrystring

Country code (ISO 3166-1 alpha-2). Required only if proxyProvider=17.

Example: "AD"
encryptionTypeinteger(int32)

Encryption type, valid values are integers from 1 to 14.

Example: 14
ipChangeActioninteger(int32)

Action on IP change:0 = Block, 1 = Warn

Example: 1
ipMonitorboolean

Enable IP change monitoring

Example: false
passwordstring

Password for proxy authentication

Example: ""
proxyIpstringrequired

Proxy IP address

Example: "8.10.22.46"
proxyNamestring

Proxy name (supports placeholders like {{random}})

Example: "sock5_{{random}}"
proxyPortinteger(int32)required

Proxy port number

Example: 65534
proxyProviderinteger(int32)required

Proxy provider type: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH, 4=Oxylabs, 5=Proxys.io, 6=GeoSurf, 7=Luminati, 8=Lumauto, 9=Oxylabsauto, 10=Trojan, 11=Shadowsocks, 12=vmess, 13=ABCPROXY, 14=LunaProxy, 15=IPHTML, 16=PiaProxy, 17=922S5. Special rules:

  • If proxyProvider is 7 or 8, proxyType is required.
  • If proxyProvider is 17, country is required; state and city are optional.
Example: 2
proxyTypeinteger(int32)

Proxy protocol type: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH. Required only when proxyProvider is 7 or 8.

Example: 1
refreshUrlstring

URL to refresh dynamic proxy IP (if supported)

Example: ""
statestring

State/Province

Example: ""
usernamestring

Username for proxy authentication

Example: ""
curl -i -X POST \
  https://guide.morelogin.com/_mock/api-reference/local-api/local-api/api/proxyInfo/add \
  -H 'Content-Type: application/json' \
  -d '{
    "proxyIp": "8.10.22.46",
    "proxyPort": 65534,
    "proxyProvider": 2,
    "proxyType": 1,
    "country": "AD",
    "state": "",
    "city": "",
    "encryptionType": 14,
    "ipChangeAction": 1,
    "ipMonitor": false,
    "proxyName": "sock5_{{random}}",
    "refreshUrl": "",
    "username": "",
    "password": ""
  }'

Responses

Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstringrequired

Error message

dataintegerrequired

Proxy ID

requestIdstringrequired

Operation Request ID

Response
application/json
{
  "code": 0,
  "msg": "",
  "data": 0,
  "requestId": "abcd1234"
}

Modifying proxy information

Request

Bodyapplication/jsonrequired
idinteger(int64)required

Unique proxy ID

proxyIpstringrequired

Proxy server IP address

proxyPortintegerrequired

Proxy server port

proxyNamestring

Custom name for the proxy

countrystring

Country (e.g., "US", "CN")

citystring

City name

usernamestring

Authentication username (if required)

passwordstring

Authentication password (if required)

proxyTypeinteger

Proxy protocol type:

  • 0 = HTTP
  • 1 = HTTPS
  • 2 = SOCKS5
  • 3 = SSH
proxyProviderintegerrequired

Proxy provider ID:

  • 0 = HTTP
  • 1 = HTTPS
  • 2 = SOCKS5
  • 3 = SSH
  • 4 = Oxylabs
  • 5 = Proxys.io
  • 6 = GeoSurf
  • 7 = Luminati
  • 8 = Lumauto
  • 9 = Oxylabsauto
  • 10 = Trojan
  • 11 = Shadowsocks
  • 12 = vmess
  • 13 = ABCPROXY
  • 14 = LunaProxy
  • 15 = IPHTML
  • 16 = PiaProxy
  • 17 = 922S5
encryptionTypeinteger

Encryption type (provider-specific, usually 0 for plain)

ipMonitorboolean

Enable IP change monitoring

ipChangeActioninteger

Action to take when IP changes:

  • 1 = Notify / Refresh (common value)

Check system documentation for full options.

refreshUrlstring

URL to trigger IP refresh (if supported by provider)

statestring

Reserved field or custom state (optional)

curl -i -X POST \
  https://guide.morelogin.com/_mock/api-reference/local-api/local-api/api/proxyInfo/update \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1566403036579198,
    "proxyIp": "108.11.23.85",
    "proxyPort": 4096,
    "proxyName": "MyProxy",
    "country": "US",
    "city": "New York",
    "username": "",
    "password": "",
    "proxyType": 0,
    "proxyProvider": 0,
    "encryptionType": 0,
    "ipMonitor": true,
    "ipChangeAction": 1,
    "refreshUrl": "",
    "state": ""
  }'

Responses

Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstringrequired

Error message

requestIdstringrequired

Operation Request ID

Response
application/json
{
  "code": 0,
  "msg": "",
  "requestId": "efgh5678"
}

Delete proxy

Request

Bodyapplication/jsonrequiredArray [
integer(int64)
]
curl -i -X POST \
  https://guide.morelogin.com/_mock/api-reference/local-api/local-api/api/proxyInfo/delete \
  -H 'Content-Type: application/json' \
  -d '[
    1054661322597744600,
    1054661322597744600
  ]'

Responses

Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstringrequired

Error message

requestIdstringrequired

Operation Request ID

Response
application/json
{
  "code": 0,
  "msg": "",
  "requestId": "ijkl9012"
}

Group Management

Operations

Tag Management

Operations