API Documentation

Comprehensive documentation for the Cursor Rules Hub API. Access our database of 326+ cursor rules programmatically with powerful search and filtering capabilities.

Base URL

cursor-rules-hub.haimc.xyz

Version

v1.0

Authentication

None Required

Quick Start

Get Started in 30 Seconds

1Make a GET request to /api/rules
2Add query parameters for filtering and searching
3Parse the JSON response and integrate into your app

Example Response

{
  "rules": [...],
  "pagination": {
    "total": 326,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

API Endpoints

Endpoints

GET/api/rules

Get All Rules

Retrieve a list of all cursor rules with optional filtering and pagination

Parameters

Name	Type	Required	Description
search	string	No	Search query for rule names and descriptions
category	string	No	Filter by category (e.g., "Frontend", "Backend")
tags	string	No	Comma-separated list of tags
limit	number	No	Number of results to return (default: 50, max: 100)
offset	number	No	Number of results to skip for pagination
sort	string	No	Sort field: "name", "rating", "downloads", "updated_at"
order	string	No	Sort order: "asc" or "desc" (default: "desc")

Example Request

curl -X GET "https://cursor-rules-hub.haimc.xyz/api/rules?search=react&category=Frontend&limit=10" \
  -H "Accept: application/json"

Example Response

{
  "rules": [
    {
      "id": "a1b2c3d4",
      "name": "React TypeScript Best Practices",
      "slug": "react-typescript-best-practices",
      "description": "Comprehensive rules for React with TypeScript development",
      "content": "# React TypeScript Rules\n\n...",
      "categories": ["Frontend", "React"],
      "tags": ["react", "typescript", "hooks", "components"],
      "author": "john_doe",
      "rating": 4.8,
      "downloads": 15420,
      "file_size": 2048,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-12-01T14:20:00Z"
    }
  ],
  "pagination": {
    "total": 326,
    "limit": 10,
    "offset": 0,
    "has_more": true
  },
  "meta": {
    "request_id": "req_123456789",
    "response_time_ms": 45
  }
}

GET/api/rules/{slug}

Get Single Rule

Retrieve detailed information about a specific cursor rule

Parameters

Name	Type	Required	Description
slug	string	Yes	Unique identifier for the rule

Example Request

curl -X GET "https://cursor-rules-hub.haimc.xyz/api/rules/react-typescript-best-practices" \
  -H "Accept: application/json"

Example Response

{
  "rule": {
    "id": "a1b2c3d4",
    "name": "React TypeScript Best Practices",
    "slug": "react-typescript-best-practices",
    "description": "Comprehensive rules for React with TypeScript development",
    "content": "# React TypeScript Rules\n\nThis rule set provides comprehensive guidelines for React development with TypeScript...\n\n## Key Features\n- Component structure\n- Hook usage\n- Type definitions\n- Performance optimization",
    "categories": ["Frontend", "React"],
    "tags": ["react", "typescript", "hooks", "components"],
    "author": "john_doe",
    "rating": 4.8,
    "downloads": 15420,
    "file_size": 2048,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-12-01T14:20:00Z",
    "related_rules": [
      {
        "id": "b2c3d4e5",
        "name": "Advanced React Patterns",
        "slug": "advanced-react-patterns",
        "rating": 4.6
      }
    ]
  },
  "meta": {
    "request_id": "req_123456790",
    "response_time_ms": 23
  }
}

GET/api/categories

Get Categories

Retrieve all available rule categories with rule counts

Example Request

curl -X GET "https://cursor-rules-hub.haimc.xyz/api/categories" \
  -H "Accept: application/json"

Example Response

{
  "categories": [
    {
      "name": "Frontend",
      "count": 89,
      "description": "Client-side development rules and configurations"
    },
    {
      "name": "Backend",
      "count": 67,
      "description": "Server-side development and API rules"
    },
    {
      "name": "DevOps",
      "count": 34,
      "description": "Infrastructure and deployment configurations"
    }
  ],
  "total_categories": 21,
  "meta": {
    "request_id": "req_123456791",
    "response_time_ms": 12
  }
}

GET/api/tags

Get Tags

Retrieve all available tags with usage statistics

Parameters

Name	Type	Required	Description
popular	boolean	No	Return only popular tags (used in 5+ rules)

Example Request

curl -X GET "https://cursor-rules-hub.haimc.xyz/api/tags?popular=true" \
  -H "Accept: application/json"

Example Response

{
  "tags": [
    {
      "name": "react",
      "count": 45,
      "category": "Frontend"
    },
    {
      "name": "typescript",
      "count": 38,
      "category": "Language"
    },
    {
      "name": "python",
      "count": 32,
      "category": "Language"
    }
  ],
  "total_tags": 46,
  "meta": {
    "request_id": "req_123456792",
    "response_time_ms": 18
  }
}

GET/api/search

Advanced Search

Perform advanced search with fuzzy matching and ranking

Parameters

Name	Type	Required	Description
q	string	Yes	Search query
fields	string	No	Fields to search: "name", "description", "content", "tags"
fuzzy	boolean	No	Enable fuzzy matching (default: true)
threshold	number	No	Minimum similarity score (0.0-1.0, default: 0.3)
limit	number	No	Number of results (default: 20, max: 50)

Example Request

curl -X GET "https://cursor-rules-hub.haimc.xyz/api/search?q=react%20hooks&fuzzy=true&limit=5" \
  -H "Accept: application/json"

Example Response

{
  "results": [
    {
      "rule": {
        "id": "a1b2c3d4",
        "name": "React Hooks Best Practices",
        "slug": "react-hooks-best-practices",
        "description": "Essential patterns for React hooks usage",
        "categories": ["Frontend"],
        "tags": ["react", "hooks", "javascript"],
        "rating": 4.9,
        "downloads": 8930
      },
      "score": 0.95,
      "matches": [
        {
          "field": "name",
          "value": "React Hooks Best Practices",
          "indices": [[0, 5], [6, 11]]
        }
      ]
    }
  ],
  "total_results": 12,
  "query_time_ms": 34,
  "meta": {
    "request_id": "req_123456793",
    "response_time_ms": 67
  }
}

Code Examples

JavaScript/Node.js

// Using fetch API
const response = await fetch('https://cursor-rules-hub.haimc.xyz/api/rules?search=react&limit=10');
const data = await response.json();

console.log(`Found ${data.rules.length} rules`);
data.rules.forEach(rule => {
  console.log(`- ${rule.name} (Rating: ${rule.rating})`);
});

// Using axios
const axios = require('axios');

const getRules = async (searchQuery) => {
  try {
    const response = await axios.get('https://cursor-rules-hub.haimc.xyz/api/rules', {
      params: {
        search: searchQuery,
        category: 'Frontend',
        sort: 'rating',
        order: 'desc'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching rules:', error.message);
  }
};

Python

import requests
import json

# Basic request
response = requests.get('https://cursor-rules-hub.haimc.xyz/api/rules')
data = response.json()

print(f"Found {len(data['rules'])} rules")
for rule in data['rules']:
    print(f"- {rule['name']} (Rating: {rule['rating']})")

# Advanced search with parameters
def search_rules(query, category=None, tags=None, limit=50):
    params = {
        'search': query,
        'limit': limit
    }
    
    if category:
        params['category'] = category
    if tags:
        params['tags'] = ','.join(tags)
    
    response = requests.get(
        'https://cursor-rules-hub.haimc.xyz/api/rules',
        params=params
    )
    
    if response.status_code == 200:
        return response.json()
    else:
        print(f"Error: {response.status_code}")
        return None

# Usage
results = search_rules('react', category='Frontend', tags=['typescript', 'hooks'])
if results:
    print(f"Total results: {results['pagination']['total']}")
    for rule in results['rules']:
        print(f"- {rule['name']}")
        print(f"  Tags: {', '.join(rule['tags'])}")
        print(f"  Downloads: {rule['downloads']}")
        print()

cURL

# Get all rules
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/rules" \
  -H "Accept: application/json"

# Search with filters
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/rules?search=react&category=Frontend&tags=typescript,hooks&limit=10" \
  -H "Accept: application/json"

# Get specific rule
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/rules/react-typescript-best-practices" \
  -H "Accept: application/json"

# Advanced search
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/search?q=react%20hooks&fuzzy=true&threshold=0.5" \
  -H "Accept: application/json"

# Get categories
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/categories" \
  -H "Accept: application/json"

# Get popular tags
curl -X GET "https://cursor-rules-hub.haimc.xyz/api/tags?popular=true" \
  -H "Accept: application/json"

Rate Limits

• Public API: 1000 requests per hour
• Search API: 500 requests per hour
• Burst limit: 20 requests per minute
• Rate limit headers included in responses

Best Practices

• Cache responses when possible
• Use pagination for large datasets
• Implement exponential backoff for retries
• Monitor rate limit headers

Need Help?

Documentation

Comprehensive guides and API reference

View Docs

GitHub Issues

Report bugs and request features

Open Issue

Community

Join discussions and get help

Join Discussion