xivapi

XIVAPI

Final Fantasy XIV Game data API

Media & content#games--comics

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Final Fantasy XIV Game data API

Endpoints 7

assets

  • GETread an asset/asset?path=ui/icon/051000/051474_hr1.tex&format=jpgRead an asset from the game at the specified path, converting it into a usable format. If no valid conversion between the game file type and specified format…
  • GETcompose a map/asset/map/:territory/:indexRetrieve the specified map, composing it from split source files if necessary.

search

  • GETexecute a search query/searchFetch information about rows and their related data that match the provided search query.

sheets

  • GETlist sheets/sheetList known excel sheets that can be read by the API.
  • GETlist rows in a sheet/sheet/:sheetRead information about one or more rows and their related data.
  • GETread a sheet row/sheet/:sheet/:rowRead detailed, filterable information from a single sheet row and its related data.

versions

  • GETlist versions/versionList versions understood by the API.

API details

Authentication
None declared in the description
Operations
7 operations on 7 pathsGET 7
Main resources
sheets 3assets 2search 1versions 1
Response formats
application/json image/jpeg image/png image/webp
Description format
OpenAPI 3.1.0, API version 1-48c1413

How to test the XIVAPI in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the XIVAPI collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “read an asset” (GET /asset?path=ui/icon/051000/051474_hr1.tex&format=jpg), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the XIVAPI?

Final Fantasy XIV Game data API It is listed under Media & content and has 7 endpoints.

Who publishes the XIVAPI?

It is listed from xivapi's public API description (an OpenAPI document), not published by xivapi on Swastik Codes. Anyone who controls xivapi.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the XIVAPI?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the XIVAPI have?

7 operations on 7 paths (7 GET). The largest groups are sheets, assets, search, versions.

Is forking the XIVAPI free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.