API DOCUMENTATION

Please read the API documentation carefully before sending requests to the server. Any attempt to brute-force the server may result in temporary and then permanently banning the IP address of the senders. So please use the API in a reasonable way.

get_ss_proxy

API URL: https://api.korlabs.io/ip/get_ss_proxy

Returns a list of ShadowSocks proxies

This API gives you a list of active shadowsocks proxies.

Input Parameters

Here is the list of input parameters.

Return value

Sample output

{
    "success": true,
    "attr": [
            "dGhpc2lzbm90YXByb3h5YnV0YXNhbXBsZQ==@1.2.3.4:1234,
            "dGhpc2lzYW5vdGhlcnNhbXBsZQ==@5.6.7.8:1234
    ]
}

Example

# here is the Python3 example
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN"}
r = requests.get(url, params=params, timeout=10)
print(r.text)

whatismyip

API URL: https://api.korlabs.io/ip/whatismyip

Returns Your exposed IP address to our server

This API is useful when you wnat to know about your public IP address.

It returns the pure IP address (no JSON but text-based result)

Input Parameters

Here is the list of input parameters.

There is no input parameter for this end-point

Return value

Sample output

12.32.65.98

Example

# what is my IP address
import requests
url = ""
r = requests.get(url, timeout=10)
print(r.text)

get_proxy

API URL: https://api.korlabs.io/ip/get_proxy

Returns a list of proxies

This API gives you a list of proxies based on the input parameter (the requested proxy type).

ptype parameter can be one of the 'HTTP', 'HTTPS', 'SOCKS4', or 'SOCKS5'

Input Parameters

Here is the list of input parameters.

Return value

Sample output

{
    "success": true,
    "attr": [
            ["SOCKS5", "1.1.1.1", "8080"],
            ["SOCKS5", "2.2.2.2", "8090"],
            ["SOCKS5", "3.3.3.3", "9090"]
    ]
}

Example

# here is the Python3 example to ask for the socks5 proxy list
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN", "ptype": 'SOCKS5'}
r = requests.get(url, params=params, timeout=10)
print(r.text)

ipinfo

API URL: https://api.korlabs.io/ip/ipinfo

Returns ASN information and country-code for a given IP address

This API gives you the ASN information and the two-letter iso-code of the country for a given IP address.

The service returns AS number, AS organization name and country code for a given IP address.

Whenever the IP address is invalid, private, loopback, or we have no information about it, we return null as the response with the structure as the successful response.

Input Parameters

Here is the list of input parameters.

Return value

Sample output

{
    "ip": "94.183.247.76",
    "asn": 31549,
    "org": "Aria Shatel Company Ltd",
    "cc": "IR"
}

Example

# here is the Python3 example to ask for the info of the 94.183.247.76
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN", "ip": '94.183.247.76'}
r = requests.get(url, params=params, timeout=10)
print(r.text)