Terms and Conditions：

1.Please complete account registration before use and ensure to use it in an overseas environment.

2.If your business country belongs to Asia, such as the countries in the appendix table, it is recommended that you rent a request source server in Singapore to achieve the lowest latency.

3.If your business country is in the United States or a non-Asian country, it is recommended that you rent a source server in San Francisco to achieve the lowest latency.

Sample code：

We provide multiple programming language access examples, you can download them for reference：Go to download

Table of contents：

  1.API description

  2.Log in to get token

  3.IP proxy account management

   3.1 Create an IP proxy account

    3.2 Get IP proxy account list

    3.3 Update the parameters of an IP proxy account

    3.4 Remove ip proxy account

    3.5 Query IP proxy account traffic consumption

  4.Use IP proxy

    4.1 Used by api extraction

    4.2 Used as a combined agent account

  5.Source address ip whitelist management

    5.1 Add IP to whitelist

    5.2 Get the whitelist ip list

    5.3 Modify whitelist ip

    5.4 Remove IP from whitelist

  6.Statistical reports

    6.1 Data recharge history

    6.2 Traffic consumption statistics every 5 minutes

    6.3 Traffic consumption statistics per day

  7.Query country and area code

1.API description

The return value is in the following json format：

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

The field names contained in the data object	meaning
code	response code
msg	Answer prompt
data	response data object

response code	meaning
0	success
400	parameter error
401	token invalid or wrong user name or password
423	User is locked by administrator
500	Server side error

2.Log in to get token(http get)

Example: http://api.seaproxy.net:8082/agent/customer_login?cust_code=xxx&password=xxx

Request parameter name	Meaning	Is it required?
cust_code	Email address when registering	yes
password	Password when registering	yes

The field names contained in the data object	meaning
token	The token represents the user's login credentials on the server and is passed in as a parameter in the next API request.

3.IP proxy account management (applicable to authentication-free, tunnel proxy, and account IP)

