The API was significantly reworked as of Feb 2026.
The main changes are:
/putset and /putsheet were added as a way to upload sets/sheets and receive URL(s) back, rather than needing
to formulate resulting URLs yourself. This should be preferred over the old way of uploading sets./basedata, /fulldata, and /validateEmbed now have an optional url query parameter, which accepts a full
(appropriately encoded) URL. This means you no longer have to worry about URL parameters yourself. The old way of
specifying the various parameters still works, and explicit parameters will take precedence over those in the URL.
/fulldata?page=foo&onlySetIndex=1 is equivalent to /fulldata?url=${urlEncode(https://xivgear.app/?page=foo&onlySetIndex=1)}/basedata has an optional parameter to retrieve a single set as if it were a full sheet.The API is available to use for retrieving gear sheets and sets.
Ideally, you should ask the user for a full URL (rather than a partial URL), and then use the /fulldata or /basedata endpoint depending on your needs. /basedata returns only the "base" data, i.e. the user-specified data such as gear items and materia. /fulldata returns the full data, including derived information such as the computed stats.
Take your link, and plug it into the ?url= parameter of the /basedata or /fulldata endpoint.
Example:
https://xivgear.app/?page=sl|f9b260a9-650c-445a-b3eb-c56d8d968501&onlySetIndex=1https://api.xivgear.app/basedata?url=https%3A%2F%2Fxivgear.app%2F%3Fpage%3Dsl%7Cf9b260a9-650c-445a-b3eb-c56d8d968501%26onlySetIndex%3D1By using the API like this, you can future-proof your application against changes to the URL structure used by Xivgear, of which there are existing proposals to do so, and may happen in the future.
You can also plug in URL parameters directly, or combine both styles. For example, all of the following are equivalent:
https://api.xivgear.app/basedata?url=https%3A%2F%2Fxivgear.app%2F%3Fpage%3Dsl%7Cf9b260a9-650c-445a-b3eb-c56d8d968501%26onlySetIndex%3D1https://api.xivgear.app/basedata?page=sl|f9b260a9-650c-445a-b3eb-c56d8d968501&onlySetIndex=1https://api.xivgear.app/basedata?url=https%3A%2F%2Fxivgear.app%2F%3Fpage%3Dsl%7Cf9b260a9-650c-445a-b3eb-c56d8d968501%26onlySetIndex%3D2&onlySetIndex=1Note that if a parameter appears in both the URL and the query string, the query string parameter takes precedence. This allows you to do things like overriding the party bonus, regardless of what was in the original URL.
Note that both basedata and fulldata endpoints return a SheetStatsExport object, even if the underlying data is a single-set export.
The fulldata endpoint accepts some URL query parameters:
url - a full URL.page - a page path.partyBonus - override the party bonus. Specify as a number, i.e. ?partyBonus=3.onlySetIndex - override the set index. Specify as a number, i.e. ?onlySetIndex=2.The old way will continue to be supported for backwards compatibility, but it is recommended that you use the new way so that you don't need to do any work to support new URL types.
When you have a link such
as https://share.xivgear.app/share/cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf,
or the
equivalent https://xivgear.app/#/sl/cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf,
the cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf part is the sheet/set ID.
You can retrieve the data by GETing https://api.xivgear.app/shortlink/cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf.
The retrieved JSON data can then be interpreted according to the TSDocs. It is of type TopLevelExport, which then resolves to either SheetExport or SetExport, representing an exported gear planning sheet or individual gear set, respectively.
If you want something more equivalent to the Etro API which also returns derived information about a set
(e.g. computed stats of a set), rather than purely the user-specified information (like the items and materia), you can
use the https://api.xivgear.app/fulldata/ endpoint. You should not use this if not needed, as it is significantly
slower.
To use /fulldata/, specify either a set UUID or a bis link, e.g.:
The fulldata endpoint returns a SheetStatsExport object (even when the original data source was a single set, rather than a full sheet).