1. Authorization

Every API request (except public endpoints) requires an authorization header.

Generate an API key in your dashboard and use it in the header:

authorization: key {api_key}

2. Profile

2.1 GET Balance

Returns the current account balance.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/client/balance
Authorization	✅ Required

Headers:

Header	Type	Required	Description
authorization	String	✅	key {api_key}

Response 200:

Field	Type	Description
balance	String	Current account balance

Example Request:

bash
curl -X GET https://api.gsocks.net/client/balance \
  -H "authorization: session eyJhbGciOiJIUzI1NiIsInR5cCI6..."
Example Response:
json
{
  "balance": "25.50"
}

3. Proxy

3.1 Understanding Proxy Types

Before working with the API, it is important to understand how different proxy types handle traffic:

Type (type value)	Description	Traffic Model	volume Unit
residential	Residential proxies (shared account traffic)	Shared across account	Gigabytes
mobile	Mobile proxies (shared account traffic)	Shared across account	Gigabytes
new-datacenter	New datacenter proxies (shared account traffic)	Shared across account	Gigabytes
private	Private (individual IPv4) proxies	Unlimited traffic	Days

Key concept — shared vs. dedicated traffic:

For proxy types with shared traffic (residential, mobile, new-datacenter): you must first purchase traffic for your account using the Volume endpoints, and then create proxies that draw from that shared pool.

3.2 Price Calculation

3.2.1 GET Final Proxy Price (with promo code)

Same as above, but takes into account the user's active promo code.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/final-price
Authorization	✅ Required

Query Parameters:

Field	Type	Required	Description
type	String	✅	Proxy type. Allowed values: mobile, datacenter, residential, private
volume	Number	✅	Gigabytes (for residential/mobile/datacenter) or days (for private)
count	Number	No (default 1)	Number of proxies

Response 200:

Field	Type	Description
price	String	Final price (with discount applied)

Example Request:

bash
curl -X GET "https://api.gsocks.net/proxy/final-price?type=mobile&volume=2&count=3" \
  -H "authorization: session eyJhbGciOiJIUzI1NiIsInR5cCI6..."

4.3 Available Countries / Regions / Cities / ISPs

These endpoints let you discover available geo-targeting options before creating a proxy. The typical workflow is: Country → Region → City → ISP.

4.3.1 Private — Countries

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/private-countries
Authorization	Not required

Response 200:

Field	Type	Description
countries	Array	List of available countries for private proxies

Example:

bash
curl -X GET https://api.gsocks.net/proxy/private-countries

4.3.2 Datacenter — Countries

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/datacenter-countries
Authorization	Not required

Response 200:

Field	Type	Description
countries	Array	List of available countries for datacenter proxies

bash
curl -X GET https://api.gsocks.net/proxy/datacenter-countries

4.3.3 Residential — Countries

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-countries
Authorization	Not required

Response 200:

Field	Type	Description
countries	Array	List of available countries

bash
curl -X GET https://api.gsocks.net/proxy/residential-countries

4.3.4 Residential — Regions

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-regions
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country code or name

Response 200:

Field	Type	Description
regions	Array	List of regions

bash
curl -X GET "https://api.gsocks.net/proxy/residential-regions?country=US"

4.3.5 Residential — Cities

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-cities
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country
region	String	✅	Region

Response 200:

Field	Type	Description
cities	Array	List of cities

bash
curl -X GET "https://api.gsocks.net/proxy/residential-cities?country=US&region=California"

4.3.6 Residential — ISPs

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-isp
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country
region	String	✅	Region
city	String	✅	City

Response 200:

Field	Type	Description
isp	Array	List of internet service providers

bash
curl -X GET "https://api.gsocks.net/proxy/residential-isp?country=US&region=California&city=Los%20Angeles"

4.3.7 Mobile — Countries

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-countries
Authorization	Not required

Response 200:

Field	Type	Description
countries	Array	List of countries

bash
curl -X GET https://api.gsocks.net/proxy/mobile-countries

4.3.8 Mobile — Regions

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-regions
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country

Response 200:

Field	Type	Description
regions	Array	List of regions

bash
curl -X GET "https://api.gsocks.net/proxy/mobile-regions?country=US"

4.3.9 Mobile — Cities

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-cities
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country
region	String	✅	Region

Response 200:

Field	Type	Description
cities	Array	List of cities

bash
curl -X GET "https://api.gsocks.net/proxy/mobile-cities?country=US&region=California"

