Create IP list

POST https://geonix.com/personal/api/v1/{apiKey}/resident/list

This endpoint lets you make a new IP list for your residential proxy package. With it, you can organize your proxies by location or use case. Once you create a list, you can easily manage or download it.

To specify parameter values, download the Geo zip file. This includes geo.json with all available geographic locations and ISPs for customizing your IP list criteria.

Headers

Name

Value

application/json

Content-Type

application/json

Path parameters

Name

Type

Description

apiKey*

string

API key to authorize requests

Body parameters

Name

Type

Description

title*

string

The desired name for the new IP list.

whitelist

string

A comma-separated list of IPs for whitelist authentication. (note: an IP can be added only once and is shared across all lists. Attempting to add an IP that is already whitelisted will result in an error).

geo*

object

Defines the geographical and ISP criteria for the IP list.

country

string

Country code (Alpha-2).

region

string

Specific region within the country.

city

string

Specific city within the region.

isp

string

Target specific ISP.

export*

object

Export options for the list.

ports

integer

Number of ports.

ext

string

File extension (txt/csv) or custom format ["%login% | %password% @ %ip%:%port% - %protocol%"].

Request examples

curl -X 'POST' \
  'https://geonix.com/personal/api/v1/YOUR_API_KEY/resident/list' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "US Washington Garfield FIRST-STEP",
  "whitelist": "127.0.0.1,192.168.0.1",
  "geo": {
    "country": "US",
    "region": "Washington",
    "city": "Garfield",
    "isp": "FIRST-STEP"
  },
  "export": {
    "ports": 1000,
    "ext": "txt"
  }
}'

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://geonix.com/personal/api/v1/YOUR_API_KEY/resident/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "title": "US Washington Garfield FIRST-STEP",
  "whitelist": "127.0.0.1,192.168.0.1",
  "geo": {
    "country": "US",
    "region": "Washington",
    "city": "Garfield",
    "isp": "FIRST-STEP"
  },
  "export": {
    "ports": 1000,
    "ext": "txt"
  }
}',
  CURLOPT_HTTPHEADER => array(
    'accept: application/json',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class CreateOrderExample {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://geonix.com/personal/api/v1/YOUR_API_KEY_HERE/order/make");
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("accept", "application/json");
            conn.setRequestProperty("Content-Type", "application/json");
            conn.setDoOutput(true);

            String input = "{\"coupon\": \"OZGCNK_1\",\"countryId\": 3350393,\"periodId\": \"30d\",\"quantity\": 5,\"authorization\": \"127.0.0.1\",\"targetSectionId\": 99,\"targetId\": 0,\"customTargetName\": \"Another target\"}";

            try (OutputStream os = conn.getOutputStream()) {
                byte[] inputBytes = input.getBytes("utf-8");
                os.write(inputBytes, 0, inputBytes.length);
            }

            BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream()));
            String output;
            while ((output = br.readLine()) != null) {
                System.out.println(output);
            }

            conn.disconnect();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Response examples

{
  "status": "success",
  "data": {
    "id": 3350393,
    "title": "US Washington Garfield FIRST-STEP",
    "login": "3c8aa1d4",
    "password": "AZT62Dx3",
    "whitelist": "127.0.0.1,192.168.0.1",
    "rotation": "-1 = rotation, 0 = rotation per request, 1..60 time in seconds",
    "geo": [
      {
        "country": "US",
        "region": "Washington",
        "city": "Garfield",
        "isp": "FIRST-STEP"
      }
    ],
    "export": {
      "ports": 1000,
      "ext": "txt"
    }
  },
  "errors": []
}

PreviousResidential proxies NextGet IP lists

Last updated 8 months ago

hashtagHeaders

hashtagPath parameters

hashtagBody parameters

hashtagRequest examples

hashtagResponse examples

Headers

Path parameters

Body parameters

Request examples

Response examples