API Documentation

section-shape

Implement our services into your products

section-icon

Introduction

Hello and welcome to the ProxyScrape API, the API can be used to download, display, get the proxy amount and last updated time in an efficient way.

Modules and libraries

Python: Our API works with the unofficial proxyscrape python module (click here)

Parameter request types

There are four types of API requests you can make, including:

getproxies

getproxies will immediately download the proxies once navigated to the URL. getproxies supports multiple parameters including:

Input: https://api.proxyscrape.com?request=getproxies&proxytype=http&timeout=5000&country=US&anonymity=elite&ssl=yes
Output: Downloads elite HTTP proxies with SSL enabled with a timeout of 5000ms located in the US in the common ip:port format.

displayproxies

displayproxies will not download the proxies instead it will display the proxies on the website. displayproxies supports multiple parameters including:

Input: https://api.proxyscrape.com?request=displayproxies&proxytype=http&timeout=7000&country=DE&anonymity=elite&ssl=no
Output: Displays elite HTTP proxies with SSL disabled with a timeout of 7000ms located in the DE in the common ip:port format.

amountproxies

amountproxies will return the amount of available proxies for the given conditions. amountproxies supports multiple parameters including:

Input: https://api.proxyscrape.com?request=amountproxies&proxytype=http&timeout=7000&country=DE&anonymity=elite&ssl=all
Output: Will return the amount of proxies for the given conditions.

lastupdated

lastupdated will return when the proxies were last updated. lastupdated only requires one parameter:

Input: https://api.proxyscrape.com?request=lastupdated&proxytype=http
Output: Will return the last update time for the given conditions, lastupdated only requires the proxytype parameter.

Parameter request type values

Parameter values are used to tell the API what kind of proxies you want.

proxytype

proxytype has 4 allowed values:

  • http
  • socks4
  • socks5
  • all

When you don't set this value the proxy type will be automatically set to 'all'.

timeout

The timeout is in milliseconds.
When no timeout is defined the timeout is automatically set to 10,000ms.

country

The country parameter can be any Alpha 2 ISO country code or 'all', the country codes can be found here.
When no country is defined the country will be automatically set to 'all'.

anonymity

anonymity has 4 allowed values:

  • elite
  • anonymous
  • transparent
  • all

When no anonymity level is defined it will be automatically set to 'all'.

ssl

SSL has 3 allowed values:

  • yes
  • no
  • all

When SSL is not defined it will be automatically set to 'all'.

limit

the limit parameter will limit the amount of proxies that get downloaded or displayed and can be any number above 0
When limit is not defined it will be automatically set to 'all'.

format

format has 2 allowed values:

  • normal
  • json

When format is not defined it will be automatically set to 'normal'.