API Reference
Lightfeed provides a powerful REST API to access your extracted web data programmatically. This section covers the available endpoints and authentication methods for working with the API.
Base URL
All API requests should be made to:
https://api.lightfeed.ai
Authentication
To authenticate with the Lightfeed API, include your API key in the request headers:
x-api-key: YOUR_API_KEY
You can create and manage your API keys from the Lightfeed dashboard under "API Keys".
Available Endpoints
📄️ Get Records
Get all records within a time range
📄️ Search Records
Apply semantic search, filters, and timestamp range
📄️ Filter Records
Apply advanced filters and timestamp range
SDK Libraries
For easier integration, we provide official client libraries:
Error Handling
The API uses standard HTTP status codes to indicate the success or failure of requests:
200 OK
: Request successful400 Bad Request
: Invalid request parameters401 Unauthorized
: Invalid or missing API key403 Forbidden
: The API key doesn't have permission to access the resource404 Not Found
: The requested resource doesn't exist429 Too Many Requests
: Rate limit exceeded500 Internal Server Error
: Something went wrong on our end
Rate Limits
The Lightfeed API has the following rate limits:
- 500 requests per minute for Pro plans
- 100 requests per minute for Starter plans
- 10 requests per minute for Free plans
Rate limit headers are included in all API responses:
X-RateLimit-Limit
: The rate limit ceiling for your account
If you exceed these limits, you'll receive a 429 Too Many Requests
response.
Need Help?
If you have any questions or need assistance with the API, please contact our support team.