Rate Limiting

Endpoints for managing rate limits and token buckets.

Check rate limits or refill tokens

Authorization

ApiKeyAuth

X-Borrow-Api-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId?string

The ID of the user to rate limit. Used to keep track of users across requests.

key?string

The key to identify your protected resource. Used to keep track of requests to the same resource.

action*string

Whether to completely refill one or multiple users' tokens (refillTokens) or check if the user can proceed with the request (check).

Value in"check" | "refillTokens"

limiters*array<>

Up to 4 limiters of unique types to check against.

Itemsitems <= 4

Response Body

`application/json`

curl -X POST "https://api.borrow.dev/v1/limiter" \  -H "Content-Type: application/json" \  -d '{    "userId": "user_123",    "key": "login",    "action": "check",    "limiters": [      {        "type": "fixed",        "maxRequests": 10,        "interval": "minute"      }    ]  }'

{
  "result": "success",
  "message": "string",
  "tokensLeft": 0
}

{
  "result": "error",
  "message": "string",
  "error": "UNAUTHORIZED"
}

{
  "result": "error",
  "message": "string",
  "error": "UNAUTHORIZED"
}

{
  "result": "error",
  "message": "string",
  "error": "UNAUTHORIZED"
}

Rate Limiting

Check rate limits or refill tokens

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`