4.3.10 Mobile — ISPs

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-isp
Authorization	Not required

Query Parameters:

Field	Type	Required	Description
country	String	✅	Country
region	String	✅	Region
city	String	✅	City

Response 200:

Field	Type	Description
isp	Array	List of mobile ISPs

bash
curl -X GET "https://api.gsocks.net/proxy/mobile-isp?country=US&region=California&city=Los%20Angeles"

4.4 Traffic Volume Management

These endpoints are used for proxy types with shared account traffic (residential, mobile, datacenter). You must purchase traffic before creating proxies of these types.

4.4.1 Add Residential Traffic Volume

Purchases residential traffic for the account.

Parameter	Value
Method	POST
URL	https://api.gsocks.net/proxy/residential-volume
Authorization	✅ Required

Request Body (JSON):

Field	Type	Required	Description
volume	Number	✅	Volume in gigabytes

Response 200:

Field	Type	Description
message	String	"Success"

Example:

bash
curl -X POST https://api.gsocks.net/proxy/residential-volume \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{"volume": 10}'

4.4.2 GET Residential Traffic Volume

Returns the current residential traffic balance.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-volume
Authorization	✅ Required

Response 200:

Field	Type	Description
have_traffic	Boolean	Whether traffic is available (true / false)
rest_volume	String	Remaining traffic
volume	String	Total purchased traffic

Example:

bash
curl -X GET https://api.gsocks.net/proxy/residential-volume \
  -H "authorization: session eyJhbGci..."

Example Response:

json
{
  "have_traffic": true,
  "rest_volume": "7.35",
  "volume": "10.00"
}

4.4.3 Add Mobile Traffic Volume

Purchases mobile traffic for the account.

Parameter	Value
Method	POST
URL	https://api.gsocks.net/proxy/mobile-volume
Authorization	✅ Required

Request Body (JSON):

Field	Type	Required	Description
volume	Number	✅	Volume in gigabytes

Response 200:

Field	Type	Description
message	String	"Success"

bash
curl -X POST https://api.gsocks.net/proxy/mobile-volume \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{"volume": 5}'

4.4.4 GET Mobile Traffic Volume

Returns the current mobile traffic balance.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-volume
Authorization	✅ Required

Response 200:

Field	Type	Description
have_traffic	Boolean	Whether traffic is available
rest_volume	String	Remaining traffic
volume	String	Total purchased traffic

bash
curl -X GET https://api.gsocks.net/proxy/mobile-volume \
  -H "authorization: session eyJhbGci..."

4.4.5 Add Datacenter Traffic Volume

Purchases datacenter traffic for the account.

Parameter	Value
Method	POST
URL	https://api.gsocks.net/proxy/datacenter-volume
Authorization	✅ Required

Request Body (JSON):

Field	Type	Required	Description
volume	Number	✅	Volume in gigabytes

Response 200:

Field	Type	Description
message	String	"Success"

bash
curl -X POST https://api.gsocks.net/proxy/datacenter-volume \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{"volume": 20}'

4.4.6 GET Datacenter Traffic Volume

Returns the current datacenter traffic balance.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/datacenter-volume
Authorization	✅ Required

Response 200:

Field	Type	Description
have_traffic	Boolean	Whether traffic is available
rest_volume	String	Remaining traffic
volume	String	Total purchased traffic

bash
curl -X GET https://api.gsocks.net/proxy/datacenter-volume \
  -H "authorization: session eyJhbGci..."

4.5 Create Proxy

Create Proxy

Creates one or more proxies.

Parameter	Value
Method	POST
URL	https://api.gsocks.net/proxy/
Authorization	✅ Required

Request Body (JSON):

Field	Type	Required	Default	Description
type	String	✅	—	Proxy type. Allowed values: private
volume	Number	✅	—	Days (for private)
count	Number	No	1	Number of proxies to create
username	String	No	—	Username for proxy authentication
password	String	No	—	Password for proxy authentication

Response 200:

Field	Type	Description
message	String	"Success"
proxy	Object	Created proxy data

Example — Create 1 residential proxy (shared traffic) in the US with 10-minute rotation:

bash
curl -X POST https://api.gsocks.net/proxy/ \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "residential",
    "volume": 1,
    "count": 1,
    "country": "US",
    "rotation": "10",
    "username": "myuser",
    "password": "mypass123"
  }'

Example — Create 5 private proxies for 30 days in Germany:

