Skip to main content
GET
/
v2
/
endpoints-custom
Generate custom endpoints
curl --request GET \
  --url https://api.decodo.com/v2/endpoints-custom
[
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10000",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10001",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10002",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10003",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10004",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10005",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10006",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10007",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10008",
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10009"
]

Query Parameters

​
proxy_type
enum<string>
default:residential_proxies

For what proxy type you wish to generate routes

Available options:
residential_proxies
​
auth_type
enum<string>
default:basic

Provide what authorization method you want to use, it could be basic or whitelist. Default is basic. whitelist only works when param proxyType value is residential_proxies.

Available options:
basic,
whitelist
​
username
string

Provide username for authorization. This param is required if param authType value is basic.

​
password
string

Provide password for authorization. This param is required if param authType value is basic.

​
session_type
enum<string>
default:sticky

Choose what session type should be used. Choose sticky for sticky sessions or random for rotating sessions. Default is sticky.

Available options:
sticky,
random
​
session_time
integer<int32>
default:10

Session time in minutes, range is 1-1440(inclusive). This param is required if param proxyType value is residential_proxies and param authType value is basic and param sessionType value is sticky. Default is 10.

​
location
string
default:random

One of available locations in lowercase, could be country Alpha-2 code, city or state name. To get available places, please check Get endpoints by type. Default is random.

​
output_format
enum<string>
default:protocol:auth@endpoint

Output format type. Default is protocol:auth@endpoint.

Available options:
protocol:auth@endpoint,
endpoint:auth,
auth@endpoint
​
count
integer<int32>
default:10

Count of routes that will be generated and returned. Min value is 1, max value depends on param page and specific location. Default is 10.

​
page
integer<int32>
default:1

Page of the routes(pagination). Min value is 1, max value depends on param count and specific location. Default is 1.

​
response_format
enum<string>
default:json

What response type will be returned. Could be json, txt or html. Default is json.

Available options:
json,
txt,
html
​
line_break
enum<string>
default:\n

What line break will be used in response content. This is required if param responseType value is txt. Default is \n.

Available options:
\n,
\r\n,
\r,
\t
​
domain
string
default:decodo.com

What domain should be used for routes. Default is dedoco.com. ip is for using IP address instead of a domain.

​
ip
string

IP address to be used instead of a domain. This field is required if param domain value is ip.

Response

200