Specifications | Real-time Domain Registration Streaming | WhoisXML API

Data streaming

This data feed subscription is licensed to you or your organization only, you may not resell or relicense the data without explicit written permission from Whois API, Inc. Any violation will be prosecuted to the fullest extent of the law.

Update time

The data is provided immediately after being processed by our system.

Supported TLDs

How to obtain data from the Domain Registration Stream

  • First of all, you need an API key with a valid Real-time Domain Registration Streaming subscription.
  • Connect to the wss://nrd-stream.whoisxmlapi.com/ultimate endpoint and send your API key as a first message:
  • $ websocat --no-line -B 1100000 wss://nrd-stream.whoisxmlapi.com/ultimate
    [INFO  websocat::stdio_threaded_peer] get_stdio_peer (threaded)
    [INFO  websocat::ws_client_peer] get_ws_client_peer
    [INFO  websocat::ws_client_peer] Connected to ws
    ENTER_YOUR_API_KEY
    
  • In the example above, we used the websocat open source console utility. The “-B” parameter specifies the size of the buffer (a little over 1 MB is recommended).
  • We strongly recommend that you use WebSocket clients that comply with RFC 6455 and support ping-pong communication by default.

Optional input parameters

omitRaw

If 1, the following raw fields will be empty: registryDataRawText, registrantContact_rawText, whoisRecordRawText, administrativeContact_rawText, billingContact_rawText, technicalContact_rawText, zoneContact_rawText.

Example: wss://nrd-stream.whoisxmlapi.com/ultimate?omitRaw=1

Acceptable values: 0 | 1

Default: 0

includeCandidates

If 1, the stream will be enriched with simplified domain records obtained directly from zone files before they undergo complete NRD processing. These candidate records contain only two fields: domainName and reason (which can be either "added" for newly registered domains or "dropped" for recently removed domains).

These candidate domains are reported as soon as they are detected in zone files, providing faster notification of domain registrations and removals. Most candidate domains will be reported again after completing the full NRD processing pipeline, potentially with a different reason value based on WHOIS record comparison. Some domains may not appear in the second report if an identical WHOIS record was already identified or if the WHOIS record could not be retrieved.

Example: wss://nrd-stream.whoisxmlapi.com/ultimate?includeCandidates=1

Acceptable values: 0 | 1

Default: 0