API / V1

Public API documentation

All endpoints are read-only and return JSON. The base URL is https://armappindex.com. Cross-origin GET requests are allowed. Successful responses are cacheable; validation errors use a stable {"error":{"code":"…","message":"…"}} shape.

GET /api/v1/software

List software. Optional: keyword, platform, category, limit, offset.

GET /api/v1/software/{slug}

Return one software record with all compatibility reports.

GET /api/v1/platforms

List platform definitions and report counts.

GET /api/v1/compatibility

List reports. Optional: software, platform, os_version, limit, offset.

Pagination and validation

limit defaults to 20 and accepts 1–100. offset defaults to 0. Platform and software filters accept either an ID or slug. Unknown values and malformed pagination return HTTP 400.

Status semantics

compatibility_status is one of native, compatible, emulated, partial, unsupported, or unknown. evidence_type is separately one of official, tested, automated, community, or unknown. See the verification methodology before using a conclusion.

Usage policy

Use reasonable request rates and cache responses. The API has no uptime SLA. Edge rate limiting may be enabled as traffic grows; clients should handle HTTP 429 with exponential backoff.