Ratelimit
Ratelimit an action based on an identifier.
Changelog
Date | Changes |
---|---|
Mar 16 2024 | Introduced endpoint |
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The window duration in milliseconds
x > 1000
Identifier of your user, this can be their userId, an email, an ip or anything else.
How many requests may pass in a given window.
x > 0
Async will return a response immediately, lowering latency at the cost of accuracy.
Expensive requests may use up more tokens. You can specify a cost to the request here and we'll deduct this many tokens in the current window. If there are not enough tokens left, the request is denied.
Set it to 0 to receive the current limit without changing anything.
x > 0
Attach any metadata to this request
Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes.
Resources that are about to be accessed by the user
Response
How many requests are allowed within a window.
How many requests can still be made in the current window.
A unix millisecond timestamp when the limits reset.
Returns true if the request should be processed, false if it was rejected.
Was this page helpful?