| Field | Type | Required | Description | Example |
|---|---|---|---|---|
identifier |
str | ✔️ | Identifier of your user, this can be their userId, an email, an ip or anything else. Wildcards ( * ) can be used to match multiple identifiers, More info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules | user_123 |
limit |
int | ✔️ | How many requests may pass in a given window. | 10 |
duration |
int | ✔️ | The window duration in milliseconds | 60000 |
namespace_id |
Optional[str] | ➖ | The id of the namespace. Either namespaceId or namespaceName must be provided | rlns_1234 |
namespace_name |
Optional[str] | ➖ | Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules | email.outbound |
async_ |
Optional[bool] | ➖ | Async will return a response immediately, lowering latency at the cost of accuracy. |