SecurityTrails Developer Hub

The SecurityTrails Developer Hub

Welcome to the SecurityTrails developer hub. You'll find comprehensive guides and documentation to help you start working with SecurityTrails as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Authentication

So we know it's really you...

Your API Key

You can find your API key in the SecurityTrails control panel.

To authenticate requests to the SecurityTrails API you will need to include the API key in an HTTP header named APIKEY. For example, if your API key is your_api_key, using curl you would make a request like

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

Query-String method

If for some reason you cannot include HTTP headers in the request you can also provide the API key as a query parameter. Assuming your API key is your_api_key you would query our API like

https://api.securitytrails.com/v1/ping?apikey=your_api_key

Query-string method is not recommended

Because query strings are often logged in clear-text we discourage you from using the query-string method to supply the apikey. Ensure that you are using https.

Authentication

So we know it's really you...