REST API Reference
LimitYourAPI REST API reference. Authentication, rate limit checks, rule management, and analytics endpoints.
Base URL
https://api.v2.limityourapi.tech/api
Authentication
All API requests require Bearer token authorization:
`bash
Authorization: Bearer YOUR_API_KEY
`
Endpoint Reference
1. Post Check Limits
Verify rate limits for an identifier:
- Path:
POST /check - Payload:
`json
{
"endpoint": "/v1/users",
"token_count": 1,
"estimated_cost": 0.001
}
`
- Response:
`json
{
"allowed": true,
"remaining": 99,
"reset_in": 60,
"limit": 100
}
`
Rate Limiting Glossary
Understanding rate limiting terminology helps teams communicate requirements clearly across engineering, product, and security teams for REST API.
| Term | Definition |
|---|---|
| Rate limit | Maximum number of requests allowed in a time window |
| Quota | Total allowed usage over a longer period (daily, monthly) |
| Token bucket | Algorithm allowing bursts up to bucket capacity with steady refill |
| Sliding window | Counts requests in a rolling time window for precise enforcement |
| Fail-open | Allow requests when rate limiter is unreachable |
| Fail-closed | Reject requests when rate limiter is unreachable |
| 429 HTTP Status | Standard HTTP status code for rate limit exceeded |
| Retry-After | Header indicating seconds until client should retry |
| Identifier / Key | Unique string identifying the client for rate limiting |
| API Gateway | Entry point routing all traffic to internal microservices |
| IP Reputations | Score assessing request threat based on origin network behavior |
| Token Weight | Weight assigning varying resource costs to API requests |
Next Steps
Ready to protect your API with production-grade rate limiting? Here is the recommended path for REST API:
- Create a free account at [limityourapi.tech/login](/login) — no credit card required for the Hobby tier
- Generate an API key in the dashboard under API Keys
- Install the SDK: Run
npm install limityourapiand follow the [Node.js](/sdk/nodejs) guide - Follow the quick start guide at [/quickstart](/quickstart) for a 2-minute integration
- Configure rules in the dashboard for your highest-risk endpoints first
- Monitor analytics to tune limits based on real traffic patterns
Questions? Read the [documentation](/docs) or explore the [rate limiting education hub](/learn) for deep technical guides on algorithms, architecture, and production patterns.
Frequently Asked Questions
What is API rate limiting?
API rate limiting controls how many requests a client can make in a given time window. It protects backends from abuse, ensures fair usage across tenants, and prevents cost overruns from traffic spikes or malicious bots.
Why use Redis for rate limiting?
Redis provides sub-millisecond latency, atomic operations via Lua scripts, and horizontal scalability. Centralized state ensures consistent limits across distributed application servers.
How fast is LimitYourAPI?
LimitYourAPI delivers rate limit decisions in under 15ms globally using atomic Redis Lua scripts. This is fast enough for inline middleware without adding perceptible latency to API responses.
Does LimitYourAPI support token bucket and sliding window?
Yes. LimitYourAPI supports token bucket, sliding window, fixed window, and cost-aware algorithms. You can configure per-route strategies without changing infrastructure.
Can I migrate from express-rate-limit or Cloudflare?
Yes. LimitYourAPI provides migration guides with before/after code examples for express-rate-limit, Cloudflare, Upstash, Arcjet, and other providers.