Introduction
The Football Kit Archive API is a comprehensive REST API for managing and retrieving football kit information from around the world. This API provides access to a vast database of football kits, clubs, seasons, brands, and competitions.Base URL
All API endpoints are prefixed with/api/:
localhost:8000 with your production domain.
Key Features
- Advanced Search: Trigram-based fuzzy search for clubs, kits, and brands
- Accent-Insensitive: Find “Málaga” by searching “Malaga”
- Caching: Responses are cached for optimal performance
- Pagination: Efficient pagination for large result sets
- Rate Limiting: Built-in protection against abuse
- Optional Authentication: API key authentication can be enabled
API Documentation
Interactive Documentation
The API provides interactive documentation powered by Swagger/OpenAPI:- Swagger UI:
http://localhost:8000/api/docs - OpenAPI Schema:
http://localhost:8000/api/openapi.json
Complete Project Documentation
For comprehensive project documentation including setup guides, ethical scraping practices, troubleshooting, and architecture:Quick Start
Health Check
Verify the API is running:Search for Clubs
List Kits
Get Kit by ID
API Endpoints
The API is organized into the following categories:System
- Health checks and monitoring
- API metrics and statistics
- Documentation information
Clubs
- Search clubs by name
- Get club details
- Retrieve club kits
- Random clubs for discovery
Kits
- List kits with filtering
- Search kits by name and year
- Get kit details
- Bulk kit retrieval
- Random kits for discovery
Seasons
- Search seasons by year
- Get club seasons
Brands
- Search brands by name
Competitions
- Search competitions
User Collection
- Scrape and retrieve user collections from FootballKitArchive
Next Steps
Authentication
Learn how to enable and use API key authentication
Rate Limiting
Understand rate limits and how to handle them
Pagination
Learn how to paginate through large result sets
Error Handling
Understand error responses and status codes