Create a new search

curl --request POST \
  --url https://api.osint.ly/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "type": "Email Address",
    "value": "[email protected]"
  },
  "modules": {
    "mode": "selected",
    "ids": [
      "4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f"
    ]
  },
  "leaks": {
    "mode": "selected",
    "custom_mapping": true,
    "sources": [
      "Leak Check",
      "Snusbase"
    ]
  },
  "features": {
    "breached_accounts": true,
    "registered_accounts": "include"
  },
  "cache": {
    "mode": "prefer"
  },
  "delivery": {
    "webhook": {
      "url": "https://client.example/webhooks/osintly",
      "secret": "super-secret-webhook-key"
    }
  },
  "byok": {
    "mode": "default",
    "osint_industries": {
      "api_key": "oi_xxx",
      "timeout": 80,
      "exact_match": true,
      "premium": false,
      "premium_modules_only": false
    },
    "sherlockeye": {
      "api_key": "se_xxx",
      "additional_modules": [
        "digital_accounts_expansion"
      ]
    }
  }
}
'

import requests

url = "https://api.osint.ly/search"

payload = {
    "query": {
        "type": "Email Address",
        "value": "[email protected]"
    },
    "modules": {
        "mode": "selected",
        "ids": ["4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f"]
    },
    "leaks": {
        "mode": "selected",
        "custom_mapping": True,
        "sources": ["Leak Check", "Snusbase"]
    },
    "features": {
        "breached_accounts": True,
        "registered_accounts": "include"
    },
    "cache": { "mode": "prefer" },
    "delivery": { "webhook": {
            "url": "https://client.example/webhooks/osintly",
            "secret": "super-secret-webhook-key"
        } },
    "byok": {
        "mode": "default",
        "osint_industries": {
            "api_key": "oi_xxx",
            "timeout": 80,
            "exact_match": True,
            "premium": False,
            "premium_modules_only": False
        },
        "sherlockeye": {
            "api_key": "se_xxx",
            "additional_modules": ["digital_accounts_expansion"]
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {type: 'Email Address', value: '[email protected]'},
    modules: {mode: 'selected', ids: ['4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f']},
    leaks: {mode: 'selected', custom_mapping: true, sources: ['Leak Check', 'Snusbase']},
    features: {breached_accounts: true, registered_accounts: 'include'},
    cache: {mode: 'prefer'},
    delivery: {
      webhook: {
        url: 'https://client.example/webhooks/osintly',
        secret: 'super-secret-webhook-key'
      }
    },
    byok: {
      mode: 'default',
      osint_industries: {
        api_key: 'oi_xxx',
        timeout: 80,
        exact_match: true,
        premium: false,
        premium_modules_only: false
      },
      sherlockeye: {api_key: 'se_xxx', additional_modules: ['digital_accounts_expansion']}
    }
  })
};