3.1 Create an IP proxy account(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxyuser/add?token=xxx&&proxy_user=xxx&proxy_pass=xxx&content=1234&status=1&flow_cap=100&flow_islimit=true

Request parameter name	Meaning	Is it required?
token	token	yes
proxy_user	Fill in the IP proxy account to be created. Can only include letters, numbers, and underscores, up to 15 characters, and cannot include '-' and ':' characters	yes
proxy_pass	Fill in the IP proxy password to be created. Can only include letters, numbers, and underscores, up to 15 characters, and cannot include '-' and ':' characters	yes
status	Whether the account is enabled, 1 means enabled, 0 means not enabled	No Default is 1
flow_cap	Maximum usable traffic(MB)	no
flow_islimit	Whether flow_cap is valid, true is valid, false is invalid	no Default is false
content	Remark	no

response code	meaning
409	proxy_user already exists
412	The number of proxy_user users has reached 20

3.2 Get IP proxy account list(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxyuser/fetch?token=xxx&proxy_user=xxx&limit=50&offset=0

Request parameter name	Meaning	Is it required?
token	token	yes
proxy_user	IP proxy account to be queried, multiple separated by commas	no
offset	Starting from the number	No Default is 0
limit	How many can be taken at most?	No Default is 100

The field names contained in the data object	Meaning
proxy_user	ip proxy account
proxy_pass	ip proxy password
create_time	Creation time (Beijing)
update_time	Update time (Beijing)
used_time	Last time of use (Beijing)
usedat	Last used timestamp (utc seconds)
flow_used	Traffic used (MB)
Traffic used (MB)	Allowed traffic (MB), valid when flow_islimit is true
flow_islimit	Whether flow_cap is valid, true is valid, false is invalid
status	Whether the account is enabled, 1 means enabled, 0 means not enabled
content	Remark

3.3 Update the parameters of an IP proxy account(http get

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/update?token=xxx&&proxy_user=xxx&proxy_pass=xxx&content=1235&status=1

Request parameter name	Meaning	Is it required?
token	token	yes
proxy_user	ip proxy account	yes
proxy_pass	ip proxy password. Can only include letters, numbers, and underscores, up to 15 characters, and cannot include '-' and ':' characters	no
status	Whether the account is enabled, 1 means enabled, 0 means not enabled	No Default is 1
flow_cap	Maximum usable traffic(MB)	no
flow_islimit	Whether to limit the maximum usable traffic, true means enabled, false means disable	No Default is false
content	Remark	no

response code	Meaning
404	proxy_user does not exist
412	Update conditions not met

3.4 Remove ip proxy account(http get)

Example:http://api.seaproxy.net:8082/agent/customer_proxywhite/remove?token=xxx&&proxy_user=xxx

Request parameter name	Meaning	Is it required?
token	token	yes
proxy_user	IP proxy accounts to be removed, separate them with commas to remove multiple	yes

3.5 Query IP proxy account traffic consumption(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/report5m?token=xxx&&proxy_user=xxx&start_time=2023-03-24 09:30&end_time=2023-03-24 16:30&limit=100&offset=0

Request parameter name	Meaning	Is it required?
token	token	yes
proxy_user	ip proxy account	yes
start_time	Starting time, the format is 2022-07-06 13:21:50	yes
end_time	Starting time, the format is 2022-07-06 13:21:50	yes
offset	Starting from the number of items	No Default is 0
limit	How many items can be taken at most?	No Default is 100

4.Use a proxy (all requests and uses must be in an overseas network environment)

4.1 Use it through API extraction (account secret IP and authentication-free IP can be extracted)(http get)

Example：http://api.seaproxy.net:8082/client_getip?user=xxx&pass=xxx&protocol=0&count=30&hours=0&portmap=0&keeptime=120®ion=BR

Request parameter name	Meaning	Is it required?
user	It is the proxy_user (ip proxy account) created in point 3 above [Note: not the email address when registering]	yes
pass	It is the proxy_pass (ip proxy password) created in point 3 above [Note: not the password used during registration]	yes
region	country or region code	No Default is all region
area	Provinces of the corresponding country or region	No Default is this region
count	Number of extracted IPs	yes
protocol	IP protocol。1:http/https, 0:socks5	No Default is 1
ft	api return data format 1 text 2 json	No Default is 2
pat	Content delimiter when format is text format 1: \r\n 2: \r 3: \n 4: \t	No Default is 1
portmap	When this parameter is 1, it is an authentication-free IP mode (ip + port), and different IPs and ports represent different exit IPs. When this parameter is 0, the account and password IP (account number, password, IP, port) of user and pass are returned.	no
keeptime	IP aging, in minutes, must be a positive integer. When portmap is 1, the authentication-free IP (ip + port) is obtained. At this time, the keeptime value represents the port expiration time. The default keeptime is 3 minutes (only the value within 3-30 minutes can be filled in). After expiration, the port will be recycled and The network connection is disconnected; when the portmap is 0, the account IP is obtained at this time. The keeptime value represents the automatic switching IP time. After expiration, the same exit condition IP will be automatically switched. If the keeptime value is 0, the IP will not be disconnected after it is disconnected. IP will be automatically switched and the network connection will be disconnected.	no
hours	When this parameter is 1, the extracted IP is more stable and represents the preferred IP pool. When this parameter is 0, it means that the preferred IP pool will not be used.	no

The field names contained in the data object	Meaning
user	Agent authenticates users (if portmap=1, this value is empty)
pass	Agent authentication password (if portmap=1, this value is empty)
ip	Proxy request ip address
port	Proxy request port
ptype	Supported protocol name, socks5 or http

response code	Meaning
0	success
400	Parameters are missing or invalid
401	proxy_user or proxy_pass error
404	proxy_user does not exist
412	Not enough user traffic
423	proxy_user is locked
500	Server side error

4.2 Used as a combined proxy account (tunnel proxy)(http get)

server address：

Press win+R to enter cmd, enter nslookup proxy.seaproxy.net to obtain the IP address table

If you want to get lower latency and your business is in Asia, please use the following method to obtain the IP address: press win+R to enter cmd, enter nslookup sgpproxy.seaproxy.net to obtain the Asian IP address table.

If you want to get lower latency and your business is in a non-Asian region, please use the following method to obtain the IP address: press win+R to enter cmd, enter nslookup usproxy.seaproxy.net to obtain the non-Asian IP address table.

port：9999

Password: This password is the proxy_pass (ip proxy password) created in point 3 above.

Account: The combination method uses '-' to connect each field. The format is：

{proxy_user}-{random number}-region-{country code}-area-{region code}-keeptime-{number of minutes to keep the ip}-hours-{take the preferred ip}

proxy_user:The proxy_pass (ip proxy account) created in point 3 above.

Random number: Use this parameter to distinguish different IPs. If the value is empty, it means changing the IP every time.

region:Used to specify a country (if this parameter is not filled in, it defaults to all countries).

area:Used to refer to regions (if this parameter is not filled in, it defaults to all regions).

keeptime:The unit is minutes and must be a positive integer. It represents the automatic IP switching time. When the value is greater than 0, it will automatically switch to the same exit condition IP after expiration. When it is 0, the IP will not be automatically switched after the IP is disconnected, and the network connection will be disconnected.

hours:When this parameter is 1, the extracted IP is more stable and represents the preferred IP pool. When this parameter is 0, it means that the preferred IP pool will not be used.

【Notice】

1：{proxy_user}-{Random number} is required and must be at the front。

2：The country code is in capital letters。

3：The server address must be obtained by using the above method. The IP address is the server address and cannot be filled in directly use sgpproxy.seaproxy.net or usproxy.seaproxy.net

For example: a user's proxy_user is hello199 and proxy_pass is world. but

hello199-123-region-US-keeptime-30-hours-1

Explanation: Take the preferred IP in the United States and automatically switch in 30 minutes.

hello199-123-region-US-keeptime-30-hours-0

Explanation: Take all IP pools in the United States and automatically switch to new IPs in 30 minutes.

hello199-123-region-US-keeptime-0-hours-0

Explanation: The keeptime is 0, which means that the IP will not automatically switch to the same condition after the IP is offline. The hours is 0, which means the IP will be taken from all IP pools in the United States.

hello199--region-US-keeptime-0-hours-0

Explanation: Change IP every time you connect.

Error code returned when using http/https protocol proxy(http get)

response code	Meaning
400	No host
407	No auth data
510	Failed to connect to destination address
512	Export IP is not online
513	The connection on the exit ip exceeds the limit
514	The user has no traffic
515	The server is not ready yet (user data has not been synchronized yet)
516	Failed to switch IP
517	Destination address blacklist and whitelist verification failed
518	auth verification failed

Error code returned when using socks5 protocol proxy(http get)

response code	Meaning
0xFF	Failed to switch IP
0x02	auth failed
0x03	Export IP is not online
0x05	Failed to connect to destination address
0x0A	The connection on the exit ip exceeds the limit
0x0B	The user has no traffic
0x0C	The server is not ready yet (user data has not been synchronized yet)
0x0D	Destination address blacklist and whitelist verification failed

5.Source address ip whitelist management (authentication-free ip proxy method when filling in a value of 1 for the portmap)

5.1 Add IP to whitelist(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/add?token=xxx&ip=xxx

Request parameter name	Meaning	Is it required?
token	token	yes
ip	Fill in the IPs that need to be added to the whitelist. If you need to add multiple IPs, separate them with commas. You can add up to 6 IP addresses.	yes
Remark	Switch failed	no

response code	Meaning
409	IP already exists
412	The number of whitelist IPs for the current user has reached 6.

5.2 Get the whitelist ip list(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/fetch?token=xxx

Request parameter name	Meaning	Is it required?
token	token	yes
ip	Fill in the IP that needs to be queried. If you need to query multiple ips, separate them with commas.	no

The field names contained in the data object	Meaning
ip	IP address
status	Enable status, 1 means enabled, 0 means disable
create_time	Creation time (Beijing time)
Creation time (Beijing time)	Remark

5.3 Modify the parameters of the whitelist IP(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/update?token=xxx&ip=xxx&status=0&content=iptest

Request parameter name	Meaning	Is it required?
token	token	yes
ip	Fill in the IP that needs to be modified. If you need to modify multiple IPs, separate them with commas.	no
content	Remark	no
status	Whether to enable, 0 means disable, 1 means enable	no

5.4 Remove IP from whitelist(http get)

Example: http://api.seaproxy.net:8082/agent/customer_proxywhite/remove?token=xxx&ip=xxx

Request parameter name	Meaning	Is it required?
token	token	yes
ip	Fill in the IP that needs to be modified. If you need to modify multiple IPs, separate them with commas.	no

6.Statistical reports

6.1 Data recharge history(http get)

Example: http://api.seaproxy.net:8082/agent/customer_charge_humanreport?token=xxxxx&start_day=2022-06-17 18:10:54&end_day=2022-06-17 18:18:55

Request parameter name	Meaning	Is it required?
token	token	yes
start_day	Starting time, the format is 2022-07-06 13:21:50	yes
end_day	End time, the format is 2022-07-06 13:21:50	yes
limit	How many records to get	No Default is 1000
token	Which article to start from?	No Default is 0

The field names contained in the data object	Meaning
user_remain	remaining flow(MB)
sum)	How much traffic was charged in total during the query time interval?
data_count	Time and corresponding flow value(MB)

6.2 Traffic consumption statistics every 5 minutes(http get)

Example: http://api.seaproxy.net:8082/agent/customer_5min_humanreport?token=xxx&start_day=2022-03-17 18:10:54&end_day=2022-06-20

Request parameter name	Meaning	Is it required?
token	token	yes
start_day	Starting time, the format is 2022-07-06 13:21:50	yes
end_day	End time, the format is 2022-07-06 13:21:50	yes
limit	How many records to get	No Default is 1000
token	Which article to start from?	No Default is 0

The field names contained in the data object	Meaning
user_remain	remaining flow(MB)
sum	How much traffic was charged in total during the query time interval?
data_count	Time and corresponding flow value(MB)

5.3 Traffic consumption statistics per day(http get)

Example: http://api.seaproxy.net:8082/agent/customer_day_humanreport?token=xxxxx&start_day=2022-03-17&end_day=2022-06-20

Request parameter name	Meaning	Is it required?
token	token	yes
start_day	Starting time, the format is 2022-07-06 13:21:50	yes
end_day	End time, the format is 2022-07-06 13:21:50	yes
limit	How many records to get	No Default is 1000
token	Which article to start from?	No Default is 0

The field names contained in the data object	Meaning
user_remain	remaining flow(MB)
sum	How much traffic was charged in total during the query time interval?
data_count	Time and corresponding flow value(MB)

7.Query country and area code

7.1 Country code list(http get)

Example: http://api.seaproxy.net:8082/agent/customer_regions

The field names contained in the data object	Meaning
data_count	Country code list

7.2 Country code list(http get)

Example: http://api.seaproxy.net:8082/agent/customer_rgareaids?region=US

Request parameter name	Meaning	Meaning
region	country or region code	yes

The field names contained in the data object	Meaning
data_count	Region name and corresponding ID number

8.country/region code

Asia (Singapore Server Cluster)：

AZ: 阿塞拜疆, IN: 印度, IL: 以色列, VN: 越南, IQ: 伊拉克, GE: 格鲁吉亚, KR: 韩国, AE: 阿联酋, BN: 文莱, ID: 印度尼西亚, IR: 伊朗, TJ: 塔吉克斯坦, TH: 泰国, MO: 中国澳门, CN: 中国, OM: 阿曼, TW: 中国台湾, NP: 尼泊尔, MY: 马来西亚, YE: 也门, KG: 吉尔吉斯斯坦, JO: 约旦, QA: 卡塔尔, SA: 沙特阿拉伯, KZ: 哈萨克斯坦, LB: 黎巴嫩, LK: 斯里兰卡, BH: 巴林, PK: 巴基斯坦, KW: 科威特, PH: 菲律宾, MN: 蒙古, LA: 老挝, UZ: 乌兹别克斯坦, JP: 日本, KH: 柬埔寨, PS: 巴勒斯坦, AM: 亚美尼亚, BD: 孟加拉, HK: 中国香港, MV: 马尔代夫, SG: 新加坡, CY: 塞浦路斯, TL: 东帝汶, MM: 缅甸, BT: 不丹, AF: 阿富汗, SY: 叙利亚

Europe (US server cluster)：

BG: 保加利亚, XK: 科索沃, AT: 奥地利, RO: 罗马尼亚, BY: 白俄罗斯, MT: 马耳他, RS: 塞尔维亚, CH: 瑞士, BE: 比利时, LT: 立陶宛, GR: 希腊, BA: 波斯尼亚和黑塞哥维那, RU: 俄罗斯, SI: 斯洛文尼亚, NL: 荷兰, SE: 瑞典, ME: 黑山, LV: 拉脱维亚, DE: 德国, GB: 英国, MK: 北马其顿, TR: 土耳其, HU: 匈牙利, IE: 爱尔兰, AD: 安道尔, PT: 葡萄牙,UA: 乌克兰, CZ: 捷克, IT: 意大利, FR: 法国, HR: 克罗地亚, IM: 马恩岛, FI: 芬兰, PL: 波兰, DK: 丹麦, ES: 西班牙, MD: 摩尔多瓦, LI: 列支敦士登, AL: 阿尔巴尼亚, SK: 斯洛伐克, JE: 泽西岛, SX: 荷属圣马丁, GI: 直布罗陀, EE: 爱沙尼亚, GG: 根西岛, NO: 挪威, LU: 卢森堡, MC: 摩纳哥, FO: 法罗群岛, AX: 奥兰群岛, SM: 圣马力诺, IS: 冰岛

Americas (US server cluster)：

BR: 巴西, AR: 阿根廷, VE: 委内瑞拉, BO: 玻利维亚, CL: 智利, CA: 加拿大, DO: 多米尼加, LC: 圣卢西亚, CW: 库拉索, PY: 巴拉圭,GP: 瓜德罗普, MF: 法属圣马丁, PE: 秘鲁, HN: 洪都拉斯, CO: 哥伦比亚, MQ: 马提尼克, GY: 圭亚那, UY: 乌拉圭, VI: 美属维尔京群岛, TT:特立尼达和多巴哥, PR:波多黎各, PA: 巴拿马, US: 美国, SR: 苏里南, GT: 危地马拉, MX: 墨西哥, DM: 多米尼克, SV: 萨尔瓦多, NI: 尼加拉瓜, KN: 圣基茨和尼维斯, BS: 巴哈马, CR: 哥斯达黎加, BB: 巴巴多斯, GL: 格陵兰, BZ: 伯利兹, AW: 阿鲁巴, FK: 福克兰群岛, GF: 法属圭亚那, BM: 百慕大, GD: 格林纳达, VG: 英属维尔京群岛, HT: 海地, KY: 开曼群岛, AI: 安圭拉, VC: 圣文森特和格林纳丁斯, CU: 古巴, AG: 安提瓜和巴布达, TC: 特克斯和凯科斯群岛

Africa (US server cluster)：

SN: 塞内加尔, CI: 科特迪瓦, TN: 突尼斯, TZ: 坦桑尼亚, MU: 毛里求斯, AO: 安哥拉, EG: 埃及, DZ: 阿尔及利亚, EC: 厄瓜多尔, MA: 摩洛哥, RE: 留尼汪岛, SD: 苏丹, CM: 喀麦隆, NG: 尼日利亚, JM: 牙买加, KE: 肯尼亚, GA: 加蓬, SC: 塞舌尔, CV: 佛得角, ZA: 南非, YT: 马约特, SL: 塞拉利昂, BW: 博茨瓦纳, MW: 马拉维, TG: 多哥, SZ: 斯威士兰, ET: 埃塞俄比亚, MR: 毛里塔尼亚, GM: 冈比亚, MZ: 莫桑比克, GQ: 赤道几内亚, KM: 科摩罗, BI: 布隆迪, CG: 刚果共和国, GN: 几内亚, RW: 卢旺达, SS: 南苏丹, CD: 刚果民主共和国, ML: 马里, SO: 索马里, LR: 利比里亚, NA: 纳米比亚, GH: 加纳, MG: 马达加斯加, LY: 利比亚, BJ: 贝宁, UG: 乌干达, BF: 布基纳法索, NE: 尼日尔, ZW: 津巴布韦, LS: 莱索托, ZM: 赞比亚, ST: 圣多美和普林西比

Oceania (US server cluster)：

WS: 萨摩亚, AU: 澳大利亚, GU: 关岛, NZ: 新西兰, NC: 新喀里多尼亚, FJ: 斐济, WF: 瓦利斯和富图纳群岛, MP: 北马里亚纳群岛, PW: 帕劳, TO: 汤加, SB: 所罗门群岛, AS: 美属萨摩亚, MH: 马绍尔群岛, VU: 瓦努阿图, PF: 法属波利尼西亚, CK: 库克群岛, MS: 蒙特塞拉特岛, BQ: 荷兰加勒比