Setup Overview

Get started with Regulus in just a few steps. This guide walks you through creating your organization, obtaining your API key, installing the SDK, and integrating transaction monitoring into your codebase.

1. Create Your Organization

Sign in to your Regulus dashboard and create a new organization. Each organization has its own API keys, members, and monitoring rules.

{
  "name": "My Web3 Project"
}

2. Get Your API Key

After creating an organization, navigate to its Organization Settings page to generate your API key. You’ll use this key to authenticate requests from your SDK or backend.

3. Install the SDK

Install theRegulus SDK to start sending transactions and receiving alerts.

npm install @regulus/sdk

4. Integrate the SDK

Get your API key from the organization dashboard and implement the SDK in your codebase to start sending transaction data for monitoring.

const RegulusSDK = require('regulus-sdk');

const apiKey = process.env.API_KEY; 
const organizationId = process.env.ORGANIZATION_ID;
const sdk = new RegulusSDK(apiKey, organizationId);

const transactionData = {
  transaction_id: "txn_12345",
  user_id: "user_001",
  amount: 1000,
  currency: "USD",
  country: "US",
  timestamp: new Date().toISOString(),
};

5. Set Up Rules

Define rules directly in the dashboard or through the API to trigger alerts for suspicious patterns, transaction thresholds, or specific addresses.

6. View Results

Check alerts and logs in real-time from the dashboard or via the /alerts endpoint. You can also export alertes for compliance and reporting.