Quickstart

Follow these steps to rapidly integrate RateShield into your application stack.

1. Get your API Key

Sign up for an account and navigate to your Dashboard to copy your API key. This key must be sent with all requests to the RateShield API.

2. Configure your endpoints

Define which endpoints you want to limit using the /config/rate/limit/details endpoint. You can configure cooldowns, maximum attempts, and ban limits.

curl -X POST "https://api.rateshield.com/config/rate/limit/details?db_dependency=default" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ban_num_of_attempts": 100,
    "max_attempts": 10,
    "cooldown": 60,
    "header": "x-forwarded-for"
  }'

3. Call the Rate Limit API

In your application middleware, make a fast call to our /per/endpoint path before executing your business logic.