Quickstart

Step 1: Create a Project

Go to the Throttlr Dashboard and sign in with Google.
Click New Project and give it a name (e.g. my-api).
Your project is created with a unique API Key — copy it from the API Key tab.

Your API key is only shown once in plaintext at creation time. Store it in your environment variables immediately.

Step 2: Create a Rate Limit Rule

In your project dashboard, go to the Rules tab and click New Rule.

Field	Example Value	Description
Name	`send_email`	A unique identifier for this rule, used in SDK calls
Limit	`5`	Max requests allowed per window
Window	`60`	Time window in seconds
Algorithm	`FIXED_WINDOW`	Fixed or Sliding Window

Rule names are what you pass to limiter.check(). Use descriptive names like login_attempt or generate_report.

Step 3: Install the SDK

npm install @throttlr/sdk

pnpm add @throttlr/sdk

yarn add @throttlr/sdk

Step 4: Initialize & Check

import { RateLimiter } from "@throttlr/sdk";

const limiter = new RateLimiter({
  apiKey: process.env.THROTTLR_API_KEY!,
  baseUrl: "https://repoapi-production-fcf8.up.railway.app/sdk",
});

// In your route handler:
const result = await limiter.check({
  identifier: "user_123",   // Unique user or IP
  rule: "send_email",       // Must match a rule in your dashboard
});

if (!result.allowed) {
  return res.status(429).json({ error: "Too many requests" });
}

// Continue with your logic...

Step 5: View Logs

Head to the Logs tab in your project dashboard. You’ll see every request checked by the SDK in real time, with status (✅ Allowed / ❌ Blocked), identifier, rule name, and timestamp.

What’s Next?

SDK Reference

Full API for check() and RateLimitermiddleware

Algorithms Explained

Fixed Window vs Sliding Window — which should you use?

Getting Started

Concepts

SDK

Dashboard

Step 1: Create a Project

Step 2: Create a Rate Limit Rule

Step 3: Install the SDK

Step 4: Initialize & Check

Step 5: View Logs

What’s Next?

SDK Reference

Algorithms Explained

​Step 1: Create a Project

​Step 2: Create a Rate Limit Rule

​Step 3: Install the SDK

​Step 4: Initialize & Check

​Step 5: View Logs

​What’s Next?

SDK Reference

Algorithms Explained

Step 1: Create a Project

Step 2: Create a Rate Limit Rule

Step 3: Install the SDK

Step 4: Initialize & Check

Step 5: View Logs

What’s Next?