Skip to content

Commit

Permalink
Write full documentation description
Browse files Browse the repository at this point in the history
  • Loading branch information
karashiiro committed Aug 3, 2021
1 parent 8a466dd commit 0b8ca8b
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions src/Universalis.Application/doc_description.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
There is a rate limit of 12 req/s (24 req/s burst) on the API, and 5 req/s (10 req/s burst) on the frontend.
To map item IDs to item names or vice versa, use <a href="https://xivapi.com">XIVAPI</a>.
To get a mapping of world IDs to world names, use <a href="https://github.com/xivapi/ffxiv-datamining/blob/master/csv/World.csv">this sheet.</a>
Welcome to the Universalis documentation page.
<br/>
There is a rate limit of 12 req/s (24 req/s burst) on the API, and 5 req/s (10 req/s burst) on the website itself.
To map item IDs to item names or vice versa, use <a href="https://xivapi.com/docs/Search#search">XIVAPI</a>.
To get a mapping of world IDs to world names, use <a href="https://xivapi.com/World">XIVAPI</a> or
<a href="https://github.com/xivapi/ffxiv-datamining/blob/master/csv/World.csv">this sheet.</a>
The <code>key</code> column represents the item ID, and the <code>Name</code> column represents the world name.
Note that not all listed worlds are available to be used &#8212; many of the worlds in this sheet are test worlds,
or Korean worlds (Korea is unsupported at this time).
<br/>
If you use this API for your projects, please consider supporting the website's ever-increasing bandwidth costs on
<a href="https://patreon.com/universalis">Patreon</a>, or making a one-time donation on
<a href="https://ko-fi.com/karashiiro">Ko-fi</a>.

0 comments on commit 0b8ca8b

Please sign in to comment.