NestJS guide · Node.js SDK

NestJS rate limiting,with keys your customers own.

Import ReqKeyModule once. Every request is checked against the caller’s key, charged against their credits, and held to their plan’s limit before your controller runs.

Start building freeNode.js SDK docs
  • Keys issued per customer
  • Credits that refill
  • Limits per plan, not per process

Official SDKs with drop-in middleware for the stack you already run

  • Python
  • Node.js
  • Go
  • Rust
  • PHP
  • .NET
  • Java
API requests validated
100M+
Average key validation
<5ms
Average analytics ingest
<5ms
Check and log, end to end
<10ms

The usual NestJS rate limiter counts requests. It doesn’t know your customers.

The official ThrottlerModule registers named limits and a global ThrottlerGuard that counts requests per IP, with @Throttle and @SkipThrottle to override per route.

With @nestjs/throttlertoday
// app.module.ts — with @nestjs/throttlerimport { Module } from "@nestjs/common";
import { APP_GUARD } from "@nestjs/core";
import { ThrottlerGuard, ThrottlerModule } from "@nestjs/throttler";

@Module({
  imports: [ThrottlerModule.forRoot([{ ttl: 60000, limit: 10 }])],
  providers: [{ provide: APP_GUARD, useClass: ThrottlerGuard }],
})
export class AppModule {}
  • Tracks by IP unless you subclass the guard and override getTracker
  • In-memory storage by default — a shared storage adapter is needed for more than one instance
  • No API keys: issuing, hashing, scoping, and revoking them is still yours to build
  • No credit balance: a request can’t cost 5 on one route and 1 on another, or refill each month
  • One limit for everyone — no per-plan limits for Free, Pro, and Enterprise customers
  • No per-customer usage log to answer “why was I blocked?” or bill against
With ReqKey in NestJSone middleware
  • API keys issued per customer, prefixed, hashed, and revocable from the dashboard
  • A credit balance per customer — price each route, refill every hour, day, week, or month
  • Rate limits set per plan, shared by all of a customer’s keys, from 1 second to 24 hours
  • The same count on every worker, instance, and region — no Redis to run
  • Over the limit? A 429 with Retry-After, and no credits charged
  • Every request logged per customer — status, latency, endpoint — in under 5ms
Controllers receive the verdict with the @ReqKeyDecision() parameter decorator. See the code

NestJS in three steps, one of them code.

ReqKey runs inside your API, not in front of it. Your server asks one question per request and gets an answer in under 5ms.

  1. 1

    Install the SDK

    npm install reqkey

  2. 2

    Set your project key

    Copy it from the dashboard into REQKEY_PROJECT_KEY. It stays on your server.

  3. 3

    Add the NestJS middleware

    Every request is checked, charged, and logged before your handler runs.

app.module.tsnpm install reqkey
import { Controller, Get, Module } from "@nestjs/common";
import type { VerificationResult } from "reqkey";
import { ReqKeyDecision, ReqKeyModule } from "reqkey/nestjs";
 
@Controller("payments")
class PaymentsController {
  @Get()
  list(@ReqKeyDecision() decision: VerificationResult | undefined) {
    return { payments: [], creditsRemaining: decision?.creditsRemaining };
  }
}
 
@Module({
  imports: [
    ReqKeyModule.forRoot({
      projectKey: process.env.REQKEY_PROJECT_KEY,
      apiId: "api_payments",
      mode: "both",
      keyName: "x-startup-key",
    }),
  ],
  controllers: [PaymentsController],
})
export class AppModule {}
Also in Node.js: Express, Next.js, Fastify, Hono, KoaFull Node.js reference

Every request gets one of these answers

  • 200Valid key, credits charged — your handler runs
  • 402Out of credits
  • 403Key disabled, or not allowed on this API
  • 429Over the rate limit — no credits charged

Where ReqKey sits

Your customer
Your APIReqKey, under 5ms
Your handler

Responses go straight back to your customer. ReqKey sees the key check and the log line, nothing else.

Credits

Charge each route what it costs you.

A lookup can cost 1 credit and a render 5, from the same balance. Excluded paths are never validated, charged, or recorded. In Node.js:

Per-route credits · Node.js
// Exact paths or trailing-* prefixes: never validated, charged, or recorded
excludePaths: ["/health", "/openapi.json", "/docs/*", "/cron/*"]
 
// Or decide per request with a sync or async resolver
shouldProtect: ({ path }) => path.startsWith("/api/")
 
// Charge different endpoints differently (non-negative integers)
credits: ({ method, path }) => {
  if (method === "POST" && path === "/images") return 5;
  if (path.startsWith("/reports/")) return 2;
  return 1;
}

Rate limits

Set limits on plans, not in code.

Your NestJS code never hard-codes a number. Each plan carries its credits, refill, and rate limit; moving a customer to Pro changes all three with no deploy.

PlanCreditsRate limit
Free1,000 / month5 req / s
Pro50,000 / month50 req / s
Scale1,000,000 / month500 req / s
429Over the limit, a call is answered with Retry-After and costs nothing — no credits and no quota.

Example plans. You name them and pick the numbers.

Notes for NestJS teams hit in production.

A module, not a guard to subclass

ReqKeyModule.forRoot takes the same options as every other adapter. There is no tracker to override to count by customer.

The decision is injectable

@ReqKeyDecision() hands the verdict straight to your controller method, typed as VerificationResult.

Express or Fastify underneath

The module is registered in Nest, so it works whichever HTTP platform your app is built on.

NestJS rate limiting: the questions teams ask.

Something else? Ask the team or read the docs.

  • Yes. Exclude those paths from ReqKey and let the throttler cover anonymous traffic, while ReqKey handles keyed customer traffic.

  • Add @ReqKeyDecision() decision to a controller method and read decision?.creditsRemaining.

  • On their plan or on the customer (consumer) in ReqKey — a number of requests per window from 1 second to 24 hours, shared by all of that customer’s keys. Your NestJS code never hard-codes a limit, so upgrading a customer is a dashboard change, not a deploy.

  • A check averages under 5ms. ReqKey runs inside your app as middleware, not as a gateway in front of it, so responses go straight back to your customer.

  • You choose: fail closed and answer 503, or fail open and let requests through. Invalid keys are denied either way, and a validation is never retried, so no one is charged twice.

More Node.js guides.

Other languages

Ship API keys in NestJSin five minutes.

Free for your first 5 million requests every month. No card, no gateway, no rewrite.

Start building freeRead the docs