The Oculus Proxies API provides an efficient way for users to configure and access proxy details aligned with their selected plans. Each plan has unique parameter requirements to ensure successful requests. The API is designed with simplicity in mind, accessible via a single endpoint where users can submit their desired configurations in a structured JSON format for seamless operation. Endpoint
CURL
POST https://api.oculusproxies.com/v1/configure/proxy/getProxies
Headers
  • authToken (string, required): your unique API authentication token. This must be included in all requests.
  • Content-Type: set to application/json.
Request Parameters Each request should include the following JSON body parameters. Note that required fields may vary based on the plan type:
ParameterTypeDescription
orderTokenstringA unique token linked to the user’s order.
countrystringThe country for which proxies are requested (e.g., “US”).
numberOfProxiesintegerSpecifies the number of proxies requested, if applicable.
whiteListIParray of stringsA list of IP addresses to be whitelisted for proxy access.
enableSock5booleanSet to true to enable SOCKS5 proxy support.
planTypestringIndicates the type of plan. Options include: DEDICATED_DC, ISP, ISP_PREMIUM, SHARED_DC, RESIDENTIAL_SCRAPER.

​
Plan Types and Request Details

Each plan type has unique parameter requirements. Below is an overview of the specific parameters needed for each plan type, along with examples to help guide your configuration requests.

​
Dedicated Datacenter

The Dedicated Datacenter (DEDICATED_DC) plan offers exclusive access to data center proxies for optimized performance and reliability. The following parameters are required for this plan type: orderToken, whiteListIP, enableSock5, country Example Request: 
curl --location 'https://api.oculusproxies.com/v1/configure/proxy/getProxies' \
--header 'authToken: YOUR_AUTH_TOKEN'
--header 'Content-Type: application/json'
--data '{
    "orderToken": "oc_b111111",
    "country": "US",
    "whiteListIP": ["1.1.1.1"],
    "enableSock5": false,
    "planType": "DEDICATED_DC"
}'

​
ISP

The ISP plan provides residential proxies sourced from Internet Service Providers, supporting configurable IPs and SOCKS5 capabilities. The following parameters are required for this plan type: orderToken, whiteListIP, numberOfProxies, enableSock5, country Example Request: 
curl --location 'https://api.oculusproxies.com/v1/configure/proxy/getProxies' \
--header 'authToken: YOUR_AUTH_TOKEN'
--header 'Content-Type: application/json'
--data '{
    "orderToken": "oc_b111111",
    "country": "US",
    "numberOfProxies": 5,
    "whiteListIP": ["1.1.1.1"],
    "enableSock5": true,
    "planType": "ISP"
}'

​
Shared Datacenter

The Shared Datacenter (SHARED_DC) plan offers cost-effective proxy solutions that are shared among multiple users. The following parameters are required for this plan type: orderToken, whiteListIP, numberOfProxies, enableSock5, country Example Request: 
curl --location 'https://api.oculusproxies.com/v1/configure/proxy/getProxies' \
--header 'authToken: YOUR_AUTH_TOKEN'
--header 'Content-Type: application/json'
--data '{
    "orderToken": "oc_b111111",
    "country": "US",
    "numberOfProxies": 10,
    "whiteListIP": ["1.1.1.1"],
    "enableSock5": false,
    "planType": "SHARED_DC"
}'

​
Residential Rotating

The Residential Rotating (RESIDENTIAL_SCRAPER) plan grants access to residential IPs optimized for web scraping tasks. The following parameters are required for this plan type: orderToken, whiteListIP, numberOfProxies, enableSock5, country Example Request: 
curl --location 'https://api.oculusproxies.com/v1/configure/proxy/getProxies' \
--header 'authToken: YOUR_AUTH_TOKEN'
--header 'Content-Type: application/json'
--data '{
    "orderToken": "oc_b111111",
    "country": "US",
    "numberOfProxies": 20,
    "whiteListIP": ["1.1.1.1"],
    "enableSock5": true,
    "planType": "RESIDENTIAL_SCRAPER"
}'

​
Response Format

Upon a successful request, the API response will return proxy configuration details, including:
  • proxies: A list of proxy IPs generated based on your request parameters.
Example Response:
JSON
[
    "192.0.2.1:8080:login:password",
    "192.0.2.2:8080:login:password"
]

​
Error Handling

The API uses HTTP status codes to indicate request outcomes:
  • 200 OK: Request completed successfully.
  • 400 Bad Request: Some parameters are missing or invalid.
  • 403 Forbidden: Authentication token is either invalid or missing.
  • 500 Internal Server Error: An issue occurred on the server side.
Make sure all required fields are accurately provided according to the chosen plan type to minimize errors.