ReconLab SDK

Official JavaScript/TypeScript SDK for the ReconLab API - OSINT search and history management.

Installation

npm install @reconlab/sdk
# or
yarn add @reconlab/sdk

Quick Start

import ReconLabSDK from '@reconlab/sdk';

// Initialize the SDK with your API key
const sdk = ReconLabSDK.withApiKey('your-api-key-here');

Modules

The SDK is organized into modules for different API functionalities:

• OSINT - OSINT search functionality
• History - Search history management

API Reference

OSINT Module

Perform Search with API Key

const results = await sdk.osint.search('[email protected]');
console.log(`Found ${results.summary.totalResults} results in ${results.summary.totalDatabases} databases`);

Perform Search with Wallet Address

const results = await sdk.osint.searchWithWallet('[email protected]', 'wallet-address');

Search by Category

const socialResults = await sdk.osint.searchByCategory('username', 'Social Media');

Search by Field Types

const emailResults = await sdk.osint.searchByFieldTypes('[email protected]', ['email']);

Get Categories

const categories = await sdk.osint.getCategories('[email protected]');
console.log('Available categories:', categories);

History Module

Get Search History

const history = await sdk.history.getHistory('wallet-address', 50);
console.log(`Found ${history.total} history entries`);

Get Recent Searches

const recent = await sdk.history.getRecentSearches('wallet-address', 5);

Get Successful Searches

const successful = await sdk.history.getSuccessfulSearches('wallet-address', 20);

Get Failed Searches

const failed = await sdk.history.getFailedSearches('wallet-address', 20);

Get Searches by Query

const matching = await sdk.history.getSearchesByQuery('wallet-address', '[email protected]');

Delete History Entry

const result = await sdk.history.deleteHistoryEntry('wallet-address', 'history-id');
console.log(result.message);

Clear All History

const result = await sdk.history.clearHistory('wallet-address');
console.log(`Cleared ${result.deletedCount} history entries`);

Error Handling

The SDK throws errors for API failures, network issues, and invalid responses:

try {
  const results = await sdk.osint.search('[email protected]');
  // Process results
} catch (error) {
  console.error('Search failed:', error.message);
  
  if (error.message.includes('Authentication error')) {
    // Handle authentication issues
  } else if (error.message.includes('Rate limit exceeded')) {
    // Handle rate limiting
  } else if (error.message.includes('Network error')) {
    // Handle network issues
  }
}

TypeScript Support

The SDK is fully typed with TypeScript. Import types as needed:

import ReconLabSDK, { OsintSearchResponse, SearchHistory } from '@reconlab/sdk';

const sdk = ReconLabSDK.withApiKey('your-api-key');

const results: OsintSearchResponse = await sdk.osint.search('[email protected]');
const history: SearchHistory[] = (await sdk.history.getHistory('wallet-address')).data;

Advanced Usage

Using Individual Modules

import { ReconLabClient, OsintModule, HistoryModule } from '@reconlab/sdk';

const client = new ReconLabClient();
client.setApiKey('your-api-key');

const osint = new OsintModule(client);
const history = new HistoryModule(client);

const results = await osint.search('[email protected]');
const searchHistory = await history.getHistory('wallet-address');

License

MIT License

Support

For support, please open an issue on the GitHub repository or contact the ReconLab team.