nTLDStats API¶
The NTLDStats API enables your own application to interact with our website. The following pages list the resources that our API provides.
Documentation Format¶
Each API method you can call is in the following format:
[METHOD] [PATH]
Arguments
[ARG1]: [DESCRIPTION] (required) [ARG2]: [DESCRIPTION] Response
[ARG1]: [DESCRIPTION]
Where METHOD is POST/GET/PUT… and PATH is the path relative to the endpoint.
Resources¶
Overview¶
nTLDstats.com API beta¶
1. What is this beta about? In this beta we will give interested parties the opportunity to check out our new API. All data displayed on our website will be accessible through it, without limitations like rate limits, etc.
2. How long will the beta be available? Unfortunately, we don’t know yet. We will, though, send a 2 weeks notice prior to shutdown of the beta API to every participant.
3. What should I do if I encounter an error / something is not working? Please give us as much information as possible related to the error you ran into. Send those informations to mail@ntldstats.com and we will get back to you as soon as possible.
Request API beta Access: https://ntldstats.com/signup
Request Format¶
The base URL for all API resources is http://api.ntldstats.net/. All data is sent as JSON. All arguments must be send JSON encoded by POST.
Example¶
POST /domains/create
Content-Type: application/json
{"domain":"test.guru","iana_id":1,"registration_date":"2014-01-01T03:10:00Z","registrant_handle":"ABC-1234567","nameservers":["ns1.example.com","ns2.example.com"]}
Response Format¶
Status codes are used properly. If you get a 200 response, you can expect the normal response body as documented. Otherwise the response body will contain a plain text error message.
For example, if you don’t include the Authorization header, you will get a 401 UNAUTHORIZED status code.
Standard Response Fields¶
All response have at least a code and a msg field. Calls which return additional data will return a resData field.
Successful call response example:
{
"code": 1000,
"msg": "Command completed successfully"
}
The returned MIME type from requests is always
application/json
All result codes base on RFC5730 (Extensible Provisioning Protocol, EPP)
Authentication¶
You need a valid API Token to use our API. Please sign in to the dashboard and generate a new token if you haven’t done it by now.
The API needs you to provide the API Token either as HTTP Header X-API-TOKEN or as HTTP Basic Authenticate username on every request. It is also possible to post it as URL parameter token append to every endpoint.
Errors¶
All error responses are being delivered in following format, with the corresponding status code:
{
"code": 2003,
"msg": "Required parameter missing",
"resData": {
"elem": "domains"
}
}
Login¶
Domains¶
Post a new domain¶
Command¶
POST /domains/create
- Arguments
domain: domain name to create iana_id: registrar IANA id registration_date: date of registration registrant_handle: handle of registrant of domain (optional) nameservers: list of nameservers - Response
total: number of domains added job_id: id of created job
Example¶
Request
POST /domains/create
{
"domain": "test.guru",
"iana_id": 0001,
"registration_date": "2014-01-01T03:10:00Z",
"registrant_handle": "ABC-1234567",
"nameservers": [
"ns1.example.com",
"ns2.example.com"
]
}
Response
{
"resData": {
"total": 1,
"job_id": "7635318e-8f50-510c-b2a2-27de5cc691f1"
},
"code": 1001,
"msg": "Command completed successfully; action pending"
}
Upload file with multiple domains¶
Command¶
PUT|POST /domains
- Arguments
- – None
- Response
total: number of domains added job_id: id of created job
To post multiple domains in one request, you can simply send all data as CSV, where each field is separated by a ;.
Example¶
- ::
- xn–domainname.tld;1;2014-02-01T23:00.00Z;ABC1234;NS1.EXAMPLE.COM;NS2.EXAMPLE.COM
This file could be send by either POST Request (Default HTTP file upload, field named ‘domains’) or PUT Request (file content as request payload).
Jobs¶
List pending jobs¶
Return list of all pending jobs for your user
Command¶
GET /jobs
- Arguments
- – None
- Response
jobs: List of all jobs - Job Item
status: Status of job. Could be either Unprocessed, Processing, Error or Finished job_id: ID of job added: DateTime when item got added
Example¶
Request
GET /jobs
Response
{
"code": 1000,
"msg":"Command completed successfully",
"resData": {
"jobs": [
{
"status": "Unprocessed",
"job_id": "a15e98ca-17f5-56cc-b654-4661013749e6",
"added": "2014-04-17T00:40:00Z"
}
]
}
}
Get job details¶
Command¶
GET /jobs/<jobid>
Arguments
– None
Response
status: Status of job. Could be either Unprocessed, Processing, Error or Finished job_id: ID of job added: DateTime when item got added
Example¶
Request
GET /jobs/a15e98ca-17f5-56cc-b654-4661013749e6
Response
{
"code": 1000,
"msg":"Command completed successfully",
"resData": {
"status": "Unprocessed",
"job_id": "a15e98ca-17f5-56cc-b654-4661013749e6",
"added": "2014-04-17T00:40:00Z"
}
}
Statistic Information¶
All calls to /stats/ endpoint only work with a beta API account.
TLDs Statistic¶
Command¶
GET /stats/tlds
- Arguments
limit: limit result to X tlds - default 30 details: if true, result contains details - Response
tlds: list of TLD objects sort by domain_count descendering stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language registry: Registry object backend: Backend object current_stage: name of current stage total_domains: total count of registered domains in this TLD registrars: list of Registrars objects (only on detailed listing) total_registrars: total count of registrars (only on detailed listing) - Registry Object
id: id of Registry name: name of Registry url: url of Registry - Backend Object
id: id of Backend name: name of Backend url: url of Backend - Registrar Object
id: id of Registrar iana_id: registrar IANA id name: name of Registrar url: homepage of Registrar registrar_group: Registrar Group object domain_count: total registered domains - Registrar Group Object
name: name of Registrar Group url: homepage of Registrar Group
Example¶
Request
GET /stats/tlds
Response
{
"resData": {
"tlds": {
"xyz": {
"zone": "xyz",
"zone_utf8": "xyz",
"registry": {
"name": "XYZ.COM LLC",
"id": "XYZCOM-LLC",
"info_url": "http:\/\/ntldstats.com\/registry\/XYZCOM-LLC",
"url": "http:\/\/nic.xyz"
},
"backend": {
"name": "CentralNic",
"id": "CentralNic",
"info_url": "http:\/\/ntldstats.com\/backend\/CentralNic",
"url": "http:\/\/www.centralnic.com"
},
"current_stage": "GA",
"total_domains": 704262
}
},
"stats": {
"total_domains": 3097027,
"total_tlds": 430
}
},
"code": 1000,
"msg":"Command completed successfully",
}
Sample Link: https://beta.api.ntldstats.net/stats/tlds
TLD Statistic¶
Command¶
GET /stats/tld/<zone>
- Arguments
limit: limit result of registrars - Response
tld: TLD Object stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language registry: Registry object backend: Backend object current_stage: name of current stage total_domains: total count of registered domains in this TLD total_registrars: total count of registrars registrars: list of Registrars objects - Registry Object
id: id of Registry name: name of Registry info_url: public nTLDStats URL to get more information about Registry url: url of Registry - Backend Object
id: id of Backend name: name of Backend info_url: public nTLDStats URL to get more information about Backend url: url of Backend - Registrar Object
id: id of Registrar iana_id: registrar IANA id name: name of Registrar url: homepage of Registrar registrar_group: Registrar Group object domain_count: total registered domains - Registrar Group Object
name: name of Registrar Group url: homepage of Registrar Group
Example¶
Request
GET /stats/tld/berlin
Response
{
"resData": {
"tld": {
"zone": "berlin",
"zone_utf8": "berlin",
"registry": {
"id": "dotBERLIN-GmbH-Co-KG",
"name": "dotBERLIN GmbH & Co. KG",
"url": "http:\/\/nic.berlin"
},
"backend": {
"id": "TLDBOX-Registrydienstleistungen-GmbH",
"name": "TLD-BOX Registrydienstleistungen GmbH",
"url": "http:\/\/www.tld-box.at"
},
"total_domains": 153742,
"total_registrars": 45,
"registrars": [{
"iana_id": "151",
"name": "PSI-USA, Inc. dba Domain Robot",
"url": "http:\/\/www.psi-usa.info",
"registrar_group": {
"name": "InterNetX GmbH",
"url": null
},
"domain_count": 92056
}],
"current_stage": "GA"
},
"stats": {
"total_domains": 3111803,
"total_tlds": 431
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/tld/berlin
Registrars Statistic¶
Command¶
GET /stats/registrars
- Arguments
limit: limit result to X tlds - default 30 details: if true, result contains details - Response
registrars: list of Registrar Objects stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Registrar Object
id: id of Registrar iana_id: registrar IANA id name: name of Registrar url: homepage of Registrar registrar_group: Registrar Group object total_domains: total registered domains tlds: list of TLD objects (only on detailed listing) total_tlds: total count of TLDs (only on detailed listing) - Registrar Group Object
name: name of Registrar Group url: homepage of Registrar Group - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/registrars
Response
{
"resData": {
"stats": {
"total_domains": 3111803,
"total_tlds": 431
},
"registrars": [{
"id": "146",
"iana_id": "146",
"name": "GoDaddy.com, LLC",
"url": "http:\/\/www.godaddy.com",
"registrar_group": {
"name": "GoDaddy Group",
"url": "http:\/\/godaddy.com\/"
},
"total_domains": 490765
}]
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/registrars
Registrar Statistic¶
Command¶
GET /stats/registrar/<iana_id>
- Arguments
limit: limit result of tlds - Response
registrar: Registrar Object stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Registrar Object
id: id of Registrar iana_id: registrar IANA id name: name of Registrar url: homepage of Registrar registrar_group: Registrar Group object total_domains: total registered domains total_tlds: total count of TLDs tlds: list of TLD objects - Registrar Group Object
name: name of Registrar Group url: homepage of Registrar Group - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/registrar/146
Response
{
"resData": {
"registrar": {
"id": "146",
"iana_id": "146",
"name": "GoDaddy.com, LLC",
"url": "http:\/\/www.godaddy.com",
"registrar_group": {
"name": "GoDaddy Group",
"url": "http:\/\/godaddy.com\/"
},
"total_domains": 490765,
"total_tlds": 220,
"tlds": [{
"zone": "guru",
"zone_utf8": "guru",
"domain_count": 44201,
"current_stage": "GA"
}]
},
"stats": {
"total_domains": 3111803,
"total_tlds": 431
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/registrar/146
Backends Statistic¶
Command¶
GET /stats/backends
- Arguments
limit: limit result to X tlds - default 30 details: if true, result contains details - Response
backends: list of Backend Objects stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Backend Object
id: id of Backend name: name of Backend url: homepage of Backend total_domains: total registered domains tlds: list of TLD objects (only on detailed listing) total_tlds: total count of TLDs (only on detailed listing) - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/backends
Response
{
"resData": {
"stats": {
"total_domains": 3111803,
"total_tlds": 431
},
"backends": [{
"id": "Donuts-Inc",
"name": "Donuts Inc.",
"url": "http:\/\/www.donuts.co",
"total_domains": 1050611
}]
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/backends
Backend Statistic¶
Command¶
GET /stats/backend/<id>
- Arguments
limit: limit result of tlds - Response
backend: Backend Object stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Backend Object
id: id of Backend name: name of Backend url: homepage of Backend total_domains: total registered domains tlds: list of TLD objects total_tlds: total count of TLDs - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/backend/Donuts-Inc
Response
{
"resData": {
"backend": {
"id": "Donuts-Inc",
"name": "Donuts Inc.",
"url": "http:\/\/www.donuts.co",
"total_domains": 1050611,
"total_tlds": 152,
"tlds": [{
"zone": "guru",
"zone_utf8": "guru",
"domain_count": 75685,
"current_stage": "GA"
}]
},
"stats": {
"total_domains": 3111803,
"total_tlds": 431
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/backend/Donuts-Inc
Registries Statistic¶
Command¶
GET /stats/registries
- Arguments
limit: limit result to X tlds - default 30 details: if true, result contains details - Response
registries: list of Registry Objects stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Registry Object
id: id of Registry name: name of Registry url: homepage of Registry total_domains: total registered domains tlds: list of TLD objects (only on detailed listing) total_tlds: total count of TLDs (only on detailed listing) - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/registries
Response
{
"resData": {
"stats": {
"total_domains": 3111803,
"total_tlds": 431
},
"registries": [{
"id": "XYZCOM-LLC",
"name": "XYZ.COM LLC",
"url": "http:\/\/nic.xyz",
"total_domains": 706635
}]
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/registries
Registry Statistic¶
Command¶
GET /stats/registry/<id>
- Arguments
limit: limit result of tlds - Response
registry: Registry Object stats: total stats object - Total Stats Object
total_domains: total count of registered domains total_tlds: total count of tlds - Registry Object
id: id of Registry name: name of Registry url: homepage of Registry total_domains: total registered domains tlds: list of TLD objects total_tlds: total count of TLDs - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language current_stage: name of current stage domain_count: total count of registered domains in this TLD
Example¶
Request
GET /stats/registry/XYZCOM-LLC
Response
{
"resData": {
"registry": {
"id": "XYZCOM-LLC",
"name": "XYZ.COM LLC",
"url": "http:\/\/nic.xyz",
"total_domains": 706635,
"total_tlds": 2,
"tlds": [{
"zone": "xyz",
"zone_utf8": "xyz",
"domain_count": 706634,
"current_stage": "GA"
}]
},
"stats": {
"total_domains": 3111803,
"total_tlds": 431
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/registry/XYZCOM-LLC
Parking Statistics by TLD¶
Command¶
GET /stats/parking/tlds
- Arguments
- – None
- Response
stats: Global Statistic object tlds: list of TLD objects - Global Statistic Object
total_domains: total count of registered domains total_tlds: total count of tlds parking_domains: total count of parking domains no_ns: total count of domains without nameservers parking_ns: total count of domains with parking nameservers no_record: total count of domains without A record parking_ip: total count of domains with parking IP private_ip: total count of domains resolving to private IPs parking_check: total count of domains returning parking websites http_error: total count of domains with HTTP errors redirect: total count of domains returning redirect code - Statistic Object
parking_domains: total count of parking domains no_ns: total count of domains without nameservers parking_ns: total count of domains with parking nameservers no_record: total count of domains without A record parking_ip: total count of domains with parking IP private_ip: total count of domains resolving to private IPs parking_check: total count of domains returning parking websites http_error: total count of domains with HTTP errors redirect: total count of domains returning redirect code - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language domain_count: total count of registered domains in this TLD stats: Statistic Object
Example¶
Request
GET /stats/parking/tlds
Response
{
"resData": {
"stats": {
"total_tlds": 431,
"total_domains": 3111803,
"parking_domains": 2056544,
"no_ns": 11660,
"parking_ns": 231350,
"no_record": 486538,
"parking_ip": 97615,
"private_ip": 7198,
"parking_check": 1222183,
"http_error": 290152,
"redirect": 281672
},
"tlds": [{
"zone": "xyz",
"zone_utf8": "xyz",
"total_domains": 709096,
"stats": {
"parking_domains": 485117,
"no_ns": 3356,
"parking_ns": 6015,
"no_record": 68129,
"parking_ip": 4329,
"private_ip": 3496,
"parking_check": 399792,
"http_error": 105986,
"redirect": 20461
}
}],
"code": 1000,
"msg":"Command completed successfully",
}
}
Sample Link: https://beta.api.ntldstats.net/stats/parking/tlds
Parking Statistics by Registrar¶
Command¶
GET /stats/parking/registrars
- Arguments
- – None
- Response
stats: Global Statistic object registrars: list of Registrar objects - Global Statistic Object
total_domains: total count of registered domains total_tlds: total count of tlds parking_domains: total count of parking domains no_ns: total count of domains without nameservers parking_ns: total count of domains with parking nameservers no_record: total count of domains without A record parking_ip: total count of domains with parking IP private_ip: total count of domains resolving to private IPs parking_check: total count of domains returning parking websites http_error: total count of domains with HTTP errors redirect: total count of domains returning redirect code - Statistic Object
parking_domains: total count of parking domains no_ns: total count of domains without nameservers parking_ns: total count of domains with parking nameservers no_record: total count of domains without A record parking_ip: total count of domains with parking IP private_ip: total count of domains resolving to private IPs parking_check: total count of domains returning parking websites http_error: total count of domains with HTTP errors redirect: total count of domains returning redirect code - Registrar Object
id: id of Registrar iana_id: registrar IANA id name: name of Registrar url: homepage of Registrar registrar_group: Registrar Group object total_domains: total registered domains stats: Statistic object - Registrar Group Object
name: name of Registrar Group url: homepage of Registrar Group
Example¶
Request
GET /stats/parking/registrars
Response
{
"resData": {
"stats": {
"total_tlds": 431,
"total_domains": 3111803,
"parking_domains": 2056544,
"no_ns": 11660,
"parking_ns": 231350,
"no_record": 486538,
"parking_ip": 97615,
"private_ip": 7198,
"parking_check": 1222183,
"http_error": 290152,
"redirect": 281672
},
"registrars": [{
"total_domains": 413708,
"id": "2-Network-Solutions-LLC",
"iana_id": "2",
"name": "Network Solutions, LLC",
"registrar_group": {
"name": "Web.com",
"url": "https:\/\/www.web.com\/"
},
"stats": {
"parking_domains": 397980,
"no_ns": 37,
"parking_ns": 145,
"no_record": 16088,
"parking_ip": 6,
"private_ip": 28,
"parking_check": 381676,
"http_error": 11376,
"redirect": 2953
}
}],
"code": 1000,
"msg":"Command completed successfully",
}
}
Sample Link: https://beta.api.ntldstats.net/stats/parking/registrars
Fraud Statistics¶
Command¶
GET /stats/fraud
- Arguments
limit: limit result to X items - default 1000 details: if true, result contains items list no_nameserver: default true, skip entries without nameservers no_dns_hold: default true, skip entries with dns hold flag has_dns_record: default true, skip entries without dns records no_resolving_ns: default true, skip entries with “non-resolver-nameserver” tld: limit result for specific TLD - Response
stats: Global Statistic object lists: list of Blacklist List objects tlds: list of TLD Statistic objecs items: list of Blacklist Entry objects (optional) - Global Statistic Object
total_domains: total count of registered domains total_tlds: total count of tlds total_fraud_domains: total count of suspicious domains total_dnsbl_domains: total count of domains in dnsbl lists total_dnsbl_lists: total count of dnsbl lists total_gsb_domains: total count of domains in gsb lists total_gsb_lists: total count of gsb lists - TLD Statistic Object
count: total count ot suspicious domains zone: name of tld, idn encoded zone_utf8: name of tld in native language - Blacklist List Object
id: id of blacklist item name: name of blacklist name_short: shorter version of name url: url of blacklist dnshost: blacklist hostname (optional) total_active_records: total count of suspicious domains (optional) - Blacklist Entry Object
created: date entry added to database domain_name: name of domain, idn encoded domain_name_utf8: name of domain in native language tld: name of tld, idn encoded tld_utf8: name of tld in nativ language country: iso country code owner contact lists: list of Blacklist List Object additional_info: additional infos returned by blacklist additional_link: additional link returned by blacklist has_nameserver: domain has linked nameservers has_dns_hold: dns hold flag is set for domain has_dns_record: domain nameserver answered with valid A record scan: Scan Object - Scan Object
date: date of scan perm_url: url of scan result infected: count of positive scan results total: total count of scanners results: list of Scan Result Object - Scan Result Object
name: name of product manufacturer: name of manufacturer url: url of product/manufacturer
Example¶
Request
GET /stats/fraud
Response
{
"resData": {
"stats": {
"total_domains": 3631218,
"total_tlds": 436,
"total_fraud_domains": 1696,
"total_dnsbl_domains": 2,
"total_dnsbl_lists": 29,
"total_gsb_domains": 2,
"total_gsb_lists": 4
},
"lists": {
"dnsbl": [{
"id": 328,
"name": "abuse.ch ZeuS Tracker Domain",
"name_short": "abuse.ch (ZeuS)",
"url": "https:\/\/zeustracker.abuse.ch\/",
"dnshost": "uribl.zeustracker.abuse.ch",
"total_active_records": 0
}],
"gsb": [{
"id": 1,
"name": "Google Safe Browsing Phishing",
"name_short": "Phishing",
"url": "https:\/\/developers.google.com\/safe-browsing\/safebrowsing_faq",
"total_active_records": 15
}]
},
"tlds": [{
"count": 806,
"zone": "link",
"zone_utf8": "link"
}],
"items": {
"dnsbl": [{
"created": "2014-12-27T08:02:33Z",
"additional_info": "",
"domain_name": "kino",
"tld": "menu",
"country": "CA",
"domain_name_utf8": "kino",
"tld_utf8": "menu",
"lists": [{
"name": "Spamhaus DBL Domain Block List",
"url": "http:\/\/www.spamhaus.org\/dbl\/",
"id": 575
}],
"scan": {
"date": "2015-02-13T13:34:32Z",
"perm_url": "https:\/\/www.virustotal.com\/url\/f67ff04ccb199e86bcf6804df47a931986298fd59bda5baf39bdb7b3bee21b36\/analysis\/1423834472\/",
"infected": "0",
"total": "62",
"results": []
}
"additional_link": "http:\/\/www.spamhaus.org\/query\/dbl?domain=kino.menu",
"has_nameserver": true,
"has_dns_hold": false,
"has_dns_record": true
}],
"gsb": [{
"created": "2014-12-28T04:21:10Z",
"additional_info": "",
"domain_name": "starradio",
"tld": "london",
"country": "GB",
"domain_name_utf8": "starradio",
"tld_utf8": "london",
"lists": [{
"name": "Google Safe Browsing Malware",
"url": "https:\/\/developers.google.com\/safe-browsing\/safebrowsing_faq",
"id": 2
}],
"scan": {
"date": "2015-02-13T11:31:14Z",
"perm_url": "https:\/\/www.virustotal.com\/url\/c3b1649f5cf4723ce80199e2a1673a63c87df9992a06c66689b8a26e5a9302cb\/analysis\/1423827074\/",
"infected": "1",
"total": "62",
"results": [{
"name": "Google Safebrowsing",
"manufacturer": "Google",
"url": "http:\/\/code.google.com\/apis\/safebrowsing\/"
}]
}
"additional_link": "https:\/\/safebrowsing.clients.google.com\/safebrowsing\/diagnostic?site=starradio.london",
"has_nameserver": true,
"has_dns_hold": false,
"has_dns_record": true
}]
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: https://beta.api.ntldstats.net/stats/fraud
Public Information¶
All calls to /i/ endpoint work without API token authentication.
API response format can be set to CSV as append /csv to the URL:
List tlds¶
Command¶
GET /i/tlds
- Arguments
- – None
- Response
tlds: list of TLD objects - TLD Object
zone: name of tld, idn encoded zone_utf8: name of tld in native language delegated: true if tld is already delegated applications: list of Small Application object registry: Registry object (optional) backend: Backend object (optional) whois: Whois object (optional) trademark_claims: Trademark Claims object (optional) - Small Application Object
id: id of application applicant: name of applicant status: current application status - Registry Object
id: id of Registry name: name of Registry info_url: public nTLDStats URL to get more information about Registry url: url of Registry - Backend Object
id: id of Backend name: name of Backend info_url: public nTLDStats URL to get more information about Backend url: url of Backend - Whois Object
hostname: hostname of whois server charset: default charset of whois server ipv6: true if whois server supports IPv6 connections options: additional options to prefix whois request - Trademark Claims Object
open: start date of trademark claim period close: end date of trademark claim period
Example¶
Request
GET /i/tlds
Response
{
"resData": {
"tlds": [{
"zone": "xn--ngbc5azd",
"zone_utf8": "\u0634\u0628\u0643\u0629",
"delegated": true,
"applications": [{
"id": "1-1926-49360",
"applicant": "International Domain Registry Pty. Ltd.",
"status": "delegated"
}],
"registry": {
"name": "International Domain Registry Pty. Ltd.",
"id": "International-Domain-Registry-Pty-Ltd",
"info_url": "http:\/\/ntldstats.com\/registry\/International-Domain-Registry-Pty-Ltd",
"url": "http:\/\/www.dotshabaka.com"
},
"backend": {
"name": "ARI Registry Services",
"id": "ARI-Registry-Services",
"info_url": "http:\/\/ntldstats.com\/backend\/ARI-Registry-Services",
"url": "http:\/\/www.ariservices.com"
},
"whois": {
"hostname": "whois.nic.xn--ngbc5azd",
"charset": "ascii",
"ipv6": true,
"options": ""
}
}],
},
"code": 1000,
"msg":"Command completed successfully",
}
Sample Link: http://api.ntldstats.net/i/tlds
List new gtld applications¶
Command¶
GET /i/applications
- Arguments
- – None
- Response
applications: list of Application objects - Application Object
id: id of application priority_number: priority number of application label: name of label, idn encoded label_utf8: name of label in native language status: current application status as string applicant: Applicant object evaluation: Evaluation object cpe_status: current CPE status (optional) - Applicant Object
name: name of Applicant country_code: Country code indicated by applicant as principal place of business primary_contact: Primary Contact object suport_result: Result of support evaluation (optional) - Primary Contact Object
name: name of primary applicant contact email: email of primary applicant contact - Evaluation Object
result: result of evaluation as string pdf: link to official result PDF
Example¶
Request
GET /i/applications
Response
{
"resData": {
"applications": [{
"id": "1-1114-79381",
"priority_number": "1016",
"status": "delegated",
"label": "schmidt",
"label_utf8": "schmidt",
"applicant": {
"name": "SALM S.A.S.",
"country_code": "FR",
"primary_contact": {
"name": "Jacques Haas",
"email": "jacques.haas@salm.fr"
}
},
"evaluation": {
"result": "Pass IE",
"pdf": "http:\/\/newgtlds.icann.org\/en\/program-status\/application-results\/ie-1-1114-79381-en.pdf"
}
}],
},
"code": 1000,
"msg":"Command completed successfully",
}
Sample Link: http://api.ntldstats.net/i/applications
List launch events¶
Command¶
GET|POST /i/launch
- Arguments (to filter Response)
tld: filter by given tld filterby: filter start/end by start, end or inrange, default start start: either “empty” (no limit) or date as ‘YYYY-MM-DD’ end: either “empty” (no limit) or date as ‘YYYY-MM-DD’ stage: list of stages (SR, LR, EA, GA or OT) - Response
events: list of Event objects filter: used filters - Event Object
tld: TLD object stage: Stage object start: DateTime of event start end: DateTime of event end name: name of event, only given if stage is OT, description: additional information as text flags: list of Flag objects - Stage Object
id: ID of Stage name: Name of Stage - Flag Object
id: ID of Flag name: Name of Flag description: additional information as text short_name: short cut name of Flag
Example¶
Request
POST /i/launch
{
"tld": "bar"
}
Response
{
"resData": {
"events": [{
"tld": {
"zone": "bar",
"zone_utf8": "bar",
"registry": {
"name": "Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable",
"id": "Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"info_url": "http:\/\/ntldstats.com\/registry\/Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"url": "http:\/\/nic.bar"
},
"backend": {
"name": "CentralNic",
"id": "CentralNic",
"info_url": "http:\/\/ntldstats.com\/backend\/CentralNic",
"url": "http:\/\/www.centralnic.com"
}
},
"stage": {
"id": "SR",
"name": "Sunrise"
},
"start": "2014-04-09T00:00:00Z",
"end": "2014-06-08T00:00:00Z",
"name": null,
"description": null,
"flags": []
}, {
"tld": {
"zone": "bar",
"zone_utf8": "bar",
"registry": {
"name": "Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable",
"id": "Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"info_url": "http:\/\/ntldstats.com\/registry\/Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"url": "http:\/\/nic.bar"
},
"backend": {
"name": "CentralNic",
"id": "CentralNic",
"info_url": "http:\/\/ntldstats.com\/backend\/CentralNic",
"url": "http:\/\/www.centralnic.com"
}
},
"stage": {
"id": "LR",
"name": "Landrush"
},
"start": "2014-06-11T12:00:00Z",
"end": "2014-07-09T07:00:00Z",
"name": null,
"description": null,
"flags": []
}, {
"tld": {
"zone": "bar",
"zone_utf8": "bar",
"registry": {
"name": "Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable",
"id": "Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"info_url": "http:\/\/ntldstats.com\/registry\/Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"url": "http:\/\/nic.bar"
},
"backend": {
"name": "CentralNic",
"id": "CentralNic",
"info_url": "http:\/\/ntldstats.com\/backend\/CentralNic",
"url": "http:\/\/www.centralnic.com"
}
},
"stage": {
"id": "OT",
"name": "Other"
},
"start": "2014-07-03T00:00:00Z",
"end": "2014-07-31T23:59:00Z",
"name": "Bar Family Names Sunrise",
"description": "The purpose of this Sunrise is to allow resident Bar people to register their surnames under the .bar TLD prior to general availability. This is called the \u201cBar Family Names Sunrise\u201d or locally the \u201cSanrajz period za registraciju prezimena na .bar domenima\u201d.\r\n\r\nThis Sunrise is restricted to applicants meeting the strict application and eligibility requirements set forth in this Policy.",
"flags": [{
"name": "Country restricted",
"short_name": "COR",
"description": "Registration is restricted for registrants from one country"
}, {
"name": "Special Restrictions",
"short_name": "SPR",
"description": "Registration is restricted to registrants\/organizations named by Registry"
}]
}, {
"tld": {
"zone": "bar",
"zone_utf8": "bar",
"registry": {
"name": "Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable",
"id": "Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"info_url": "http:\/\/ntldstats.com\/registry\/Punto-2012-Sociedad-Anonima-Promotora-de-Inversion-de-Capital-Variable",
"url": "http:\/\/nic.bar"
},
"backend": {
"name": "CentralNic",
"id": "CentralNic",
"info_url": "http:\/\/ntldstats.com\/backend\/CentralNic",
"url": "http:\/\/www.centralnic.com"
}
},
"stage": {
"id": "GA",
"name": "General Availability"
},
"start": "2014-07-14T12:00:00Z",
"end": "2099-12-31T23:59:59Z",
"name": null,
"description": null,
"flags": []
}],
"filter": {
"start": "",
"end": "",
"stage": [],
"tld": "bar",
"filterby": "start"
}
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: http://api.ntldstats.net/i/launch
List current CZDS requests¶
Command¶
GET /i/czds
- Arguments
- – None
- Response
total: Total Object requests: list of Request Objects - Total Object
requests: total count of requests send approved: total count of approved requests pending: total count of current pending requests expired: total count of expired requests revoked: total count of revoked requests denied: total count of denied requests open: count of currently unrequested zones zones: total count of zones available on CZDS - Request Object
id: CZDS Request ID status: current status zone: name of tld, idn encoded zone_utf8: name of tld in native language approve_date: DateTime when request approved expire_date: DateTime when request expired request_date: DateTime when request created last_zone_update: DateTime when zone got last update zones_count: Count of unique domains in last zone update registry: Registry object backend: Backend object - Registry Object
id: id of Registry name: name of Registry info_url: public nTLDStats URL to get more information about Registry - Backend Object
id: id of Backend name: name of Backend info_url: public nTLDStats URL to get more information about Backend
Example¶
Request
GET /i/czds
Response
{
"resData": {
"total": {
"requests": 633,
"approved": 337,
"pending": 29,
"expired": 258,
"revoked": 1,
"denied": 8,
"open": 0,
"zones": 367
},
"requests": [{
"id": 210385,
"status": "pending",
"zone": "top",
"zone_utf8": "top",
"approve_date": "0000-00-00 00:00:00",
"expire_date": "0000-00-00 00:00:00",
"request_date": "2014-08-21 00:00:00",
"last_zone_update": "0000-00-00 00:00:00",
"zones_count": 0,
"registry": {
"name": "Jiangsu Bangning Science & Technology Co.,Ltd.",
"id": "Jiangsu-Bangning-Science-Technology-CoLtd",
"info_url": "http:\/\/ntldstats.com\/registry\/Jiangsu-Bangning-Science-Technology-CoLtd"
},
"backend": {
"name": "Jiangsu Bangning Science & technology Co.,Ltd.",
"id": "Jiangsu-Bangning-Science-technology-CoLtd",
"info_url": "http:\/\/ntldstats.com\/backend\/Jiangsu-Bangning-Science-technology-CoLtd"
}
}],
},
"code": 1000,
"msg": "Command completed successfully"
}
Sample Link: http://api.ntldstats.net/i/czds