POST
/
v1
/
proxy
/
endpoints-custom
curl --request POST \
  --url https://api.goproxy.com/go-api/v1/proxy/endpoints-custom \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <apikey>' \
  --data '{
  "proxyType": 123,
  "username": "<string>",
  "password": "<string>",
  "protocol": "<string>",
  "randomLocation": true,
  "countryCode": "<string>",
  "regionName": "<string>",
  "cityName": "<string>",
  "sessionType": "<string>",
  "sessionTime": 123,
  "count": 123
}'
[
  "socks5://customer-testUser-country-US-session-0yt93h5o1apsf0b-time-10:testPass@proxy.goproxy.com:30000"
]

Headers

​
apiKey
string
required

API key used for authentication.

Body

application/json
​
proxyType
integer
required

The proxy type for the sub-account. Use: 1 for Rotating Residential, 2 for Rotating Mobile, 3 for Rotating Datacenter.

​
username
string
required

The username you wish to use with the proxies.

​
password
string
required

The password for the username.

​
protocol
string

The protocol used to generate the endpoint. Available options include Endpoint:Port, HTTP(S), and SOCKS5. The default protocol is Endpoint:Port.

​
randomLocation
boolean

Indicates whether a specific location is provided. If true, location fields (e.g., countryCode, regionName, cityName) are omitted. Default is false.

​
countryCode
string

The code of the country. Must be included in the body when the randomLocation field is true.

​
regionName
string

The name of region that you want to specify.

​
cityName
string

The name of city that you want to specify.

​
sessionType
string

The type of session you want to use. Available options are Rotating and Sticky. If omitted, the default value is Rotating. If Rotating is chosen, the sessionTime field is omitted, even if values are provided.

​
sessionTime
integer

The duration of the session, in minutes. This field must be included when sessionType is Sticky and must be between 3 and 60 minutes.

​
count
integer

The number of endpoints you want the API to return. Must be included when sessionType is Sticky, and it must be between 1 and 50,000. Default is 10.

Response

200 - application/json
Successful Response

The response is of type string[].

Get Default EndpointsCheck Available Countries