PROXY6_API_DOCS.json

{
  "api": {
    "base_url": "https://px6.link/api/{api_key}/{method}/?{params}",
    "rate_limit": {
      "requests": 3,
      "period": "1 second",
      "error_code": 429
    },
    "encoding": "UTF-8"
  },
  "proxy_versions": {
    "4": "IPv4",
    "3": "IPv4 Shared",
    "6": "IPv6"
  },
  "proxy_types": {
    "http": "HTTPS",
    "socks": "SOCKS5"
  },
  "methods": {
    "getprice": {
      "description": "Получение информации о сумме заказа",
      "required_params": ["count", "period", "version"],
      "example": "https://px6.link/api/{api_key}/getprice?count=100&period=30&version=6",
      "response_fields": {
        "price": "Итоговая стоимость",
        "price_single": "Стоимость одного прокси",
        "period": "Запрошенный период (дней)",
        "count": "Запрошенное кол-во прокси"
      }
    },
    "getcount": {
      "description": "Получение доступного кол-ва прокси для страны",
      "required_params": ["country", "version"],
      "example": "https://px6.link/api/{api_key}/getcount?country=ru&version=6",
      "response_fields": {
        "count": "Доступное кол-во"
      }
    },
    "getcountry": {
      "description": "Получение списка доступных стран",
      "required_params": ["version"],
      "example": "https://px6.link/api/{api_key}/getcountry?version=4",
      "response_fields": {
        "list": "Массив стран в формате iso2"
      }
    },
    "getproxy": {
      "description": "Получение списка ваших прокси",
      "optional_params": {
        "state": "active|expired|expiring|all (default)",
        "descr": "Фильтр по техническому комментарию",
        "nokey": "Без ключей в ответе",
        "page": "Номер страницы (default: 1)",
        "limit": "Кол-во прокси (default: 1000, max: 1000)"
      },
      "response_fields": {
        "list_count": "Кол-во прокси на странице",
        "list": "Массив прокси с полями: id, ip, host, port, user, pass, type, country, date, date_end, descr, active"
      }
    },
    "settype": {
      "description": "Изменение типа (протокола) прокси",
      "required_params": ["ids", "type"],
      "example": "https://px6.link/api/{api_key}/settype?ids=10,11,12,15&type=socks",
      "notes": "Ошибка 30 если все прокси уже имеют указанный тип"
    },
    "setdescr": {
      "description": "Обновление технического комментария",
      "required_params": ["new"],
      "optional_params": {
        "old": "Старый комментарий",
        "ids": "Список ID прокси"
      },
      "notes": "Макс. длина комментария 50 символов. Обязательно old или ids",
      "response_fields": {
        "count": "Кол-во прокси с изменённым комментарием"
      }
    },
    "buy": {
      "description": "Покупка прокси",
      "required_params": ["count", "period", "country", "version"],
      "optional_params": {
        "type": "http (default) | socks",
        "descr": "Тех. комментарий (макс. 50 симв.)",
        "auto_prolong": "Включить автопродление",
        "nokey": "Без ключей в ответе"
      },
      "example": "https://px6.link/api/{api_key}/buy?count=1&period=7&country=ru&version=6",
      "response_fields": {
        "order_id": "Номер заказа",
        "count": "Кол-во прокси",
        "price": "Итоговая стоимость",
        "price_single": "Стоимость одного прокси",
        "period": "Период (дней)",
        "country": "Страна (iso2)",
        "list": "Массив купленных прокси"
      }
    },
    "prolong": {
      "description": "Продление прокси",
      "required_params": ["period", "ids"],
      "optional_params": {
        "nokey": "Без ключей в ответе"
      },
      "example": "https://px6.link/api/{api_key}/prolong?period=7&ids=15,16",
      "response_fields": {
        "order_id": "Номер заказа",
        "price": "Итоговая стоимость",
        "price_single": "Стоимость одного прокси",
        "period": "Период (дней)",
        "count": "Кол-во успешных продлений",
        "list": "Массив продленных прокси с date_end"
      }
    },
    "delete": {
      "description": "Удаление прокси",
      "required_params": "ids или descr (один из)",
      "example": "https://px6.link/api/{api_key}/delete?ids=15,16",
      "response_fields": {
        "count": "Кол-во удалённых прокси"
      }
    },
    "check": {
      "description": "Проверка валидности прокси",
      "required_params": "ids или proxy (один из)",
      "examples": [
        "https://px6.link/api/{api_key}/check?ids=15",
        "https://px6.link/api/{api_key}/check?proxy=192.168.1.1:8000:user:pass"
      ],
      "response_fields": {
        "proxy_id": "Внутренний номер прокси",
        "proxy_status": "true | false"
      }
    },
    "ipauth": {
      "description": "Привязка/удаление авторизации по IP",
      "required_params": ["ip"],
      "example": "https://px6.link/api/{api_key}/ipauth?ip=45.155.202.18,31.121.11.123",
      "notes": "ip='delete' для удаления привязки"
    }
  },
  "errors": {
    "30": "Error unknown - Неизвестная ошибка",
    "100": "Error key - Ошибка авторизации, неверный ключ",
    "105": "Error ip - Неверный IP или формат",
    "110": "Error method - Ошибочный метод",
    "200": "Error count - Ошибка кол-ва прокси",
    "210": "Error period - Ошибка периода",
    "220": "Error country - Ошибка страны",
    "230": "Error ids - Ошибка списка ID",
    "240": "Error version - Некорректная версия прокси",
    "250": "Error descr - Ошибка тех. комментария",
    "260": "Error type - Ошибка типа прокси",
    "270": "Error port - Ошибка порта",
    "280": "Error proxy str - Ошибка строки прокси",
    "300": "Error active proxy allow - Недоступно кол-во прокси",
    "400": "Error no money - Недостаточно средств",
    "404": "Error not found - Элемент не найден",
    "410": "Error price - Ошибка расчёта стоимости"
  },
  "response_format": {
    "success": {
      "status": "yes",
      "user_id": "Номер аккаунта",
      "balance": "Баланс",
      "currency": "RUB | USD"
    },
    "error": {
      "status": "no",
      "error_id": "Код ошибки",
      "error": "Описание"
    }
  }
}