Need help? Call Live Support at +31 (0) 38 453 07 59

IsProxy

The IsProxy interface offers the most efficient way to check domain name validity and availability. It reduces overhead by using a telnet based protocol that allows multiple checks to be made in parallel. The interface can be used most effectively by reusing existing sessions as much as possible, this will lower the overhead on session creation and authentication.

Connection

The API is available on two different locations. A production environment and a test environment.

  • Production: Host is.yoursrs.com, Port 2001
  • Test: Host is.yoursrs-ote.com, Port 2001
Commands

The IsProxy supports a number of commands.

STARTTLS
Upgrade to a encrypted TLS connection. The response to this command will be send unencrypted, when the client recieves the "100 OK" response the TLS negotiation can be started.
Possible responses:
  • 100 OK
LOGIN <apikey>
LOGIN <username> <password> Deprecated
Login to the session.
Possible responses:
  • 100 Login ok
  • 400 Login failed
  • 400 Wrong number of arguments
  • 400 Already authenticated
IS <domain>
Check a domain name. Multiple IS commands can be send at once, each domain name will be checked in parallel. Responses will be returned as the become available, not necessarily in the order they were requested.
Possible responses:
  • <domain> available
  • <domain> not available
  • <domain> invalid domain
  • <domain> error
  • 400 not authenticated
ENABLE <function>
Enable extra functionality for the IsProxy.
Possible functions:
  • reason
    • adds a reason to the IS response, characters (), are escaped using a \: <domain> not available (reason=<reason>)
  • premium
    • enables premium support, will return prices in case of premium: <domain> available (type=premium,price=<price>,currency=<currency>)
Possible responses:
  • 100 OK
QUIT
Close the session. Session is closed after all pending "IS" commands have been processed.
IS <apikey> <domain>
IS <username> <password> <domain>Deprecated
Login and check domain name. This can be used when only a single domain name needs to be checked, session will be closed immediately.
Possible responses:
  • <domain> available
  • <domain> not available
  • <domain> invalid domain
  • <domain> error
  • 400 Login failed
Example session
>>> LOGIN apikey
<<< 100 Login ok
>>> IS example1.com
<<< example1.com not available
>>> IS example2.com
>>> IS example3.net
>>> IS example4.info
<<< example2.com available
<<< example4.info not available
<<< example3.net not available
>>> IS --.org
<<< --.org invalid domain
>>> QUIT

We provide multiple clients of our API to our customers; they can be found on our GitHub page.

Both of them are being used by our own products, the README of each contains examples of IsProxy usage