NITROUS OSINT Library

The official NITROUS OSINT API wrapper written in TypeScript using Axios. This library provides an interface for interacting with open-source intelligence modules via the Nitrous OSINT API.

Installation

npm install nitrous.ts

Example Usage

import NITROUS from "nitrous.ts";

const nitrous = new NITROUS({ env: 'production' });

async function main(): Promise<void> {
  const modules = await nitrous.getModules();
  console.log(modules);
}

main();

Interfaces

Interfaces are located in lib/sdk/interface/ and aliased as @interface.

API Options

interface Options {
  env ? : string;  // API environment: 'production' (default) or 'sandbox'
}

Enums

Enums are located in lib/sdk/enum/ and aliased as @enum.

API Environments

enum Environment {
  production = 'osint.nitrous-oxi.de',
  sandbox    = 'sandbox.nitrous-oxi.de',
}

Methods

• Get all modules:
  Fetch all available OSINT modules across all categories.

  await getModules(): Promise<Module[]>;

• Query a specific module:
  Query a specific module within a category using a query (e.g., a username, email, IP, etc.).

  await queryModule(category: string, module: string, query: string): Promise<any>;

• Query all modules in a category:
  Query all modules within a specific category using a query (e.g., an email, domain, etc.).

  await queryModulesByCategory(category: string, query: string): Promise<any>;

• Fetch available module names by category:
  Fetch all available module names within a specific category.

  await getModulesByCategory(category: string): Promise<string[]>;

• Fetch available categories:
  Fetch all unique categories from the API.

  await fetchCategories(): Promise<string[]>;