nTLDStats API

https://ntldstats-api.readthedocs.io/
Admin
The nTLDStats API enables applications to interact with the nTLDstats.com website, providing access...
Tokens:42,156
Snippets:111
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example JSON Response for /stats/backends

Source: https://ntldstats-api.readthedocs.io/stats

An example JSON response for the GET /stats/backends endpoint, illustrating the structure of the returned data including overall stats and a list of backend objects.

```JSON
{
    "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"
}
```

--------------------------------

### Example JSON Response for /stats/backend/{id}

Source: https://ntldstats-api.readthedocs.io/stats

An example JSON response for the GET /stats/backend/{id} endpoint, showcasing the detailed information for a specific backend, including its TLDs and associated domain counts.

```JSON
{
    "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"
}
```

--------------------------------

### Get All TLD Statistics - API Response Example

Source: https://ntldstats-api.readthedocs.io/stats

Example JSON response for the GET /stats/tlds endpoint. It shows the structure of the 'tlds' object, containing details for each TLD (like 'xyz'), and the 'stats' object, providing overall domain and TLD counts. Includes a command status code and message.

```JSON
{
    "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",
}

```

--------------------------------

### Create Domain API Response Example

Source: https://ntldstats-api.readthedocs.io/domains

Example of a successful response from the POST /domains/create API endpoint. It confirms the command completion, the number of domains added, and a unique job ID for asynchronous processing.

```json
{
    "resData": {
        "total": 1,
        "job_id": "7635318e-8f50-510c-b2a2-27de5cc691f1"
    },
    "code": 1001,
    "msg": "Command completed successfully; action pending"
}
```

--------------------------------

### Create Domain API Request Example

Source: https://ntldstats-api.readthedocs.io/domains

Example of a POST request to create a new domain via the API. It includes domain details, registrar information, and nameservers. The response indicates the success of the command and provides a job ID for tracking.

```http
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"
    ]
}
```

--------------------------------

### Example JSON Response for /stats/registries

Source: https://ntldstats-api.readthedocs.io/stats

An example JSON response for the GET /stats/registries endpoint, detailing the structure for registry statistics, including total counts and a list of registry objects.

```JSON
{
    "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"
}
```

--------------------------------

### List New gTLD Applications API Endpoint Example (JSON)

Source: https://ntldstats-api.readthedocs.io/info

This snippet illustrates a sample JSON response for the GET /i/applications API endpoint. It returns a list of application objects, detailing each application's ID, priority, status, label information, applicant, and evaluation results. This endpoint is useful for tracking the status of new gTLD applications.

```json
{
    "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",
}
```

--------------------------------

### List TLDs API Endpoint Example (JSON)

Source: https://ntldstats-api.readthedocs.io/info

This snippet shows an example JSON response for the GET /i/tlds API endpoint. It includes a list of TLD objects, each with details about its zone, delegation status, applications, registry, backend, and whois information. This endpoint provides comprehensive data about top-level domains.

```json
{
    "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",
}
```

--------------------------------

### Get Parking Registrar Statistics (API Request)

Source: https://ntldstats-api.readthedocs.io/stats

This snippet shows the HTTP GET request to retrieve parking statistics for registrars. It requires no arguments and returns detailed statistics about domain registrations and parking.

```bash
GET /stats/parking/registrars
```

--------------------------------

### Get Parking Registrar Statistics (API Response)

Source: https://ntldstats-api.readthedocs.io/stats

This snippet provides an example JSON response for the /stats/parking/registrars API endpoint. It includes global statistics, a list of registrars with their respective domain counts, and specific parking-related metrics for each registrar.

```json
{
    "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"
    }
}
```

--------------------------------

### API Error Response Format Example

Source: https://ntldstats-api.readthedocs.io/overview

This example shows the structure of an error response from the nTLDstats API. Errors include a 'code', 'msg', and potentially 'resData' with error specifics, along with an appropriate HTTP status code.

