Skip to content

Backend Overview

The backend is a REST API built with Hono running on Bun.

Base URLs:

  • Local: http://localhost:8080
  • Production: https://api.lp-checker.com
  • Staging: https://staging.lp-checker.com

Interactive API Reference

A full interactive API reference with request/response schemas, try-it-out functionality, and example payloads is available at /docs on the API server, powered by Scalar. The underlying OpenAPI 3.0 spec is served at /openapi.json.

Response Format

All endpoints return JSON with a consistent shape:

json
// Success
{ "ok": true, "data": { ... } }

// Error
{ "ok": false, "error": { "code": "ERROR_CODE", "message": "Description" } }

Rate Limiting

All endpoints are rate-limited per IP address. Defaults:

  • Window: 15 minutes
  • Max requests: 1000 per window

The builder test-execute endpoint has an additional daily limit to prevent abuse.

Error Codes

CodeStatusDescription
VALIDATION_ERROR400Request body failed Zod validation
MISSING_TOKEN401No Authorization header provided
INVALID_TOKEN401JWT is invalid or expired
NOT_FOUND404Resource not found
CONFLICT409Resource already exists
INTERNAL_SERVER_ERROR500Unexpected server error