bash
curl -X POST https://api.gsocks.net/proxy/ \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "private",
    "volume": 30,
    "count": 5,
    "country": "DE"
  }'

Example — Create a dedicated mobile proxy with 2 GB traffic:

bash
curl -X POST https://api.gsocks.net/proxy/ \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "dedicated-mobile",
    "volume": 2,
    "country": "US",
    "city": "New York",
    "rotation": "request"
  }'

4.6 GET Proxies

4.6.1 GET Some Proxies — Paginated List

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy
Authorization	✅ Required

Query Parameters:

Field	Type	Required	Default	Description
type	String	✅	—	Proxy type. Allowed values: mobile, residential, private, datacenter
active	String	✅	—	Status filter. Allowed values: active, archived, all
limit	Number	No	10	Items per page
page	Number	No	1	Page number

Response 200:

Field	Type	Description
proxies	Array	List of proxies
count	Number	Total count

Example:

bash
curl -X GET "https://api.gsocks.net/proxy?type=residential&active=active&limit=20&page=1" \
  -H "authorization: session eyJhbGci..."

4.6.2 GET One Proxy — Single Proxy by ID

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/:id
Authorization	✅ Required

URL Parameters:

Field	Type	Required	Description
id	Number	✅	Proxy ID

Query Parameters:

Field	Type	Required	Description
type	String	✅	Proxy type (same allowed values as above)

Response 200:

Field	Type	Description
proxy	Object	Proxy object

Example:

bash
curl -X GET "https://api.gsocks.net/proxy/12345?type=residential" \
  -H "authorization: session eyJhbGci..."

4.7 GET Proxy List (Text Export)

These endpoints return a ready-to-use text list of proxies (e.g. host:port:user:pass) for importing into software.

4.7.1 Residential Proxy List by ID

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-proxy-list/:id
Authorization	✅ Required

URL Parameters:

Field	Type	Required	Description
id	Number	✅	Proxy ID

Query Parameters:

Field	Type	Required	Description
br	Boolean	No	Use HTML <br> as line separator

Response 200:

Field	Type	Description
List	String	Text proxy list

Note about domains: By default, the list uses the domain residential.gsocks.net (servers located in the USA). If you are in Europe, you can use eu.residential.gsocks.net instead. You can also use us.residential.gsocks.net, which is the same as the default domain.

Example:

bash
curl -X GET "https://api.gsocks.net/proxy/residential-proxy-list/12345" \
  -H "authorization: session eyJhbGci..."

4.7.2 Residential Proxy List by Username

Does not require authorization — accessed by the proxy list username.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-proxy-list-pseudo/:username
Authorization	Not required

URL Parameters:

Field	Type	Required	Description
username	String	✅	Proxy list username

Query Parameters:

Field	Type	Required	Description
br	Boolean	No	Use HTML <br> as line separator

Response 200:

Field	Type	Description
List	String	Text proxy list

bash
curl -X GET "https://api.gsocks.net/proxy/residential-proxy-list-pseudo/myuser123"

4.7.3 Mobile Proxy List by ID

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-proxy-list/:id
Authorization	✅ Required

URL Parameters:

Field	Type	Required	Description
id	Number	✅	Proxy ID

Query Parameters:

Field	Type	Required	Description
br	Boolean	No	Use HTML <br> as line separator

Response 200:

Field	Type	Description
List	String	Text proxy list

bash
curl -X GET "https://api.gsocks.net/proxy/mobile-proxy-list/12345" \
  -H "authorization: session eyJhbGci..."

4.7.4 Mobile Proxy List by Username

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-proxy-list-pseudo/:username
Authorization	Not required

URL Parameters:

Field	Type	Required	Description
username	String	✅	Proxy list username

Query Parameters:

Field	Type	Required	Description
br	Boolean	No	Use HTML <br> as line separator

Response 200:

Field	Type	Description
List	String	Text proxy list

bash
curl -X GET "https://api.gsocks.net/proxy/mobile-proxy-list-pseudo/myuser123"

4.9 Renew Proxy

Renewal Proxy — Extend Proxy Duration or Traffic

Parameter	Value
Method	POST
URL	https://api.gsocks.net/proxy/renewal
Authorization	✅ Required

Request Body (JSON):

Field	Type	Required	Description
type	String	✅	Proxy type. Allowed: mobile, private
volume	Number	✅	Days (for private)
ids	Number[]	✅	Array of proxy IDs to renew

Response 200:

Field	Type	Description
message	String	"Success"

