Skip to main content
POST
/
api
/
v2
/
proxy
/
endpoints
/
custom
Generate customized endpoints
curl --request POST \
  --url https://api.okeyproxy.com/ipglobal-api/api/v2/proxy/endpoints/custom \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "<string>",
  "proxyType": 123,
  "secUsername": "<string>",
  "protocol": "<string>",
  "randomLocation": 123,
  "countryCode": "<string>",
  "regionName": "<string>",
  "cityName": "<string>",
  "sessionType": "<string>",
  "sessionTime": 123,
  "count": 123
}
'
"socks5://customer-mn5m509632-country-PT-region-Aveiro-city-Arcos-session-k102pjzfil6nsvx-time-6:[email protected]:30000"

Body

application/json
​
apiKey
string
required

Agent API key used for authentication

​
proxyType
integer
required

Rotating proxies type. 1 for Starter, 2 for Advanced, 3 for Premium.

​
secUsername
string
required

Sec-user account. Letters and numbers only, up to 40 characters.

​
protocol
string

Protocol used for the endpoint. Options: Endpoint:Port (default), HTTP(S), SOCKS5.

​
randomLocation
integer

Random location option. 1 for random location, 2 for custom location. Required location fields (countryCode, regionName, cityName) can be omitted when set to 1 (default: 1).

​
countryCode
string

Country code. Required only when randomLocation is 2. Case-insensitive.

​
regionName
string
​
cityName
string

City name. Required only when randomLocation is 2 and regionName is provided.

​
sessionType
string

Session type. Options: Rotating (default), Sticky.

​
sessionTime
integer

Session time. Required only when sessionType is Sticky. Allowed range: 3–60.

​
count
integer

Number of endpoints to return. Required only when sessionType is Sticky. Allowed range: 1–50000.

Response

200 - application/json
​
endpoint
string
required

Generated proxy endpoint with authentication