Skip to content

API Reference

Base URL: https://data.xivdyetools.app/v1

All responses use the { success, data, meta } envelope. See Responses for the full spec.

Phase 1 Endpoints

MethodPathDescription
GET/v1/dyesList all dyes with filtering and sorting
GET/v1/dyes/:idLookup by itemID, stainID, or Facewear ID
GET/v1/dyes/stain/:stainIdLookup by stainID (explicit)
GET/v1/dyes/searchSearch dyes by name
GET/v1/dyes/categoriesList categories with dye counts
GET/v1/dyes/batchMulti-ID lookup (up to 50)
GET/v1/dyes/consolidation-groupsPatch 7.5 consolidation metadata
GET/v1/match/closestFind closest dye to a hex color
GET/v1/match/within-distanceFind dyes within a distance threshold

Health

bash
curl https://data.xivdyetools.app/health

Returns { "status": "ok", "timestamp": "..." } — no envelope, no auth, no rate limiting.

Not affiliated with Square Enix.