Introduction

Welcome to IntelSentry API (Application Programming Interface) documentation! In this section, you may learn about the architecture and general concepts of the API such as authentication, request/response formats, and error handling. For a technical reference of the available endpoints, click here.

Note that this feature is currently only available to Researcher PRO or higher tier subscriptions.

Accessing the API

The IntelSentry API may be found at the following base URL.

https://api.intelsentry.io/v1/

Do note that all traffic must use the https protocol, http is not and will not be supported due to the sensitive nature of the information that is transmitted.

Using the API

The API may be used to automate and/or integrate the extraction and management of the same information that is available through the dashboard. In order to obtain existing information, the GET method is used, while the POST method is used instead to extract new information. Finally, to delete information (e.g. past searches from history), the DELETE method must be used.

Moreover, all POST requests must have a valid JSON-formatted body, and the corresponding Content-Type: application/json header. On the other hand, GET requests should not have any data in the body, and do not need the Content-Type header. This also applies to DELETE requests.

Nonetheless, all requests must be authenticated and have a valid token, supplied in the Authorization header in the form of a bearer token e.g. Authorization: Bearer <token>.

For example, a GET request should look like this.

GET https://api.intelsentry.io/v1/info/token
Authorization: Bearer <token>

While a POST request should look like this.

POST https://api.intelsentry.io/v1/search
Authorization: Bearer <token>
Content-Type: application/json
 
{
  "query": "example.com",
  "pages": 2
}

Consuming the API

All responses by the server will be in the form of a valid JSON as well as the corresponding status code. For ease of handling, the status code will also be included in the response body, within the status key.

A successful response should look like this.

GET https://api.intelsentry.io/v1/health
Authorization: Bearer <token>

HTTP/1.1 200
Content-Type: application/json
Content-Length: 44
 
{
    "status": 200,
    "result": "down"
}

While an unsuccessful response should look like this.

GET https://api.intelsentry.io/v1/history/3bca20d0-e0aa-4afa-9d8d-b084f389ae16
Authorization: Bearer <token>

HTTP/1.1 400
Content-Type: application/json
Content-Length: 66
 
{
    "status": 400,
    "error": "Search not found in history"
}

Note that all unsuccessful responses will contain an error JSON key, unless there is no response i.e. the API is down.