Authorization

There are two ways to authorize requests: using temporary sessions or a static API key. We strongly recommend using temporary sessions. However, you may use a static API key at your own risk.

To authorize with a session, authenticate using your email and password, and include the temporary token received during authentication in the request header in the format: authorization: 'session {token}'.

To authorize with a static API key, generate an API key and include it in the request header in the format: authorization: 'key {api_key}'.

Auth

Signin[POST]

User Authentication.

https://api.gsocks.net/auth/signin

Request Body

Field	Type	Description
email*	String	Email
password*	String	Password

Response

`200`

Field	Type	Description
token	String	Temporary session token

Profile

Get balance[GET]

Get balance

https://api.gsocks.net/client/balance

Request Header

Field	Type	Description
authorization*	String	Authorization token

Response

`200`

Field	Type	Description
balance	String	Balance

Finance

Get Payments[GET]

Get list of payments

https://api.gsocks.net/finance/payments

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
limit	Number	Count per page Default value: `10`
page	Number	Page Default value: `1`

Response

`200`

Field	Type	Description
payments	Array	Payments
count	Number	Total count

Get Expenses[GET]

Get list of expenses

https://api.gsocks.net/finance/expenses

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
limit	Number	Count per page Default value: `10`
page	Number	Page Default value: `1`

Response

`200`

Field	Type	Description
expenses	Array	Expenses
count	Number	Total count

Proxy

Mobile and datacenter proxies are always purchased with dedicated traffic for each proxy. However, for residential proxies, there are two options: you can either buy proxies with dedicated traffic, or purchase traffic for the entire account and create an unlimited number of proxies.

To create residential proxies linked to account traffic, you first need to purchase the traffic and then specify the proxy type as residential when creating the proxy. For residential proxies with dedicated traffic, set the proxy type to dedicated-residential.

Get common proxy price(without promocode)[GET]

Get common proxy price(without promocode)

https://api.gsocks.net/proxy/price

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `datacenter`, `residential`, `private`, `dedicated-residential`, `package-residential`
volume*	Number	Gigabytes for residential, mobile and datacenters, days for private
count*	Number	Count Default value: `1`

Response

`200`

Field	Type	Description
price	String	Price

Get final proxy price(with promocode)[GET]

Get final proxy price(with promocode)

https://api.gsocks.net/proxy/final-price

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `datacenter`, `residential`, `private`, `dedicated-residential`, `package-residential`
volume*	Number	Gigabytes for residential, mobile and datacenters, days for private
count*	Number	Count Default value: `1`

Response

`200`

Field	Type	Description
price	String	Price

Get list of private countries[GET]

Get list of private countries

https://api.gsocks.net/proxy/private-countries

Response

`200`

Field	Type	Description
countries	Array	List of countries

Get list of datacenter countries[GET]

Get list of datacenter countries

https://api.gsocks.net/proxy/datacenter-countries

Response

`200`

Field	Type	Description
countries	Array	List of countries

Get list of mobile countries[GET]

Get list of mobile countries

https://api.gsocks.net/proxy/mobile-countries

Response

`200`

Field	Type	Description
countries	Array	List of countries

Get list of residential countries[GET]

Get list of residential countries

https://api.gsocks.net/proxy/residential-countries

Response

`200`

Field	Type	Description
countries	Array	List of countries

Get list of residential regions[GET]

Get list of residential regions

https://api.gsocks.net/proxy/residential-regions

Request Query Parameter(s)

Field	Type	Description
country*	String	Country

Response

`200`

Field	Type	Description
regions	Array	List of regions

Get list of residential cities[GET]

Get list of residential cities

https://api.gsocks.net/proxy/residential-cities

Request Query Parameter(s)

Field	Type	Description
country*	String	Country
region*	String	Region

Response

`200`

Field	Type	Description
cities	Array	List of cities

Get list of residential isp[GET]

Get list of residential isp

https://api.gsocks.net/proxy/residential-isp

Request Query Parameter(s)

Field	Type	Description
country*	String	Country
region*	String	Region
city*	String	City

Response

`200`

Field	Type	Description
isp	Array	List of isp

Get list of dedicated residential countries[GET]

Get list of dedicated residential countries

https://api.gsocks.net/proxy/dedicated-residential-countries

Response

`200`

Field	Type	Description
countries	Array	List of countries

Get list of dedicated residential cities[GET]

Get list of dedicated residential cities

https://api.gsocks.net/proxy/dedicated-residential-cities

Request Query Parameter(s)

Field	Type	Description
country*	String	Country

Response

`200`

Field	Type	Description
cities	Array	List of cities

Get list of dedicated residential isp[GET]

Get list of dedicated residential isp

https://api.gsocks.net/proxy/dedicated-residential-isp

Request Query Parameter(s)

Field	Type	Description
country*	String	Country
city*	String	City

Response

`200`

Field	Type	Description
isp	Array	List of isp

Add residential traffic volume[POST]

Add residential volume

https://api.gsocks.net/proxy/residential-volume

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Body

Field	Type	Description
volume*	Number	Volume in GB

Response

`200`

Field	Type	Description
message	String	Success

Get residential traffic volume[GET]

Get residential traffic volume

https://api.gsocks.net/proxy/residential-volume

Request Header

Field	Type	Description
authorization*	String	Authorization token

Response

`200`

Field	Type	Description
have_traffic	Boolean	Availability of traffic
rest_volume	String	Remaining traffic
volume	String	Total traffic

Create proxy[POST]

Create proxy

