Skip to main content

API usage

Performing requests on the API impacts your quota. The Profundis API allows you to easily query our search engine and interconnect your own workflow and tools with it.

The OpenAPI documentation is available here.

tip

Before using the example commands below, define your API key in a variable. Replace xxx by the correct value. See how to retrieve your API key here.

API_KEY=xxx

The following query performs a search and retrieves all the available information.

curl "https://api.profundis.io/api/v2/common/data/hosts" \
  -H "X-API-KEY: $API_KEY" \
  -H "content-type: application/json" \
  -X POST \
  -d '{
    "raw_query": "host:*.com",
    "include": "all",
    "aggregate": false,
    "results_per_page": 50,
    "page": 2
  }'

You can filter the type of information you want to retrieve. Notice the host,resolution,port below.

curl "https://api.profundis.io/api/v2/common/data/hosts" \
  -H "X-API-KEY: $API_KEY" \
  -H "content-type: application/json" \
  -X POST \
  -d '{
    "raw_query": "host:*.com",
    "include": "host,resolution,port",
    "aggregate": false,
    "results_per_page": 50,
    "page": 2
  }'

The following command performs a DNS search through the Profundis API.

curl "https://api.profundis.io/api/v2/common/data/dns" \
  -H "X-API-KEY: $API_KEY" \
  -H "content-type: application/json" \
  -X POST \
  -d '{
    "raw_query": "host:*.com",
    "include": "all",
    "aggregate": false,
    "results_per_page": 50,
    "page": 2
  }'

OpenAPI documentation​

To get the complete list of API endpoints, you can download the OpenAPI file as json or yaml.