API Documentation & Testing

Test our API endpoints and explore the comprehensive data available through our RESTful API

API Integration Test

Health Check

Components API

Manual Test

Instructions

Make sure the FastAPI backend is running on port 8000
Run: cd backend && uv run uvicorn main:app --reload
Click "Test API Connection" to verify the connection

API Documentation

Base URL

https://api.energyhardware.database/v1

Authentication

API requests require authentication using Bearer tokens. Include your token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Available Endpoints

GET/health

Check API status and health

GET/components

Retrieve energy hardware components with filtering options

Query Parameters:

• category - Filter by component category
• manufacturer - Filter by manufacturer
• limit - Number of results to return (default: 50)
• offset - Number of results to skip (default: 0)

GET/categories

Get all available component categories and their counts

GET/components/{id}

Get detailed information about a specific component

Rate Limits

API requests are limited to 1000 requests per hour per API key. Rate limit headers are included in all responses.

Response Format

All API responses are returned in JSON format with the following structure:

{ "data": { /* Response data */ }, "status": "success", "message": "Request completed successfully", "pagination": { /* Pagination info if applicable */ } }

← Back to Home