Home

Lodestone News API

This wiki is used to document the API available for this project. Detailed information for each endpoint can be accessed through the links on the side of this page.

Headers

The data served by this API is fetched from the official Lodestone every 15 minutes and then cached. More specifically, it is fetched at :05, :20, :35, and :50. These timings are subject to change. See here to verify the latest timings. Because the data is cached, you can use request headers to speed up your API calls. Below is an example of response headers from the API:

Cache-Control →must-revalidate, max-age=853
Date →Tue, 28 Aug 2018 19:50:47 GMT
Expires →Tue, 28 Aug 2018 20:05:01 GMT
Last-Modified →Tue, 28 Aug 2018 19:50:01 GMT
...

Based on these headers, we can see the data was last modified at 19:50, and expires at 20:05 when it is next refreshed. Because the data is not going to be refreshed until 20:05, we know that there is no point in querying the data again until that time, as the data will not change. To be more efficient, we can cache this time and query again later after it has passed.

We can also leverage this information with our request headers. For example, if we send request headers like the following:

If-Modified-Since: Tue, 28 Aug 2018 19:50:47 GMT

the API will return a status of 304 Not Modified. If we replace this date with the last time we called the API, we can easily determine if there are any new updates we need to handle.

Localization

Data is available for each category in all of the locales supported by the official Lodestone:

• NA
• EU
• FR
• DE
• JP

The examples in this wiki use the NA locale. To use a different locale, simply replace na in the request URL with your preferred locale.