Search
Search documentation and content across the FixFX platform.
The Search API provides powerful search capabilities across all FixFX documentation, guides, and content. Built on Fumadocs search infrastructure, it offers fast, relevant results with advanced filtering and ranking.
Overview
The Search API enables comprehensive search functionality across the FixFX platform:
- Documentation Search - Find content across all documentation sections
- Code Examples - Search through code snippets and examples
- API References - Locate specific API endpoints and methods
- Framework Guides - Search framework-specific documentation
- Troubleshooting - Find solutions to common problems
The search system provides:
- Real-time search suggestions
- Relevance-based ranking
- Category and section filtering
- Highlighted search results
- Fast response times with optimized indexing
Base URL
Authentication
The Search API is public and doesn't require authentication. Results are based on publicly available documentation.
Endpoints
GET /api/search
Performs a search query across all indexed content.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
q | string | Search query string | Required |
limit | number | Maximum number of results (max 100) | 20 |
offset | number | Number of results to skip | 0 |
category | string | Filter by content category | All categories |
section | string | Filter by documentation section | All sections |
type | string | Filter by content type (page , heading , text ) | All types |
highlight | boolean | Include search term highlighting | true |
suggest | boolean | Include search suggestions | false |
Response Format
Example Usage
Use Cases
Smart Search Interface
Content Discovery
Search Analytics
Search Optimization
Index Coverage
The search index includes:
- All documentation pages and sections
- Code examples and snippets
- API endpoint descriptions
- Framework-specific guides
- Troubleshooting content
- Best practices and tips
Ranking Factors
Search results are ranked based on:
- Exact matches in titles and headings
- Term frequency in content
- Content type (pages ranked higher than fragments)
- Recency of last update
- User engagement metrics
- Category relevance to query context
Performance Features
- Real-time indexing for immediate content availability
- Fuzzy matching for handling typos and variations
- Stemming for finding related word forms
- Stop word filtering for better relevance
- Result caching for common queries
Rate Limiting
- 300 requests per minute per IP address
- Burst allowance of 50 requests
- Search suggestions have separate, higher limits
Error Handling
Standard HTTP status codes:
200
: Success400
: Bad Request - Invalid query parameters429
: Too Many Requests - Rate limit exceeded500
: Server Error - Search service error
Example error response:
Best Practices
-
Query Optimization
- Use specific terms for better results
- Combine category filters with queries
- Implement search suggestions for user guidance
-
User Experience
- Debounce search input to reduce API calls
- Show search progress indicators
- Provide clear "no results" messaging
-
Performance
- Cache frequent search results
- Implement proper pagination
- Use appropriate result limits
-
Analytics
- Track popular search terms
- Monitor search success rates
- Identify content gaps from unsuccessful searches
Support
For questions about the Search API, please join our Discord. We can help with:
- Search integration
- Query optimization
- Result ranking issues
- Custom search implementations
The Search API is continuously improved based on user search patterns and feedback.
Use category filtering to help users find content faster in specific documentation sections.