About the DNS Tools API

API Version: 1.9

The DNS Tools API allows you to look up DNS records for a given hostname.

The DNS Lookup tool currently supports these record types:

A (Host records)
CNAME (Canonical Name records)
MX (Mail Exchanger records)
NS (Name Server records)
SOA (Start of Authority records)
TXT (Text records)

This is the API for the DNS Tools.

Endpoints

https://networkcalc.com/api/dns/lookup/{hostname}

Look up DNS records for a hostname, domain name, or IP address on the public Internet.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/lookup/example.com

Response Format

DNSResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/dns/lookup/example.com

content_copy

PowerShell Example

Invoke-RestMethod https://networkcalc.com/api/dns/lookup/example.com -Method GET | ConvertTo-Json

content_copy

Python Example

import requests

requests.get("https://networkcalc.com/api/dns/lookup/example.com").json()

content_copy

Response

{

"status": "OK",

"hostname": "example.com",

"records": {

"A": [

{

"address": "93.184.216.34",

"ttl": 6962

}

"CNAME": [],

"MX": [

{

"exchange": "",

"priority": 0

}

"NS": [

{

"nameserver": "b.iana-servers.net"

{

"nameserver": "a.iana-servers.net"

}

"SOA": [

{

"nameserver": "ns.icann.org",

"hostmaster": "noc.dns.icann.org"

}

"TXT": [

"v=spf1 -all",

"8j5nfqld20zpcyr8xjw0ydcfq9rk8hgm"

]

}

content_copy

https://networkcalc.com/api/dns/lookup/save/{hostname}

Save a DNS lookup query to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/lookup/save/example.com

Response Format

DNSQueryResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/lookup/save/example.com \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/lookup/save/example.com -Method POST -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.post("https://networkcalc.com/api/dns/lookup/save/example.com", headers = headers).json()

content_copy

Response

{

"status": "OK",

"hostname": "example.com",

"query": {

"type": "dns",

"hostname": "example.com",

"created_at": "2021-10-31T12:16:11.371Z",

"updated_at": "2021-10-31T12:16:11.371Z"

}

content_copy

https://networkcalc.com/api/dns/whois/{hostname}

Get the WHOIS registration information for a website's hostname, domain, or IP address.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/whois/example.com

Response Format

WHOISResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/dns/whois/networkcalc.com

content_copy

PowerShell Example

Invoke-RestMethod https://networkcalc.com/api/dns/whois/networkcalc.com -Method GET | ConvertTo-Json

content_copy

Python Example

import requests

requests.get("https://networkcalc.com/api/dns/whois/networkcalc.com").json()

content_copy

Response

{

"status": "OK",

"hostname": "networkcalc.com",

"whois": {

"domain_status": "client transfer prohibited",

"domain_status_description": "Registry should reject requests to transfer domain to another registrar",

"registrar": "Google LLC",

"registrar_iana_id": 895,

"registry_domain_id": "2527354476_DOMAIN_COM-VRSN",

"registry_created_date": "2020-05-17T20:34:26Z",

"registry_expiration_date": "2022-05-17T20:34:26Z",

"abuse_email": "[email protected]",

"abuse_phone": "+1.8772376466"

}

content_copy

https://networkcalc.com/api/dns/whois/save/{hostname}

Save a WHOIS lookup query to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/whois/save/example.com

Response Format

DNSQueryResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/whois/save/example.com \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/whois/save/example.com -Method POST -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.post("https://networkcalc.com/api/dns/whois/save/example.com", headers = headers).json()

content_copy

Response

{

"status": "OK",

"hostname": "example.com",

"query": {

"type": "whois",

"hostname": "example.com",

"created_at": "2021-10-31T12:36:16.408Z",

"updated_at": "2021-10-31T12:36:16.408Z"

}

content_copy

https://networkcalc.com/api/dns/spf/{hostname}

Look up the published SPF record for a domain or validate the syntax of a to-be-published SPF record.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/spf/example.com

Request Body

{

"spf": "[string] An SPF record to validate. If specified, {hostname} is ignored."

}

content_copy

Response Format

SPFResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/spf/networkcalc.com

content_copy

PowerShell Example

Invoke-RestMethod https://networkcalc.com/api/dns/spf/networkcalc.com -Method POST | ConvertTo-Json

content_copy

Python Example

import requests

requests.post("https://networkcalc.com/api/dns/spf/networkcalc.com").json()

content_copy

Response

{

"status": "OK",

"hostname": "networkcalc.com",

"spf": "v=spf1 mx include:_spf.google.com include:servers.mcsv.net -all",

"validation": {

"is_valid": true,

"terms": [

{

"term": "v=spf1",

"type": "version",

"is_valid": true

{

"term": "mx",

"type": "mechanism",

"is_valid": true

{

"term": "include:_spf.google.com",

"type": "mechanism",

"is_valid": true

{

"term": "include:servers.mcsv.net",

"type": "mechanism",

"is_valid": true

{

"term": "-all",

"type": "mechanism",

"is_valid": true

}

]

}

content_copy

Example 2

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/spf \

--data '{ "spf": "v=spf1 mx include:_spf.google.com include:servers.mcsv.net -all" }'

content_copy

PowerShell Example

$body = @{"spf"="v=spf1 mx include=_spf.google.com include=servers.mcsv.net -all"} | ConvertTo-Json

Invoke-RestMethod https://networkcalc.com/api/dns/spf -Method POST -Body $body | ConvertTo-Json

content_copy

Python Example

import requests

data = { "spf": "v=spf1 mx include:_spf.google.com include:servers.mcsv.net -all" }

requests.post("https://networkcalc.com/api/dns/spf", json = data).json()

content_copy

Response

{

"status": "OK",

"hostname": "networkcalc.com",

"spf": "v=spf1 mx include:_spf.google.com include:servers.mcsv.net -all",

"validation": {

"is_valid": true,

"terms": [

{

"term": "v=spf1",

"type": "version",

"is_valid": true

{

"term": "mx",

"type": "mechanism",

"is_valid": true

{

"term": "include:_spf.google.com",

"type": "mechanism",

"is_valid": true

{

"term": "include:servers.mcsv.net",

"type": "mechanism",

"is_valid": true

{

"term": "-all",

"type": "mechanism",

"is_valid": true

}

]

}

content_copy

https://networkcalc.com/api/dns/spf/save/{hostname}

Save an SPF lookup query to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{hostname}

(Required) The hostname, domain name, or IP address to look up, save, etc.

Example: https://networkcalc.com/api/dns/spf/save/example.com

Request Body

{

"text": "[string] An SPF record in its textual representation. If included, `{hostname}` is ignored."

}

content_copy

Response Format

DNSQueryResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/spf/save/example.com \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/spf/save/example.com -Method POST -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.post("https://networkcalc.com/api/dns/spf/save/example.com", headers = headers).json()

content_copy

Response

{

"status": "OK",

"hostname": "example.com",

"query": {

"type": "spf",

"hostname": "example.com",

"created_at": "2021-10-31T12:39:17.199Z",

"updated_at": "2021-10-31T12:39:17.199Z"

}

content_copy

Example 2

Run this in the API

cURL Example

curl -X POST https://networkcalc.com/api/dns/spf/save/example.com \

--header "Authorization: Bearer 2jdS83kfDdDfllHk" \

--data '{ "text": "v=spf1 mx -all" }'

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

$body = @{"text"="v=spf1 mx -all"} | ConvertTo-Json

Invoke-RestMethod https://networkcalc.com/api/dns/spf/save/example.com -Method POST -Body $body -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

data = { "text": "v=spf1 mx -all" }

requests.post("https://networkcalc.com/api/dns/spf/save/example.com", json = data, headers = headers).json()

content_copy

Response

{

"status": "OK",

"hostname": "example.com",

"text": "v=spf1 mx -all",

"query": {

"type": "spf",

"hostname": "example.com",

"created_at": "2021-10-31T12:39:17.199Z",

"updated_at": "2021-10-31T12:39:17.199Z"

}

content_copy

https://networkcalc.com/api/dns/saved/{id}

Get queries that were saved to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{id}

(Optional) The unique identifier for the saved query.

Example: https://networkcalc.com/api/dns/saved/123

Response Format

DNSSavedQueryResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/dns/saved \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/saved -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/dns/saved", headers = headers).json()

content_copy

Response

{

"status": "OK",

"queries": [

{

"id": 558,

"user_id": 123,

"type": "dns",

"hostname": "twitter.com",

"text": null,

"created_at": "2021-10-30T16:02:50.000Z",

"updated_at": "2021-10-30T16:02:50.000Z"

{

"id": 721,

"user_id": 123,

"type": "dns",

"hostname": "networkcalc.com",

"text": null,

"created_at": "2021-10-30T16:02:57.000Z",

"updated_at": "2021-10-30T16:02:57.000Z"

}

]

}

content_copy

Example 2

Run this in the API

cURL Example

curl -X GET https://networkcalc.com/api/dns/saved/558 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/saved/558 -Method GET -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.get("https://networkcalc.com/api/dns/saved/558", headers = headers).json()

content_copy

Response

{

"status": "OK",

"query": {

"id": 558,

"user_id": 123,

"type": "dns",

"hostname": "twitter.com",

"text": null,

"created_at": "2021-10-30T16:02:50.000Z",

"updated_at": "2021-10-30T16:02:50.000Z"

}

content_copy

https://networkcalc.com/api/dns/dns/saved/{id}

Edit a query that was saved to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{id}

(Optional) The unique identifier for the saved query.

Example: https://networkcalc.com/api/dns/dns/saved/123

Request Body

{

"hostname": "[undefined] The hostname used in the query.",

"type ": "[string] The type of query, e.g., 'dns', 'whois', 'spf'.",

"text": "[string] An SPF record in its textual representation. If included, `{hostname}` is ignored."

}

content_copy

Response Format

DNSQueryResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X PATCH https://networkcalc.com/api/dns/saved/558 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk" \

--data '{ "type": "whois" }'

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

$body = @{"type"="whois"} | ConvertTo-Json

Invoke-RestMethod https://networkcalc.com/api/dns/saved/558 -Method PATCH -Body $body -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

data = { "type": "whois" }

requests.patch("https://networkcalc.com/api/dns/saved/558", json = data, headers = headers).json()

content_copy

Response

{

"status": "OK",

"query": {

"id": 558,

"user_id": 123,

"type": "whois",

"hostname": "twitter.com",

"text": null,

"created_at": "2021-10-30T16:02:50.000Z",

"updated_at": "2021-10-31T13:10:44.452Z"

}

content_copy

https://networkcalc.com/api/dns/dns/saved/{id}

Delete a query that was saved to your account.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{id}

(Optional) The unique identifier for the saved query.

Example: https://networkcalc.com/api/dns/dns/saved/123

Response Format

DNSSavedQueryDeleteResponse

Response Codes

200

OK - Success.

400

NO_HOST_SPECIFIED - The {hostname} parameter was not specified.

400

INVALID_HOST - The {hostname} parmaeter is not valid.

400

NO_RECORDS - The hostname is valid, but the query returned no results.

400

INVALID_STRING - The request format is incorrect. It should be a string.

400

FAILED_TO_VALIDATE - An error occurred while validating. Verify the request and try again.

400

NO_SPF_RECORD - An SPF record was not supplied in the body or there was no published SPF record found for {hostname}.

Examples

Example 1

Run this in the API

cURL Example

curl -X DELETE https://networkcalc.com/api/dns/saved/558 \

--header "Authorization: Bearer 2jdS83kfDdDfllHk"

content_copy

PowerShell Example

$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}

Invoke-RestMethod https://networkcalc.com/api/dns/saved/558 -Method DELETE -Headers $headers | ConvertTo-Json

content_copy

Python Example

import requests

headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}

requests.delete("https://networkcalc.com/api/dns/saved/558", headers = headers).json()

content_copy

Response

{

"status": "OK"

}

content_copy

Response Formats

{

"status": "[string] The status of the request.",

"hostname": "[string] The requested hostname.",

"records": {

"A": "[array] A (Host) records. Returned as an array of objects: { address, ttl }.",

"CNAME": "[array] CNAME (Canonical Name) records. Returned as an array of objects: { address }.",

"MX": "[array] MX (Mail Exchanger) records. Returned as an array of objects: { exchange, priority }.",

"NS": "[array] NS (Name Server) records. Returned as an array of objects: { nameserver }.",

"SOA": "[array] SOA (Start of Authority) records. Returned as an array of objects: { nameserver, hostmaster }.",

"TXT": "[array] TXT (Text) records. Returned as an array of strings."

}

content_copy

{

"status": "[string|array] The status of the request. May contain an array of errors as status.errors.",

"hostname": "[string] The requested hostname.",

"query": {

"type ": "[string] The type of DNS query, e.g., 'dns', 'whois', 'spf'.",

"hostname": "[string] The saved hostname.",

"created_at": "[datetime] The date and time the query was saved.",

"updated_at": "[datetime] The date and time the query was last updated."

}

content_copy

{

"status": "[string] The status of the request.",

"hostname": "[string] The hostname of the SPF record to look up. Ignored if an SPF string was included in the body.",

"spf": "[string] The SPF record string.",

"validation": {

"is_valid": "[boolean] true if the SPF record is valid, false otherwise.",

"total_lookups": "[number] The total number of DNS lookups for the record.",

"terms": "[array] An array containing each term and its validation. Includes attributes term, type, is_valid, dns_lookups."

}

content_copy

{

"status": "[string] The status of the request.",

"queries|query": "[array|object] An array of saved queries, or a single query if {id} was specified. See DNSQueryResponse"

}

content_copy

{

"status": "[string] The status of the request."

}

content_copy

{

"status": "[string] The status of the request.",

"hostname": "[string] The requested hostname.",

"whois": {

"domain_status": "[string] The current status of the domain, expressed as a short phrase.",

"domain_status_description": "[string] A description of the domain's current status.",

"registrar": "[string] The registrar for the domain.",

"registrar_iana_id": "[number] The domain's unique identifier in the IANA database.",

"registrar_domain_id": "[string] The domain's unique identifier in the registry.",

"registry_created_date": "[datetime] The date the current registration was created.",

"registry_expiration_date": "[datetime] The date the registration expired or will expire.",

"abuse_email": "[string] The email address to contact for reporting abuse.",

"abuse_phone": "[string] The phone number to contact for reporting abuse."

}

content_copy