> ## Documentation Index
> Fetch the complete documentation index at: https://docs.limitly.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Limitly

> API Key management, plans, users and request validation for your API

<Hero title="Limitly" subtitle="Simple and powerful rate limiting for your API" image="/images/hero-light.png" darkImage="/images/hero-dark.png" />

<CardGroup cols={2}>
  <Card title="Easy Integration" icon="bolt" href="/quickstart">
    Get started with Limitly in minutes. Simple SDK and REST API for seamless integration.
  </Card>

  <Card title="Flexible Plans" icon="list" href="/sdk/plans">
    Create custom plans with different request limits, periods, and features for your users.
  </Card>

  <Card title="Real-time Validation" icon="shield-check" href="/sdk/validation">
    Validate requests in real-time with comprehensive usage tracking and analytics.
  </Card>

  <Card title="API Key Management" icon="key" href="/sdk/api-keys">
    Generate, manage, and track API keys with detailed usage statistics and history.
  </Card>
</CardGroup>

## What is Limitly?

Limitly is a comprehensive rate limiting solution designed specifically for API-first startups and developers. It provides:

* **API Key Management**: Generate and manage API keys for your users
* **Plan Management**: Create flexible plans with different limits and features
* **User Management**: Track and manage user accounts and their usage
* **Request Validation**: Real-time validation of API requests with detailed analytics
* **Usage Analytics**: Comprehensive insights into API usage patterns

## Key Features

<CardGroup cols={1}>
  <Card title="Simple SDK Integration">
    ```typescript theme={null}
    import { Limitly } from '@limitly/limitly-js';

    const limitly = new Limitly({
      apiKey: 'your_limitly_api_key'
    });

    // Validate a request
    const result = await limitly.validation.validate(
      'user_api_key',
      '/api/users',
      'GET'
    );
    ```
  </Card>
</CardGroup>

## Quick Start

1. **Install the SDK**
   ```bash theme={null}
   npm install @limitly/limitly-js
   ```

2. **Initialize the client**
   ```typescript theme={null}
   import { Limitly } from '@limitly/limitly-js';

   const limitly = new Limitly({
     apiKey: 'your_limitly_api_key'
   });
   ```

3. **Validate requests**
   ```typescript theme={null}
   const result = await limitly.validation.validate(
     'user_api_key',
     '/api/users',
     'GET'
   );

   if (result.success) {
     // Request allowed
   } else {
     // Request denied
   }
   ```

<CardGroup cols={2}>
  <Card title="View Documentation" icon="book-open" href="/quickstart">
    Get started with our comprehensive guides and tutorials.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/sdk">
    Explore the complete API reference and SDK documentation.
  </Card>
</CardGroup>