```json
{
    "code": 2003,
    "msg": "Required parameter missing",
    "resData": {
        "elem": "domains"
    }
}

```

--------------------------------

### Get All TLD Statistics - API Request

Source: https://ntldstats-api.readthedocs.io/stats

This snippet demonstrates a GET request to the /stats/tlds endpoint to retrieve a list of all TLDs and their associated statistics. It requires a beta API account. The response includes a list of TLD objects and a total stats object.

```HTTP
GET /stats/tlds

```

--------------------------------

### Upload Multiple Domains via CSV Example

Source: https://ntldstats-api.readthedocs.io/domains

Example of data formatted as CSV for uploading multiple domains using a PUT or POST request to the /domains endpoint. Each field is separated by a semicolon, including domain name, IANA ID, registration date, registrant handle, and nameservers.

```text
xn–domainname.tld;1;2014-02-01T23:00.00Z;ABC1234;NS1.EXAMPLE.COM;NS2.EXAMPLE.COM
```

--------------------------------

### GET /stats/parking/tlds

Source: https://ntldstats-api.readthedocs.io/stats

Retrieves parking statistics aggregated across all TLDs.

```APIDOC
## GET /stats/parking/tlds

### Description
Retrieves parking statistics aggregated across all TLDs. It provides global statistics and a breakdown for each TLD.

### Method
GET

### Endpoint
/stats/parking/tlds

### Parameters
#### Query Parameters
*None*

### Request Example
```json
{
  "example": "GET /stats/parking/tlds"
}
```

### Response
#### Success Response (200)
- **resData** (object) - Contains the parking statistics.
  - **stats** (object) - Global parking statistics.
    - **total_tlds** (integer) - Total number of TLDs.
    - **total_domains** (integer) - Total number of registered domains.
    - **parking_domains** (integer) - Total number of parked domains.
    - **no_ns** (integer) - Domains without nameservers.
    - **parking_ns** (integer) - Domains with parking nameservers.
    - **no_record** (integer) - Domains without an A record.
    - **parking_ip** (integer) - Domains resolving to a parking IP address.
    - **private_ip** (integer) - Domains resolving to private IP addresses.
    - **parking_check** (integer) - Domains returning parking website content.
    - **http_error** (integer) - Domains with HTTP errors.
    - **redirect** (integer) - Domains returning a redirect code.
  - **tlds** (array) - List of parking statistics per TLD.
    - **zone** (string) - The TLD zone name.
    - **zone_utf8** (string) - The TLD zone name in native language.
    - **total_domains** (integer) - Total domains for this TLD.
    - **stats** (object) - Parking statistics for this specific TLD (same fields as global stats).
- **code** (integer) - The API response code.
- **msg** (string) - A message indicating the command status.

#### Response Example
```json
{
  "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"
  }
}
```
```

--------------------------------

### GET /stats/parking/registrars

Source: https://ntldstats-api.readthedocs.io/stats

Retrieves statistics about domain parking and a list of registrars with their associated domain counts and parking statistics.