Example — Renew 2 private proxies for 30 days:

bash
curl -X POST https://api.gsocks.net/proxy/renewal \
  -H "authorization: session eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "private",
    "volume": 30,
    "ids": [12345, 12346]
  }'

4.10 Traffic Logs

4.10.1 Residential Traffic Log by Username

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-traffic-log-by-username
Authorization	✅ Required

Query Parameters:

Field	Type	Required	Default	Description
username	String	✅	—	Proxy list username
period	String	No	all	Time period. Allowed values: daily, weekly, monthly, all

Response 200:

Field	Type	Description
Log	Array	Traffic log entries

bash

curl -X GET "https://api.gsocks.net/proxy/residential-traffic-log-by-username?username=myuser&period=daily" \
  -H "authorization: session eyJhbGci..."

4.10.2 Residential Traffic Log by Account

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-traffic-log-by-account
Authorization	✅ Required

Query Parameters:

Field	Type	Required	Default	Description
period	String	No	all	Time period. Allowed values: daily, weekly, monthly, all

Response 200:

Field	Type	Description
Log	Array	Traffic log entries

bash

curl -X GET "https://api.gsocks.net/proxy/residential-traffic-log-by-account?period=weekly" \
  -H "authorization: session eyJhbGci..."

4.11 Nodes Info

GET Residential Nodes Info

Returns information about residential proxy nodes.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/residential-nodes-info
Authorization	Not required

Response 200:

Field	Type	Description
nodes	Object	Residential nodes information

bash
curl -X GET https://api.gsocks.net/proxy/residential-nodes-info

GET Mobile Nodes Info

Returns information about mobile proxy nodes.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/mobile-nodes-info
Authorization	Not required

Response 200:

Field	Type	Description
nodes	Object	Residential nodes information

bash
curl -X GET https://api.gsocks.net/proxy/mobile-nodes-info

GET Datacenter Nodes Info

Returns information about datacenter proxy nodes.

Parameter	Value
Method	GET
URL	https://api.gsocks.net/proxy/datacenter-nodes-info
Authorization	Not required

Response 200:

Field	Type	Description
nodes	Object	Datacenter nodes information

bash
curl -X GET https://api.gsocks.net/proxy/datacenter-nodes-info

Quick Reference: Rotation Values

rotation Value	Behavior
request	New IP on every HTTP request
link	Change IP manually via a special link
5 through 60	Automatically rotate IP every N minutes

Quick Reference: Proxy Types and volume Meaning

Type	volume Represents	Example
residential, mobile, datacenter	Gigabytes of traffic	"volume": 5 = 5 GB
private	Rental days	"volume": 30 = 30 days

API Documentation

1. Authorization

2. Profile

2.1 GET Balance

3. Proxy

3.1 Understanding Proxy Types

3.2 Price Calculation

3.2.1 GET Final Proxy Price (with promo code)

4.3 Available Countries / Regions / Cities / ISPs

4.3.1 Private — Countries

4.3.2 Datacenter — Countries

4.3.3 Residential — Countries

4.3.4 Residential — Regions

4.3.5 Residential — Cities

4.3.6 Residential — ISPs

4.3.7 Mobile — Countries

4.3.8 Mobile — Regions

4.3.9 Mobile — Cities

4.3.10 Mobile — ISPs

4.4 Traffic Volume Management

4.4.1 Add Residential Traffic Volume

4.4.2 GET Residential Traffic Volume

4.4.3 Add Mobile Traffic Volume

4.4.4 GET Mobile Traffic Volume

4.4.5 Add Datacenter Traffic Volume

4.4.6 GET Datacenter Traffic Volume

4.5 Create Proxy

Create Proxy

4.6 GET Proxies

4.6.1 GET Some Proxies — Paginated List

4.6.2 GET One Proxy — Single Proxy by ID

4.7 GET Proxy List (Text Export)

4.7.1 Residential Proxy List by ID

4.7.2 Residential Proxy List by Username

4.7.3 Mobile Proxy List by ID

4.7.4 Mobile Proxy List by Username

4.9 Renew Proxy

Renewal Proxy — Extend Proxy Duration or Traffic

4.10 Traffic Logs

4.10.1 Residential Traffic Log by Username

4.10.2 Residential Traffic Log by Account

4.11 Nodes Info

GET Residential Nodes Info

GET Mobile Nodes Info

GET Datacenter Nodes Info

Quick Reference: Proxy Types and volume Meaning