Welcome to FKApi
FKApi is a powerful Django REST API that provides comprehensive access to football kit information from clubs worldwide. Built with Django 5.0.4 and Django Ninja, it offers advanced search capabilities, caching, and ethical web scraping integration.Quickstart
Get started with your first API call in minutes
Installation
Complete installation and setup guide
API Reference
Explore available endpoints and schemas
GitHub Repository
View source code and contribute
Overview
FKApi provides a comprehensive database of football kits with rich metadata including:- 300,000+ Kits from clubs worldwide
- 5,000+ Clubs with logos and country data
- Seasons from historical to current (e.g., “2025-26”, “1996-97”)
- Brands including Nike, Adidas, Puma, and more
- Competitions with league and tournament information
- Color Analysis with primary and secondary color extraction
- Kit Types categorized from match kits to training wear
Key Features
Advanced Search
Trigram-based fuzzy search with accent-insensitive matching:- Find “Málaga” by searching “Malaga”
- Search clubs, kits, brands, and competitions
- Priority-based season ordering for relevant results
- Secondary team filtering (prioritizes first teams over B/Youth teams)
Performance & Caching
- Redis Caching: Configurable cache layers for optimal performance
- Bulk Endpoints: Retrieve multiple kits/clubs in a single request
- Pagination: Efficient handling of large datasets (default: 20 items/page, max: 100)
- Rate Limiting: 100 requests/hour per IP (configurable with whitelist support)
Data Management
- Ethical Scraping: Built-in respect for robots.txt and rate limits (2-5 second delays)
- Celery Integration: Optional background task processing for scalability
- Data Quality: Management commands for validation and cleanup
- Real-time Updates: Daily automated scraping for latest kit releases
API Capabilities
- RESTful Design: Clean, predictable endpoint structure
- JSON Responses: Standardized schemas with comprehensive metadata
- Optional Authentication: API key support via
X-API-Keyheader - Health Monitoring: Built-in health checks and metrics endpoints
- OpenAPI/Swagger: Auto-generated interactive API documentation
Technology Stack
Django 5.0.4
Modern web framework with ORM
Django Ninja
Fast, type-hinted REST framework
PostgreSQL 15+
Robust relational database
Redis 6+
Caching and task queuing
Celery
Optional async task processing
BeautifulSoup4
Web scraping capabilities
Current Version
Version 1.0.2 (Released: February 4, 2026) Recent updates include:- Bulk kits endpoint accepting 2-30 kits per request
- User collection API with pagination and caching
- IP whitelist support for rate limiting
- Enhanced security with HTML sanitization
- Improved Type_K categorization system
- Season search with priority-based ordering
FKApi starts with an empty database. You’ll need to populate it through ethical web scraping following the guidelines in the Getting Started documentation.
Use Cases
- Mobile Apps: Build football kit collection and browsing apps
- Analytics: Analyze kit design trends across seasons and brands
- E-commerce: Integrate kit data into merchandise platforms
- Research: Study branding patterns and color psychology in sports
- Fan Sites: Create comprehensive kit archives for clubs
Next Steps
Quick Start
Follow the Quickstart Guide to make your first API call in under 5 minutes
Full Installation
Set up a complete development environment with the Installation Guide
Community & Support
- Maintainer: sunr4y
- License: MIT
- Last Updated: March 3, 2026