Account
Modules
Every module and whether your account can use it
GET
/
api
/
modules
curl "https://www.osintcat.net/api/modules" \
-H "X-API-KEY: YOUR_API_KEY"
import requests
url = "https://www.osintcat.net/api/modules"
headers = {"X-API-KEY": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=60)
print(response.status_code, response.json())
const response = await fetch("https://www.osintcat.net/api/modules", {
headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());
<?php
$curl = curl_init("https://www.osintcat.net/api/modules");
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/modules", nil)
req.Header.Set("X-API-KEY", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}
{
"modules": [
{
"id": "universal-breach-search",
"name": "Universal Breach Search",
"category": "Breach Data",
"enabled": true,
"access_level": "public",
"allowed_plans": [],
"accessible": true,
"locked": false
}
],
"user": {
"plan": "investigator",
"role": "user",
"beta_access": false
}
}
Lists every module with its current state and whether your account can use it. Use it to check access before calling a lookup: a lookup for a module your plan does not include is refused with
See Errors for the responses every endpoint can return.
403 ACCESS_DENIED.
Headers
string
required
Your API key.
Usage
Does not count as a lookup. Needs theosint:read scope.
Example request
curl "https://www.osintcat.net/api/modules" \
-H "X-API-KEY: YOUR_API_KEY"
import requests
url = "https://www.osintcat.net/api/modules"
headers = {"X-API-KEY": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=60)
print(response.status_code, response.json())
const response = await fetch("https://www.osintcat.net/api/modules", {
headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());
<?php
$curl = curl_init("https://www.osintcat.net/api/modules");
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/modules", nil)
req.Header.Set("X-API-KEY", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}
Response
array
One entry per module.
Show properties
Show properties
string
Module id.
string
Display name.
string
Category it is listed under.
boolean
Whether the module is switched on.
string
public, beta, staff or nobody.array
Plans the module is limited to (empty: all plans).
boolean
Whether your account can use it right now.
boolean
Shown, but not usable on your plan.
object
{
"modules": [
{
"id": "universal-breach-search",
"name": "Universal Breach Search",
"category": "Breach Data",
"enabled": true,
"access_level": "public",
"allowed_plans": [],
"accessible": true,
"locked": false
}
],
"user": {
"plan": "investigator",
"role": "user",
"beta_access": false
}
}
Errors
| Status | Error | When |
|---|---|---|
| 401 | Unauthorized | Missing or unknown key. |
Was this page helpful?
⌘I
curl "https://www.osintcat.net/api/modules" \
-H "X-API-KEY: YOUR_API_KEY"
import requests
url = "https://www.osintcat.net/api/modules"
headers = {"X-API-KEY": "YOUR_API_KEY"}
response = requests.get(url, headers=headers, timeout=60)
print(response.status_code, response.json())
const response = await fetch("https://www.osintcat.net/api/modules", {
headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());
<?php
$curl = curl_init("https://www.osintcat.net/api/modules");
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/modules", nil)
req.Header.Set("X-API-KEY", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}
{
"modules": [
{
"id": "universal-breach-search",
"name": "Universal Breach Search",
"category": "Breach Data",
"enabled": true,
"access_level": "public",
"allowed_plans": [],
"accessible": true,
"locked": false
}
],
"user": {
"plan": "investigator",
"role": "user",
"beta_access": false
}
}