```APIDOC
## GET /stats/parking/registrars

### Description
This endpoint provides a comprehensive overview of domain statistics, including global totals for registered and parked domains, broken down by TLDs. It also returns a detailed list of registrars, each with their own statistics on domain registrations and parking.

### Method
GET

### Endpoint
/stats/parking/registrars

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

### Request Example
```
GET /stats/parking/registrars
```

### Response
#### Success Response (200)
- **resData** (object) - The main response object containing statistics and registrar data.
  - **stats** (object) - Global statistics.
    - **total_tlds** (integer) - Total count of TLDs.
    - **total_domains** (integer) - Total count of registered domains.
    - **parking_domains** (integer) - Total count of parking domains.
    - **no_ns** (integer) - Total count of domains without nameservers.
    - **parking_ns** (integer) - Total count of domains with parking nameservers.
    - **no_record** (integer) - Total count of domains without an A record.
    - **parking_ip** (integer) - Total count of domains with a parking IP.
    - **private_ip** (integer) - Total count of domains resolving to private IPs.
    - **parking_check** (integer) - Total count of domains returning parking websites.
    - **http_error** (integer) - Total count of domains with HTTP errors.
    - **redirect** (integer) - Total count of domains returning a redirect code.
  - **registrars** (array) - List of Registrar objects.
    - **total_domains** (integer) - Total registered domains for the registrar.
    - **id** (string) - Unique identifier for the registrar.
    - **iana_id** (string) - The registrar's IANA ID.
    - **name** (string) - The name of the registrar.
    - **registrar_group** (object) - Information about the registrar group.
      - **name** (string) - The name of the registrar group.
      - **url** (string) - The homepage URL of the registrar group.
    - **stats** (object) - Statistics specific to the registrar.
      - **parking_domains** (integer) - Parking domains for the registrar.
      - **no_ns** (integer) - Domains without nameservers for the registrar.
      - **parking_ns** (integer) - Domains with parking nameservers for the registrar.
      - **no_record** (integer) - Domains without an A record for the registrar.
      - **parking_ip** (integer) - Domains with a parking IP for the registrar.
      - **private_ip** (integer) - Domains resolving to private IPs for the registrar.
      - **parking_check** (integer) - Domains returning parking websites for the registrar.
      - **http_error** (integer) - Domains with HTTP errors for the registrar.
      - **redirect** (integer) - Domains returning redirect code for the registrar.
  - **code** (integer) - API response code.
  - **msg** (string) - API response message.

#### Response Example
```json
{
    "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"
    }
}
```
```

--------------------------------

### API Request Format Example - POST /domains/create

Source: https://ntldstats-api.readthedocs.io/overview

This snippet illustrates the expected format for creating a domain entry via the API. It includes the endpoint, content type, and a JSON payload with domain details. All arguments must be sent JSON encoded by POST.

```http
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"]}

```

--------------------------------

### Domain Creation API

Source: https://ntldstats-api.readthedocs.io/overview

This endpoint allows for the creation of a new domain entry. It requires domain-specific information and registrant details.

```APIDOC
## POST /domains/create

### Description
This endpoint allows for the creation of a new domain entry. It requires domain-specific information and registrant details.

### Method
POST

### Endpoint
http://api.ntldstats.net/domains/create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **domain** (string) - Required - The domain name to be created.
- **iana_id** (integer) - Required - The IANA ID of the registry.
- **registration_date** (string) - Required - The registration date in RFC3339 format.
- **registrant_handle** (string) - Required - The handle of the registrant.
- **nameservers** (array of strings) - Required - A list of nameservers for the domain.

### Request Example
```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
#### Success Response (200)
- **code** (integer) - The status code indicating success.
- **msg** (string) - A message confirming command completion.

#### Response Example
```json
{
  "code": 1000,
  "msg": "Command completed successfully"
}
```
```

--------------------------------

### POST /domains/create

Source: https://context7.com/context7/ntldstats-api_readthedocs_io/llms.txt

Submit a new domain registration for processing. This endpoint allows for the creation of a single domain entry.

```APIDOC
## Create Single Domain

### Description
Submit a new domain registration for processing.

### Method
POST

### Endpoint
`/domains/create`

### Parameters
#### Request Body
- **domain** (string) - Required - The domain name to register.
- **iana_id** (integer) - Required - The IANA ID of the TLD.
- **registration_date** (string) - Required - The registration date in ISO 8601 format.
- **registrant_handle** (string) - Required - The registrant handle.
- **nameservers** (array of strings) - Required - A list of nameservers for the domain.

### Request Example
```bash
curl -X POST http://api.ntldstats.net/domains/create \
     -H "X-API-TOKEN: your_api_token_here" \
     -H "Content-Type: application/json" \
     -d '{ \
    "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
#### Success Response (200 or 201)
- **resData** (object) - Response data containing job tracking information.
  - **total** (integer) - The total number of domains processed.
  - **job_id** (string) - The unique identifier for the job.
- **code** (integer) - Command completion status code.
- **msg** (string) - Command completion message.

#### Response Example
```json
{
    "resData": {
        "total": 1,
        "job_id": "7635318e-8f50-510c-b2a2-27de5cc691f1"
    },
    "code": 1001,
    "msg": "Command completed successfully; action pending"
}
```
```

