About Flarestone

Flarestone is a Lodestone scraper running on Cloudflare Workers built by (and primarily for) XIVAuth. It uses XPaths and a series of transform operations to parse the HTML returned by the Lodestone and to convert it into JSON for easier processing by applications and online services. It boasts an extremely detailed response format, capturing as much information as is possible from the Lodestone directly.

Accessing Flarestone

Flarestone is not an open API. It is only available to developers who have requested (and been approved for) an API key. API keys are granted solely at the discretion of the XIVAuth project and access is not guaranteed. Flarestone is not considered part of the XIVAuth API, and API keys for one service will not work for the other. However, XIVAuth does offer (limited) Flarestone data as part of its own API surface.

As part of requesting an API key, you will be asked to provide information that will be attached to every request made to Lodestone on your behalf via the X-Flarestone-Client header. This measure exists to force some level of accountability and to distinguish Lodestone requests made by different sources should Square Enix reach out with concerns. In addition, Flarestone enforces very strict rate limits and very aggressive caching to try to mitigate concerns.

Flarestone may not be used for commercial purposes.

Supported Features

Flarestone currently supports:

Accessing base character information
Accessing detailed information about character levels
Accessing base Free Company information
Accessing lists of Free Company members and role hierarchies.