fetch('https://api.osint.ly/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osint.ly/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => [
        'type' => 'Email Address',
        'value' => '[email protected]'
    ],
    'modules' => [
        'mode' => 'selected',
        'ids' => [
                '4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f'
        ]
    ],
    'leaks' => [
        'mode' => 'selected',
        'custom_mapping' => true,
        'sources' => [
                'Leak Check',
                'Snusbase'
        ]
    ],
    'features' => [
        'breached_accounts' => true,
        'registered_accounts' => 'include'
    ],
    'cache' => [
        'mode' => 'prefer'
    ],
    'delivery' => [
        'webhook' => [
                'url' => 'https://client.example/webhooks/osintly',
                'secret' => 'super-secret-webhook-key'
        ]
    ],
    'byok' => [
        'mode' => 'default',
        'osint_industries' => [
                'api_key' => 'oi_xxx',
                'timeout' => 80,
                'exact_match' => true,
                'premium' => false,
                'premium_modules_only' => false
        ],
        'sherlockeye' => [
                'api_key' => 'se_xxx',
                'additional_modules' => [
                                'digital_accounts_expansion'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osint.ly/search"

	payload := strings.NewReader("{\n  \"query\": {\n    \"type\": \"Email Address\",\n    \"value\": \"[email protected]\"\n  },\n  \"modules\": {\n    \"mode\": \"selected\",\n    \"ids\": [\n      \"4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f\"\n    ]\n  },\n  \"leaks\": {\n    \"mode\": \"selected\",\n    \"custom_mapping\": true,\n    \"sources\": [\n      \"Leak Check\",\n      \"Snusbase\"\n    ]\n  },\n  \"features\": {\n    \"breached_accounts\": true,\n    \"registered_accounts\": \"include\"\n  },\n  \"cache\": {\n    \"mode\": \"prefer\"\n  },\n  \"delivery\": {\n    \"webhook\": {\n      \"url\": \"https://client.example/webhooks/osintly\",\n      \"secret\": \"super-secret-webhook-key\"\n    }\n  },\n  \"byok\": {\n    \"mode\": \"default\",\n    \"osint_industries\": {\n      \"api_key\": \"oi_xxx\",\n      \"timeout\": 80,\n      \"exact_match\": true,\n      \"premium\": false,\n      \"premium_modules_only\": false\n    },\n    \"sherlockeye\": {\n      \"api_key\": \"se_xxx\",\n      \"additional_modules\": [\n        \"digital_accounts_expansion\"\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.osint.ly/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": {\n    \"type\": \"Email Address\",\n    \"value\": \"[email protected]\"\n  },\n  \"modules\": {\n    \"mode\": \"selected\",\n    \"ids\": [\n      \"4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f\"\n    ]\n  },\n  \"leaks\": {\n    \"mode\": \"selected\",\n    \"custom_mapping\": true,\n    \"sources\": [\n      \"Leak Check\",\n      \"Snusbase\"\n    ]\n  },\n  \"features\": {\n    \"breached_accounts\": true,\n    \"registered_accounts\": \"include\"\n  },\n  \"cache\": {\n    \"mode\": \"prefer\"\n  },\n  \"delivery\": {\n    \"webhook\": {\n      \"url\": \"https://client.example/webhooks/osintly\",\n      \"secret\": \"super-secret-webhook-key\"\n    }\n  },\n  \"byok\": {\n    \"mode\": \"default\",\n    \"osint_industries\": {\n      \"api_key\": \"oi_xxx\",\n      \"timeout\": 80,\n      \"exact_match\": true,\n      \"premium\": false,\n      \"premium_modules_only\": false\n    },\n    \"sherlockeye\": {\n      \"api_key\": \"se_xxx\",\n      \"additional_modules\": [\n        \"digital_accounts_expansion\"\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.osint.ly/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": {\n    \"type\": \"Email Address\",\n    \"value\": \"[email protected]\"\n  },\n  \"modules\": {\n    \"mode\": \"selected\",\n    \"ids\": [\n      \"4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f\"\n    ]\n  },\n  \"leaks\": {\n    \"mode\": \"selected\",\n    \"custom_mapping\": true,\n    \"sources\": [\n      \"Leak Check\",\n      \"Snusbase\"\n    ]\n  },\n  \"features\": {\n    \"breached_accounts\": true,\n    \"registered_accounts\": \"include\"\n  },\n  \"cache\": {\n    \"mode\": \"prefer\"\n  },\n  \"delivery\": {\n    \"webhook\": {\n      \"url\": \"https://client.example/webhooks/osintly\",\n      \"secret\": \"super-secret-webhook-key\"\n    }\n  },\n  \"byok\": {\n    \"mode\": \"default\",\n    \"osint_industries\": {\n      \"api_key\": \"oi_xxx\",\n      \"timeout\": 80,\n      \"exact_match\": true,\n      \"premium\": false,\n      \"premium_modules_only\": false\n    },\n    \"sherlockeye\": {\n      \"api_key\": \"se_xxx\",\n      \"additional_modules\": [\n        \"digital_accounts_expansion\"\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body