API Documentation

Table of content

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_malicious_index

API URL: https://api.korlabs.io/tld/get_malicious_index

Returns the maliciousness index of a TLD for a given date

This API gives you the maliciousness index of the TLD for a given date (optional).

If the dt parameter is not specified, the service will return the latest record for the given TLD.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API
2	tld	string	mandatory	given tld like com, net, cn
3	dt	string	dt	date in a form of yyyy-mm-dd (don't specify dt param to get the latest record)

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "success": true,
    "msg": "success",
    "code": 200,
    "attr": {
        "tld": "com",
        "dt": "2022-02-20",
        "index": "0.50"
    }
}

Example

# here is the Python3 example to get the maliciousness index  of .com TLd
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN", "tld": "com", "dt": "2022-02-20"}
r = requests.get(url, params=params, timeout=10)
print(r.text)

get_daily_domains

API URL: https://api.korlabs.io/tld/get_daily_domains

Returns statisticst about Top-Level Domains (TLDs)

This API gives you statistics about each TLD for a given date based on the action. For example, It gives you the number of deleted domains from .com zonefiles on 2022-06-19 or the number of added domains for .top TLD on 2022-07-01.

Remember that date is always 10 characters and action is always either 'd' or 'a'.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API
2	dt	string	mandatory	the specified date to get the stats e.g., 2022-06-19
3	tld	string	mandatory	The specified tld to get the stats e.g., top
4	page	integer	optional	the page number of the result (default is 0 and each page contains 100 results)
5	action	char	mandatory	action can be either 'd' for deleted domains or 'a' for added domains

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "success": true,
    "attr": [
        "urspace.ltd",
        "vial.ltd",
        "wbct.ltd",
        "wdic.ltd",
        "wpy1013.ltd",
        "xiaoliangds.ltd",
        "xiaomengxiaoba.ltd",
        "xiaoyuanbang.ltd",
        "xilizhi2021.ltd",
        "xingyaokeji027.ltd",
        "xuanxin.ltd",
        "ydedu.ltd",
        "yida-guo.ltd",
        "yuedaedu.ltd",
        "yyfood.ltd",
        "yylnewtoys.ltd",
        "yysl.ltd",
        "z168.ltd",
        "zjfc.ltd",
        "zjsp.ltd",
        "zst.ltd"
        ]
}

Example

# here is the Python3 example to ask for added .com domains on 2022-06-19
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN", "page": 0, "dt": "2022-06-19", "tld": "com", "action": "a"}
r = requests.get(url, params=params, timeout=10)
print(r.text)

get_new_gtlds

API URL: https://api.korlabs.io/tld/get_new_gtlds

Returns the full list of new gTLDs registered by ICANN

This API gives you all the information about each new gTLD registered in ICANN website.

Along with the name of the new gTLD, it serves some basic information about the TLD such as:

tld_active: If the TLD is active or not
tld_manager: The name of the registry managing that TLD
tld_type: The type of the TLD which is always newgtld in this case.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "aaa": {
    "tld_name": "aaa",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "American Automobile Association, Inc."
    },
    "aarp": {
    "tld_name": "aarp",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "AARP"
    },
    "abarth": {
    "tld_name": "abarth",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "Fiat Chrysler Automobiles N.V."
    },
    "abb": {
    "tld_name": "abb",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "ABB Ltd"
    }
}

Example

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

get_tld_dum

API URL: https://api.korlabs.io/tld/get_tld_dum

Returns the size of the given TLD

This API gives you the size of the TLDs e.g., .com, .org, .report or ccTLDs like .cn

In case of not having the size of the TLD, we will return null value.

If the dt parameter is not specified, the service will return the latest record for the given TLD.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API
2	tld	string	mandatory	given tld you want the zone file size
3	dt	string	dt	date in a form of yyyy-mm-dd (don't specify dt param to get the latest record)

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "tld": "com",
    "dt": "2022-07-15",
    "size": "159574587"
}

Example

# here is the Python3 example to get the size of .com TLd
import requests
url = ""
params = {"token": "USER-PROVIDED-TOKEN", "tld": "com", "dt": "2022-07-05"}
r = requests.get(url, params=params, timeout=10)
print(r.text)

get_cctlds

API URL: https://api.korlabs.io/tld/get_cctlds

Returns the full list of country-code TLDs registered by ICANN

This API gives you all the information about each country-code TLD registered in ICANN website.

Along with the name of the country-code TLD, it serves some basic information about the TLD such as:

tld_active: If the TLD is active or not
tld_manager: The name of the registry managing that TLD
tld_type: The type of the TLD which is always cctld in this case.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "ac": {
    "tld_name": "ac",
    "tld_type": "cctld",
    "tld_active": "active",
    "tld_manager": "Internet Computer Bureau Limited"
    },
    "ad": {
    "tld_name": "ad",
    "tld_type": "cctld",
    "tld_active": "active",
    "tld_manager": "Andorra Telecom"
    },
    "ae": {
    "tld_name": "ae",
    "tld_type": "cctld",
    "tld_active": "active",
    "tld_manager": "Telecommunications and Digital Government Regulatory Authority (TDRA)"
    }
}

Example

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

get_gtlds

API URL: https://api.korlabs.io/tld/get_gtlds

Returns the full list of generic TLDs registered by ICANN

This API gives you all the information about each generic TLD registered in ICANN website.

Along with the name of the generic TLD, it serves some basic information about the TLD such as:

tld_active: If the TLD is active or not
tld_manager: The name of the registry managing that TLD
tld_type: The type of the TLD which is always gtld in this case.

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "biz": {
    "tld_name": "biz",
    "tld_type": "gtld",
    "tld_active": "active",
    "tld_manager": "Registry Services, LLC"
    },
    "com": {
    "tld_name": "com",
    "tld_type": "gtld",
    "tld_active": "active",
    "tld_manager": "VeriSign Global Registry Services"
    },
    "info": {
    "tld_name": "info",
    "tld_type": "gtld",
    "tld_active": "active",
    "tld_manager": "Afilias Limited"
    }
}

Example

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

get_tlds

API URL: https://api.korlabs.io/tld/get_tlds

Returns the full list of all types of TLDs registered by ICANN

This API gives you all the information about each TLD registered in ICANN website.

Along with the name of the TLD, it serves some basic information about the TLD such as:

tld_active: If the TLD is active or not
tld_manager: The name of the registry managing that TLD
tld_type: The type of the TLD which can be:
- cctld: country-code TLD
- newgtld: new generic TLD
- gtld: generic TLD
- infrastructure: currently only .arpa
- test: for testing
- sponsored: sponsored (community-specific) TLD

Input Parameters

Here is the list of input parameters.

#	Name	Type	Presence	Description
1	token	string	mandatory	user-provided token in order to access the API

Return value

Return Type: JSON

Description: Either the result of the request or the appropriate error message

Sample output

{
    "mma": {
    "tld_name": "mma",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "MMA IARD"
    },
    "mn": {
    "tld_name": "mn",
    "tld_type": "cctld",
    "tld_active": "active",
    "tld_manager": "Datacom Co., Ltd."
    },
    "mobi": {
    "tld_name": "mobi",
    "tld_type": "gtld",
    "tld_active": "active",
    "tld_manager": "Afilias Limited"
    },
    "mobile": {
    "tld_name": "mobile",
    "tld_type": "newgtld",
    "tld_active": "active",
    "tld_manager": "Dish DBS Corporation"
    }
}

Example

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