Skip to content

API Reference

The iSearchFrom API is a REST API built with NestJS. All endpoints return JSON responses.

http://localhost:3000/v1

API requests require either a session cookie (for browser-based access) or an API key header.

Terminal window
curl -H "X-API-Key: your-api-key" https://api.example.com/v1/searches
{
"data": [...],
"pagination": {
"total": 100,
"hasMore": true,
"nextCursor": "abc123"
}
}
{
"code": "ERROR_CODE",
"message": "Human-readable error message"
}