https://api.gsocks.net/proxy/

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Body

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `residential`, `private`, `datacenter`, `dedicated-residential`, `package-residential`
volume*	Number	Gigabytes for residential, mobile and datacenters, days for private
count	Number	Count Default value: `1`
city	String	City Default value: `Any`
region	String	Region Default value: `Any`
isp	String	Isp Default value: `Any`
country	String	Country Default value: `Any`
username	String	Username
password	String	Password
rotation	String	Rotation type Allowed values: `request`, `link`, `5`, `10`, `15`, `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`
price	Number	If you calculate the price on your end, it should be sent for verification.
package_id	Number	Details

Response

`200`

Field	Type	Description
message	String	Success
proxy	Object	Proxy data

Get some proxies[GET]

Get some proxies

https://api.gsocks.net/proxy

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `residential`, `private`, `datacenter`, `dedicated-residential`, `package-residential`
active*	String	Status Allowed values: `active`, `archived`, `all`
limit	Number	Count per page Default value: `10`
page	Number	Page Default value: `1`

Response

`200`

Field	Type	Description
proxies	Array	Proxies
count	Number	Total count

Get one proxies[GET]

Get one proxies

https://api.gsocks.net/proxy/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Request Query Parameter(s)

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `residential`, `private`, `datacenter`, `dedicated-residential`, `package-residential`

Response

`200`

Field	Type	Description
proxy	Object	Proxy

Get residential proxy list[GET]

Get residential proxy list.

By default you will be returned a list with the domain residential.gsocks.net, the servers for this domain are located in the USA, if you are in Europe you can change the domain to eu.residential.gsocks.net, in this case the server located in Europe will be used. You can also use us.residential.gsocks.net, but this is the same as just residential.gsocks.net.

https://api.gsocks.net/proxy/residential-proxy-list/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Request Query Parameter(s)

Field	Type	Description
br	Boolean	Line break via

Response

`200`

Field	Type	Description
List	String	Proxy list

Get residential proxy list by username[GET]

Get residential proxy list

https://api.gsocks.net/proxy/residential-proxy-list-pseudo/:username

Request Parameter(s)

Field	Type	Description
username*	String	List username

Request Query Parameter(s)

Field	Type	Description
br	Boolean	Line break via

Response

`200`

Field	Type	Description
List	String	Proxy list

Update proxy[PUT]

Update proxy

https://api.gsocks.net/proxy/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Request Body

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `residential`, `datacenter`, `dedicated-residential`, `package-residential`
city*	String	Allowed for: `residential`, `dedicated-residential`, `package-residential`
region*	String	Allowed for: `residential`, `dedicated-residential`, `package-residential`
isp*	String	Allowed for: `residential`, `dedicated-residential`, `package-residential`
country*	String	Allowed for: `residential`, `dedicated-residential`, `package-residential`
rotation*	String	Rotation type Allowed for: `residential`, `dedicated-residential`, `mobile` and `datacenter`, `package-residential` Allowed values: `request`, `link`, `5`, `10`, `15`, `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`

Response

`200`

Field	Type	Description
message	String	Success

Renewal proxy[POST]

Renewal proxy

https://api.gsocks.net/proxy/renewal

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Body

Field	Type	Description
type*	String	Type Allowed values: `mobile`, `private`, `datacenter`, `dedicated-residential`
volume*	Number	Gigabytes for residential, mobile and datacenters, days for private
ids*	Number[]	List of proxy ids
price	Number	If you calculate the price on your end, it should be sent for verification.

Response

`200`

Field	Type	Description
message	String	Success

Get residential traffic log[GET]

Get residential traffic log

https://api.gsocks.net/proxy/residential-traffic-log

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
username*	String	List username

Response

`200`

Field	Type	Description
Log	Array	Traffic log

Get residential nodes info[GET]

Get residential nodes info

https://api.gsocks.net/proxy/residential-nodes-info

Response

`200`

Field	Type	Description
nodes	Object	Nodes list

Create residential package[POST]

Create residential package

https://api.gsocks.net/proxy/residential-package

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Body

Field	Type	Description
username*	String	Username
password*	String	Password

Response

`200`

Field	Type	Description
message	String	Success
package	Object	Package data

Get some residential packages[GET]

Get some residential packages

https://api.gsocks.net/proxy/residential-package

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Query Parameter(s)

Field	Type	Description
limit	Number	Count per page Default value: `10`
page	Number	Page Default value: `1`

Response

`200`

Field	Type	Description
packages	Array	Proxies
count	Number	Total count

Get one residential package[GET]

Get one residential package

https://api.gsocks.net/proxy/residential-package/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Response

`200`

Field	Type	Description
package	Object	Proxy

Update residential package[PUT]

Update residential package

https://api.gsocks.net/residential-package/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Request Body

Field	Type	Description
username*	String	Username
password*	String	Password

Response

`200`

Field	Type	Description
message	String	Success
package	Object	Proxy

Renewal residential package[POST]

Renewal residential package

https://api.gsocks.net/proxy/residential-package/renewal/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Body

Field	Type	Description
volume*	Number	Volume in GB

Response

`200`

Field	Type	Description
message	String	Success
package	Object	Proxy

Delete residential package[DELETE]

Delete residential package

https://api.gsocks.net/proxy/residential-package/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Response

`200`

Field	Type	Description
message	String	Success

Get residential proxies by package[GET]

Get residential proxies by package

https://api.gsocks.net/proxy/residential-by-package/:id

Request Header

Field	Type	Description
authorization*	String	Authorization token

Request Parameter(s)

Field	Type	Description
id*	Number	Id

Request Query Parameter(s)

Field	Type	Description
limit	Number	Count per page Default value: `10`
page	Number	Page Default value: `1`

Response

`200`

Field	Type	Description
packages	Array	Proxies
count	Number	Total count