🔌 API Reference

REST API endpoints for programmatic access to Linterman.

Base URL

https://api.linterman.com (or your self-hosted instance)

📋 Endpoints

POST/api/lint No Auth

Analyze a Postman collection

Request Body

{
  "collection": "Postman Collection JSON object"
}

Response

{
  "score": "number (0-100)",
  "issues": "array of issues",
  "stats": "statistics object"
}

Example (cURL)

curl -X POST https://api.linterman.com/api/lint \
  -H "Content-Type: application/json" \
  -d '{"collection": {...}}'
POST/api/lint/fix No Auth

Analyze and auto-fix a collection

Request Body

{
  "collection": "Postman Collection JSON object"
}

Response

{
  "fixed_collection": "Fixed collection object",
  "fixes_applied": "number",
  "before": "score and issues before",
  "after": "score and issues after"
}

Example (cURL)

curl -X POST https://api.linterman.com/api/lint/fix \
  -H "Content-Type: application/json" \
  -d '{"collection": {...}}'

🔐 Authentication

Currently, all endpoints are public and require no authentication. Authentication will be added in a future version for premium features.

⚡ Rate Limiting

Fair Use Policy

Please be reasonable with API usage. Excessive requests may be rate-limited.

🐛 Error Handling

HTTP Status Codes

  • 200 - Success
  • 400 - Bad Request (invalid JSON)
  • 500 - Internal Server Error

📚 Learn More