Skip to main content

API Overview

The DevRadar Public API provides programmatic access to technology compatibility data, project scanning, and badge generation.

Base URL

All endpoints use the v1 API version. Future versions will be announced with backward compatibility considerations.

Authentication

Most endpoints are public and do not require authentication:
  • POST /check - Public, rate-limited
  • GET /badge - Public, rate-limited
  • POST /scan - Public, rate-limited
Rate limiting is based on IP address. See Rate Limits for details.

Response Format

All successful responses include a version field:
Error responses follow a consistent format:

Available Endpoints

Quick Start

Check Compatibility

Scan Project

Get Badge

Rate Limiting

All endpoints are rate-limited to ensure fair usage: Rate limit headers are included in every response:
See Rate Limits for complete details.

CORS

The API supports CORS for browser-based requests:

Status Codes

Error Codes

See Errors for complete error handling documentation.

Technology Name Format

Use lowercase, simplified names:

SDKs

Official SDKs are coming soon:
  • JavaScript/TypeScript
  • Python
  • Go
For now, use the REST API directly with HTTP clients.

What’s Next


Ready to integrate? Check Endpoint Reference