--------------------------------

### List Launch Events (Public) - Bash

Source: https://context7.com/context7/ntldstats-api_readthedocs_io/llms.txt

Retrieves TLD launch schedule and events. Supports both GET requests for all events and POST requests with filters for specific date ranges and stages. No authentication is required. The response provides information on TLD launch dates and associated stages.

```bash
# GET request - all events
curl http://api.ntldstats.net/i/launch

# POST with filters
curl -X POST http://api.ntldstats.net/i/launch \
     -H "Content-Type: application/json" \
     -d '{
    "tld": "bar",
    "filterby": "start",
    "start": "2014-01-01",
    "end": "2014-12-31",
    "stage": ["SR", "LR", "GA"]
}'
```

--------------------------------

### Get Job Details (GET /jobs/<jobid>)

Source: https://ntldstats-api.readthedocs.io/jobs

Fetches the details of a specific job using its unique job ID. The response provides the status, job ID, and addition timestamp for the requested job. This is a GET request that requires a job ID as a path parameter.

```http
GET /jobs/a15e98ca-17f5-56cc-b654-4661013749e6

```

```json
{
    "code": 1000,
    "msg":"Command completed successfully",
    "resData": {
        "status": "Unprocessed",
        "job_id": "a15e98ca-17f5-56cc-b654-4661013749e6",
        "added": "2014-04-17T00:40:00Z"
    }
}

```

--------------------------------

### List Pending Jobs (GET /jobs)

Source: https://ntldstats-api.readthedocs.io/jobs

Retrieves a list of all pending jobs for the authenticated user. The response includes a list of job items, each containing its status, ID, and addition timestamp. No arguments are required for this GET request.

```http
GET /jobs

```

```json
{
    "code": 1000,
    "msg":"Command completed successfully",
    "resData": {
        "jobs": [
            {
                "status": "Unprocessed",
                "job_id": "a15e98ca-17f5-56cc-b654-4661013749e6",
                "added": "2014-04-17T00:40:00Z"
            }
        ]
    }
}

```

--------------------------------

### General API Usage and Authentication

Source: https://ntldstats-api.readthedocs.io/overview

Details on the base URL, request format, response format, standard fields, authentication, and error handling for the nTLDstats API.

```APIDOC
## General API Information

### Base URL
`http://api.ntldstats.net/`

### Request Format
All data is sent as JSON. All arguments must be sent JSON encoded by POST.

### Response Format
Status codes are used properly. A 200 response indicates success with a normal response body. Other status codes indicate errors with a plain text error message in the response body.

### Standard Response Fields
All responses include at least a `code` and a `msg` field. Successful calls returning additional data will include a `resData` field.

### Authentication
Requests require a valid API Token. The token can be provided as an HTTP Header `X-API-TOKEN`, as the username in HTTP Basic Authentication, or as a URL parameter `token`.

### Error Handling
Error responses follow a specific format:
```json
{
  "code": 2003,
  "msg": "Required parameter missing",
  "resData": {
    "elem": "domains"
  }
}
```

### Units
- Durations are in seconds.
- Timestamps are in RFC3339 format (e.g., `2012-05-14T17:54:16Z`) and are always UTC.
```

--------------------------------

### GET/POST /i/launch

Source: https://ntldstats-api.readthedocs.io/info

Retrieves a list of NTLD launch events. Supports filtering by TLD, date range, and launch stage.

```APIDOC
## GET/POST /i/launch

### Description
Retrieves a list of NTLD launch events. Supports filtering by TLD, date range, and launch stage.

### Method
GET, POST

### Endpoint
/i/launch

