> ## Documentation Index
> Fetch the complete documentation index at: https://docs.osintcat.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Modules

> Every module and whether your account can use it

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 `403 ACCESS_DENIED`.

## Headers

**X-API-KEY** `string` *required*

Your API key.

## Usage

Does not count as a lookup.

Needs the `osint:read` scope.

## Example request

```bash cURL theme={null}
curl "https://www.osintcat.net/api/modules" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python Python theme={null}
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())
```

```javascript JS & TS theme={null}
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 PHP theme={null}
<?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;
```

```go Go theme={null}
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))
}
```

## SDK example

The same request with the [official SDKs](https://docs.osintcat.net/sdks.md). Each one reads your key from `OSINTCAT_API_KEY`.

```typescript JS & TS theme={null}
import { OsintCatClient } from "osintcat";

const client = new OsintCatClient(); // reads OSINTCAT_API_KEY

const result = await client.account.modules();
console.log(result);
```

```python Python theme={null}
from osintcat import OsintCat

client = OsintCat()  # reads OSINTCAT_API_KEY

result = client.account.modules()
print(result)
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"

	osintcatclient "github.com/OsintCatHQ/osintcat-go/client"
)

func main() {
	client := osintcatclient.NewClient() // reads OSINTCAT_API_KEY
	result, err := client.Account.Modules(context.Background())
	if err != nil {
		panic(err)
	}
	fmt.Printf("%+v\n", result)
}
```

```php PHP theme={null}
<?php
require __DIR__ . '/vendor/autoload.php';

use OsintCat\OsintCatClient;

$client = new OsintCatClient(); // reads OSINTCAT_API_KEY

$result = $client->account->modules();
echo json_encode($result, JSON_PRETTY_PRINT), PHP_EOL;
```

## Response

**modules** `array`

One entry per module.

**properties**

**id** `string`

Module id.

**name** `string`

Display name.

**category** `string`

Category it is listed under.

**enabled** `boolean`

Whether the module is switched on.

**access\_level** `string`

`public`, `beta`, `staff` or `nobody`.

**allowed\_plans** `array`

Plans the module is limited to (empty: all plans).

**accessible** `boolean`

Whether your account can use it right now.

**locked** `boolean`

Shown, but not usable on your plan.

**user** `object`

Your plan as the access check sees it.

**properties**

**plan** `string`

Plan id.

**role** `string`

Account role.

**beta\_access** `boolean`

Whether the account has beta access.

```json 200 theme={null}
{
  "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. |

See [Errors](https://docs.osintcat.net/api-reference/introduction.md#errors) for the responses every endpoint can return.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.