Home Docs Apps |

API & Developer Keys

To use the API you must have a valid developer key. This is appended onto any requests either via the url or as part of your JSON payload. An API will provide you with your rate-limiting and allow you access to the entire API.

You can get a key from: Apps


Usage

You can use it in the url as a GET param:

https://xivapi.com/item/1675?key=a1b2c3d4e5f6g7h8

You can also pass it as a JSON payload

{
    key: "a1b2c3d4e5f6g7h8"
}

Rate Limiting

The API will deny requests that go above your rate limit. A new key will have a limited amount of requests for the first hour, then it will be bumped to a full app amount.

Limited 2 requests a second
Full 10 requests a second
If you need more, please talk to @vekien on Discord.

Burst

Your burst is 2x your rate limit until you hit your burst then it will reduce to your normal rate limit. Once 5 seconds of no traffic has occurred from the same source your burst will go back up to 2x your rate limit.

To illustrate this, Imagine these requests with a 5/req/second limit:

Request 1  @ 0 second - OK
Request 2  @ 0 second - OK
Request 3  @ 0 second - OK
Request 4  @ 0 second - OK
Request 5  @ 0 second - OK
Request 6  @ 0 second - OK - Burst
Request 7  @ 0 second - OK - Burst
Request 8  @ 0 second - OK - Burst
Request 9  @ 0 second - OK - Burst
Request 10 @ 0 second - OK - Burst
Request 11 @ 0 second - Rate Limited
Request 12 @ 1 second - OK
Request 13 @ 1 second - OK
Request 14 @ 1 second - OK
Request 15 @ 1 second - OK
Request 16 @ 1 second - OK
Request 17 @ 1 second - Rate Limited
Request 18 @ 1 second - Rate Limited
Request 19 @ 1 second - Rate Limited
Request 20 @ 1 second - Rate Limited

Google Analytics

The API allows you track your requests using Google Analytics, this provides you all the nice real-time, historic hits and event tracking out the box.

Create a new property in your Google Analytics and attach the Tracking ID to your app dashboard.

Crawling and misuse

Do you want all the data? Fancy crawling the API? Rip the lot!

Step back. Don't. Your account will be banned without any warning. If you want all the data then it's all available to you, you have the game installed right!? Rip all the data from your game files!

To get started with datamining, visit: viion/ffxiv-datamining on Github