### Parameters
#### Query Parameters
- **tld** (string) - Optional - Filter by given TLD.
- **filterby** (string) - Optional - Filter start/end by **start**, **end** or **inrange**. Defaults to **start**.
- **start** (date) - Optional - Either “empty” (no limit) or date as ‘YYYY-MM-DD’.
- **end** (date) - Optional - Either “empty” (no limit) or date as ‘YYYY-MM-DD’.
- **stage** (list of strings) - Optional - List of stages (**SR**, **LR**, **EA**, **GA** or **OT**).

### Response
#### Success Response (200)
- **events** (array) - List of Event objects.
- **filter** (object) - Used filters.

### Event Object
- **tld** (object) - TLD object.
- **stage** (object) - Stage object.
- **start** (datetime) - DateTime of event start.
- **end** (datetime) - DateTime of event end.
- **name** (string) - Name of event, only given if stage is **OT**.
- **description** (string) - Additional information as text.
- **flags** (list of objects) - List of Flag objects.

### Stage Object
- **id** (string) - ID of Stage.
- **name** (string) - Name of Stage.

### Flag Object
- **id** (string) - ID of Flag.
- **name** (string) - Name of Flag.
- **description** (string) - Additional information as text.
- **short_name** (string) - Short cut name of Flag.
```

--------------------------------

### List Launch Events (Public)

Source: https://context7.com/context7/ntldstats-api_readthedocs_io/llms.txt

Retrieves the TLD launch schedule and events. Supports filtering by date range and stage. Authentication is not required.

```APIDOC
## List Launch Events (Public)

### Description
Retrieve TLD launch schedule and events without authentication.

### Method
GET (all events)
POST (with filters)

### Endpoint
`/i/launch`

### Parameters
#### Query Parameters (for GET request)
None

#### Request Body (for POST request)
- **tld** (string) - Optional - Filter by a specific TLD.
- **filterby** (string) - Optional - Field to filter by (e.g., 'start').
- **start** (string) - Optional - Start date for filtering (YYYY-MM-DD).
- **end** (string) - Optional - End date for filtering (YYYY-MM-DD).
- **stage** (array of strings) - Optional - Filter by launch stages (e.g., ['SR', 'LR', 'GA']).

### Request Example
```bash
# GET request - all events
curl http://api.ntldstats.net/i/launch

# POST with filters
curl -X POST http://api.ntldstats.net/i/launch \
     -H "Content-Type: application/json" \
     -d '{ "tld": "bar", "filterby": "start", "start": "2014-01-01", "end": "2014-12-31", "stage": ["SR", "LR", "GA"] }'
```

### Response
#### Success Response (200)
- **resData** (object) - Contains the list of launch events.
  - **events** (array) - An array of launch event objects.
    - **tld** (string) - The TLD associated with the event.
    - **date** (string) - The date of the event (YYYY-MM-DD).
    - **stage** (string) - The stage of the launch (e.g., 'SR', 'LR', 'GA').
    - **description** (string) - Description of the launch event.
- **code** (integer) - API response code (1000 for success).
- **msg** (string) - API response message ('Command completed successfully').

#### Response Example
```json
{
    "resData": {
        "events": [
            {
                "tld": "example.com",
                "date": "2023-10-26",
                "stage": "GA",
                "description": "General Availability launch"
            }
        ]
    },
    "code": 1000,
    "msg": "Command completed successfully"
}
```
```

--------------------------------

### Get Specific TLD Statistics - API Request

Source: https://ntldstats-api.readthedocs.io/stats

This snippet illustrates a GET request to the /stats/tld/<zone> endpoint to retrieve detailed statistics for a specific Top-Level Domain (TLD). The <zone> parameter should be replaced with the desired TLD identifier. A beta API account is required.

```HTTP
GET /stats/tld/ <zone>

```

--------------------------------

### POST /domains/create - Create a New Domain

Source: https://ntldstats-api.readthedocs.io/domains

Creates a new domain with specified details. This endpoint accepts domain name, IANA ID, registration date, registrant handle, and a list of nameservers.

```APIDOC
## POST /domains/create

