securitytrailsrestapi.docs.apiary.io Open in urlscan Pro
92.123.104.12  Public Scan

Form analysis
0 forms found in the DOM

Text Content

JavaScript is disabled
Please continue here to find out how to
enable it in your browser.
   
 * Documentation
   
   
 * Inspector
   


SECURITYTRAILS API

SecurityTrails • securitytrailsrestapi
Create New API Project
Help


Apiary Powered Documentation

Sign in with Apiary account.


INTRODUCTION

Authentication
Quotas


REFERENCE

General
* Ping
* Usage
Domains
* Domain Info
* Subdomains
* Tags
* WHOIS
History
* DNS
* WHOIS
Exploration
* IPv4 Explorer
* Searching Domains
* Search Stats
Feeds
* List Domains
 * Introduction
 * 
 * 


SECURITYTRAILS API


INTRODUCTION

SecurityTrails API is used to fetch various history and current data from any
given domain on the Internet.


AUTHENTICATION

To authenticate requests to the SecurityTrails API you will need to include the
API key in an HTTP header named APIKEY. If for some reason you cannot include
HTTP headers in the request you can also provide the API key as a query
parameter.

For example, if your API key is ABCDAPIKEY, using curl you would make a request
like:

curl --include \
     --header "APIKEY: ABCDAPIKEY" \
  'https://api.securitytrails.com/v1/ping'



QUOTAS

All subscription levels come with soft quotas. Once the soft quota is reached we
will attempt to bill for additional requests at the rate indicated for your
subscription level. If auto-billing fails you will start to receive HTTP/1.1 429
errors.

If auto-billing is disabled, the quotas will immediately become hard quotas and
you will receive HTTP/1.1 429 errors once you hit your monthly limit.

We will also notify you when you are approaching your quota or if it is
projected that you will exceed your API usage quota at your current usage rate.

To prevent inadvertent downtime for your application we recommend configuring
auto-billing to start before you hit your monthly quota.




REFERENCE


GENERAL


PING




ATTRIBUTES




PING




You can use this simple endpoint to test your authentication and access to the
SecurityTrails API.


USAGE




ATTRIBUTES




USAGE - COMING SOON




This will retrieve your monthly quota usage and availability.

The stats provided are for the present month and include:

 * total_used - The number of API requests made

 * total_available - The total available number of API requests for the month

 * projected_used - The projected number of API calls you will make this month

 * overage_rate - The rate per requests (in USD) you will pay once you hit your
   quota if auto-billing is enabled (in increments of 1000 requests).


DOMAINS

Domain information endpoints that return various information about domains.


DOMAIN INFO




ATTRIBUTES




GET DOMAIN




Returns the current data about the given domain. In addition to the current
data, you also get the current statistics associated with a particular record.

( For example, for a records you'll get how many other domains have the same IP
)

The data set contains the following info:

 * a - IPv4 current data

 * aaaa - IPv6 current data

 * mx - Mail Exchanger current data

 * ns - Name server current data

 * soa - SOA current data

 * txt - TXT current data


SUBDOMAINS




ATTRIBUTES




LIST SUBDOMAINS




Returns subdomains for a given domain.


TAGS




ATTRIBUTES




LIST TAGS




Returns tags for a given domain.


WHOIS




ATTRIBUTES




Fetches the current WHOIS data for a given domain.

GET WHOIS




Returns the current WHOIS data about a given domain with the stats merged
together.


HISTORY

History endpoints are used to fetch various historical data about domains.


DNS




ATTRIBUTES




LIST BY RECORD TYPE




Lists out specific historical information about the given domain parameter. The
returned data is paginated with 100 records are shown per page.

Important Note: Supported types are a, aaaa, mx, ns, soa and txt

In addition of fetching the historical data for particular type, the count
statistic is returned aswel, which represents the number of that particular
resource against current data. ( a records will have an ip_count field which
will represent the number of records that has the same IP as that particular
record )

These types represent the historicals records below, respectively:

 * a - Ipv4 historical data

 * aaaa - Ipv6 historical data

 * mx - Mail Exchanger historical data

 * ns - Name server historical data

 * soa - SOA historical data

 * txt - TXT historical data


WHOIS




ATTRIBUTES




LIST BY DOMAIN




Returns historical WHOIS information about the given domain The returned data is
paginated with 100 records shown per page.


EXPLORATION

Exploration endpoints allow you to search and explore the entire dataset. You
can explore IPv4 findings by zooming in to get stats about their usage and can
search domains filtering by IP, various WHOIS fields, keywords, tlds, and so on.
You can even combine various filters together to get only the results that match
every filter.

For example, if you want to only list domains registered at a particular
registrar for a particular tld that uses google for email, you can now get that
list!


IPV4 EXPLORER




ATTRIBUTES




EXPLORE IPS




Returns the neighbors in any given IP level range and essentially allows you to
explore closeby IP addresses. This works by providing a specific IP address (or
by starting at the whole unzoomed level). Explorer will always yield IPs that
will be grouped in blocks, so the output will always be 16.

Examples:

 * Searching for /28 block will return all 16 /32 IP addresses in /28 block.

 * Searching for /24 block will return all /28 IP blocks in /24 block.

 * etc.


SEARCHING DOMAINS




ATTRIBUTES




SEARCH




Filter and search specific records using this endpoint. Using simple filter
composition, any type of data fetching is possible. The post object uses a very
simple dsl where the json key represents the type to filter on and the value.
Given this, you can create any number of queries, depending on the need. It's
worth noting that all of the filters are combined using AND fashion and work in
combination.

In order to access subsequent pages of results you can add a ?page=:pagenumber
to the path. So to retrieve the 5th page of results you'd post your search to
/v1/search/list?page=5.

Possible key values are:

 * ipv4 (can include a network mask)

 * ipv6

 * mx

 * ns

 * cname

 * subdomain

 * apex_domain

 * soa_email

 * tld

 * whois_email

 * whois_street1

 * whois_street2

 * whois_street3

 * whois_street4

 * whois_telephone

 * whois_postalCode

 * whois_organization

 * whois_name

 * whois_fax

 * whois_city

 * keyword (substring of a hostname, e.g. the value of  oa would yield all
   hostnames containing oa characters)

Note: The results are always paginated with 100 results per page.


SEARCH STATS




ATTRIBUTES




SEARCH




By appending /stats at the end of the search URL, instead of getting the usual
records, a stats object is given in the response. This object contains some
usefull information like:

 * tld count

 * hostname count

 * domain count


FEEDS


LIST DOMAINS




ATTRIBUTES




LIST




Download a list of domains based on the type. The response itself is streamed to
a file, which means the data is received in chunks. Possible types are:

 * all

 * new

 * dropped

A tld takes priority over specifying filters, and they do not work in
combination. So you can either specify a filter, or a tld. NS option works only
for type and tld lookups.




Switch between example and interactive console for customized API calls.

Switch to Console


NO ACTION SELECTED

You can try selecting ‘Ping’ from the left column.

Learn more about using the documentation.


NO ACTION SELECTED

To try out Console, please select an action. E.g. select ‘Ping’ from the left
column.

Learn more about using the documentation.