Droplist (TBR) API

The IRS Droplist API will return all domains that will be available to be claimed on the date and time specified in the API Droplist request or the domains claimed in last Droplist session depending on the option used.

List of domains in upcoming session

This API will provide the list of all domains in an upcoming Droplist session. Use the following API parameters to specify the date and time of the upcoming session.

Hostname

Droplist API hostname is environment specific, see production or OTE environment sections.

droplist api Input parameters

Droplist session date and time:

/api/tbr/session?datetime=YYYY/MM/DD HH:MM:SS

Example:

/api/tbr/session?datetime=2022/07/19%02:00:00

Session Time

The drop list session times will be every day at 2 am UTC and they will remain open for 1 hour.

Output parameters

The next session’s date and time
The number of domain names in that session
The name of each domain in the session

Sample output:

{
    "releaseDate": "2022-07-19T02:00:00.000Z",
    "numberOfDomainNames": 8154,
    "domainNames": [
        "domain-name1.nz",
        "domain-name2.nz"
    ]
}

List of domains claimed in last Droplist session

This API will provide the list of domains that were registered during the last Droplist session.

Input parameter

None:

/api/tbr/lastsessionresults

Output parameters

Droplist session time
Count of domains claimed in that session
Array of claimed domains containing:
- Domain name
- Registrar who claimed the domain
- Created date and time in ascending order

Sample output:

{
  "releaseDate": "2022-07-18T02:00:00.000Z",
  "numberOfDomainNames": 1,
  "domains": [
    {
      "domainName": "hk-redemption-period-to-pending-delete.nz",
      "registrarName": "Gaining Registrar",
      "timestamp": "2022-07-18T02:00:52.015Z"
    }
  ]
}