### Description
Creates a new domain with specified details. This endpoint accepts domain name, IANA ID, registration date, registrant handle, and a list of nameservers.

### Method
POST

### Endpoint
/domains/create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **domain** (string) - Required - The domain name to create.
- **iana_id** (integer) - Required - The registrar IANA ID.
- **registration_date** (string) - Required - The date of registration in ISO 8601 format.
- **registrant_handle** (string) - Optional - The handle of the domain registrant.
- **nameservers** (array of strings) - Required - A list of nameservers for the domain.

### Request Example
```json
{
    "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
#### Success Response (200)
- **total** (integer) - The number of domains added.
- **job_id** (string) - The ID of the created job.

#### Response Example
```json
{
    "resData": {
        "total": 1,
        "job_id": "7635318e-8f50-510c-b2a2-27de5cc691f1"
    },
    "code": 1001,
    "msg": "Command completed successfully; action pending"
}
```
```

--------------------------------

### Public Information - List launch events

Source: https://ntldstats-api.readthedocs.io/index

Retrieves information about upcoming and past gTLD launch events.

```APIDOC
## Public Information - List launch events

### Description
Fetches details about gTLD launch events.

### Method
GET

### Endpoint
/public/launch-events
```

--------------------------------

### Jobs API - Get job details

Source: https://ntldstats-api.readthedocs.io/index

Retrieves detailed information about a specific job.

```APIDOC
## Jobs API - Get job details

### Description
Retrieves specific details for a given job ID.

### Method
GET

### Endpoint
/jobs/{job_id}

### Parameters
#### Path Parameters
- **job_id** (string) - Required - The unique identifier of the job.
```

--------------------------------

### POST /i/launch

Source: https://ntldstats-api.readthedocs.io/info

This endpoint retrieves information about domain name launches for a specified Top-Level Domain (TLD). It returns a list of events associated with the TLD's launch phases.

```APIDOC
## POST /i/launch

### Description
Retrieves information about domain name launches for a specified Top-Level Domain (TLD), including various launch phases and their details.

### Method
POST

### Endpoint
/i/launch

### Parameters
#### Request Body
- **tld** (string) - Required - The Top-Level Domain for which to retrieve launch information.

### Request Example
```json
{
    "tld": "bar"
}
```

### Response
#### Success Response (200)
- **resData** (object) - Contains the launch data.
  - **events** (array) - A list of launch events.
    - **tld** (object) - Information about the TLD.
      - **zone** (string) - The zone name of the TLD.
      - **zone_utf8** (string) - The UTF-8 representation of the TLD zone.
      - **registry** (object) - Details about the TLD registry.
        - **name** (string) - The name of the registry.
        - **id** (string) - The unique identifier of the registry.
        - **info_url** (string) - URL for more information about the registry.
        - **url** (string) - The official URL of the registry.
      - **backend** (object) - Details about the backend service provider.
        - **name** (string) - The name of the backend provider.
        - **id** (string) - The unique identifier of the backend provider.
        - **info_url** (string) - URL for more information about the backend provider.
        - **url** (string) - The official URL of the backend provider.
    - **stage** (object) - Information about the launch stage.
      - **id** (string) - The identifier of the launch stage (e.g., "SR" for Sunrise, "LR" for Landrush).
      - **name** (string) - The name of the launch stage (e.g., "Sunrise", "Landrush").
    - **start** (string) - The start date and time of the launch stage in ISO 8601 format.
    - **end** (string) - The end date and time of the launch stage in ISO 8601 format.
    - **name** (string) - The specific name of the launch event (if applicable).
    - **description** (string) - A detailed description of the launch event (if applicable).
    - **flags** (array) - A list of flags associated with the launch event.
      - **name** (string) - The name of the flag.
      - **short_name** (string) - A short name or code for the flag.
      - **description** (string) - A description of what the flag signifies.

#### Response Example
```json
{
    "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": "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"
                    }
                ]
            }
        ]
    }
}
```
```
Tokens:
Raw