Skip to content
WhiteIntel Intelligence Solutions edited this page May 23, 2024 · 3 revisions

WhiteIntel API

Overview

Welcome to the WhiteIntel API documentation! This API provides access to data on WhiteIntel. It is designed for enterprise-level subscriptions and offers a variety of endpoints to interact with the WhiteIntel platform.

Access and Usage

The WhiteIntel API is currently available only for enterprise-level subscriptions. Before using the API, please ensure that you meet the following requirements:

  • Daily Limit: You are limited to 500 API calls per day.
  • Rate Limit: You must wait at least 2 seconds between each API call.
  • Password Information: To access password information, you need to verify your target domain via the regular web UI.

Getting Started

To get started with the WhiteIntel API, you will need to obtain an API key. This key is used to authenticate your requests and ensure you have the necessary permissions to access the data.

Obtaining an API Key

To obtain an API key, refer to the Authentication API documentation in this wiki. The Authentication API will guide you through the process of generating your API key.

Using the API Key

Once you have obtained your API key, include it as a parameter in your POST requests. The parameter name is apikey.

Example Request

Here is an example of how to make a request to the WhiteIntel API using curl:

curl -X POST https://whiteintel.io/api/endpoint \
     -H "Content-Type: application/json" \
     -d '{
           "apikey": "your_api_key_here",
           "other_parameter": "value"
         }'