Getting Started

Base URL

https://api.ilepbase.com/api/v1

All requests use standard HTTP. No authentication is required for the endpoints documented in this site.

Health Check

The health endpoint verifies service availability:

curl https://api.ilepbase.com/api/v1/health

Response:

{
  "success": true,
  "data": {
    "status": "ok",
    "service": "ilepbase-api",
    "version": "v1"
  },
  "timestamp": "2026-04-23T12:00:00.000Z"
}

Request Conventions

Pagination

Endpoints returning lists use page and pageSize query parameters:

curl "https://api.ilepbase.com/api/v1/genomes?page=1&pageSize=10"

Sorting

Sortable list endpoints accept sortBy and sortDirection:

curl "https://api.ilepbase.com/api/v1/genomes?sortBy=buscoCompletePct&sortDirection=desc"

Filtering

Many list endpoints support faceted filtering. For example, genome records can be filtered by family:

curl "https://api.ilepbase.com/api/v1/genomes?family=Papilionidae"

Full-text Search

Endpoints with a q parameter support full-text search across all indexed fields:

curl "https://api.ilepbase.com/api/v1/hostplants?q=abrostola"

Rate Limits

Public endpoints may be subject to rate limits. When limits are enforced, rate-limit status is exposed through X-RateLimit-* response headers.

The following public services apply additional per-IP limits:

• BLAST — async job polling is restricted to the submitting IP
• MMNet — maximum 3 concurrent identification requests per IP
• NicheBarcoding — job submission and polling are rate limited per IP

SDK & Tools

The API is a standard REST interface. It can be accessed with any HTTP client, including curl, fetch, axios, Python requests, or R httr. No dedicated SDK is required.