Temporary API Documentation

This documentation page will only exist until a more explanatory one that looks good gets set up on mogboard.

Table of Contents

Current Listings and Currently-visible History

https://universalis.app/api/worldID/itemID

Example: https://universalis.app/api/74/26465

World ID 74 corresponds to Coeurl, and item ID corresponds to the Facet Tabard of Aiming. Each listing has the following properties:

creatorID: The hash of the crafter's content ID.

creatorName: The crafter's name.

hq: Whether or not the item is high-quality.

lastReviewTime: The time in milliseconds since the listing was checked by the seller.

listingID: The hash of the content ID of the listing.

materia: An array of materia values. These are not materia item IDs.

onMannequin: Whether or not the item for sale is on a mannequin in a player house.

pricePerUnit

quantity

retainerCity: The ID of the retainer's stationed city. Limsa Lominsa is 1, Gridania is 2, Ul'dah is 3, Ishgard is 4, Kugane is 7, and the Crystarium is 10.

retainerID: The hash of the retainer's content ID.

retainerName

sellerID: The hash of the seller's content ID.

stainID: The ID of the item's dye.

total: pricePerUnit * quantity

isCrafted: Whether or not it's crafted.

Each history entry has the following properties:

buyerName: The buyer's name.

hq: Whether or not the item is high-quality.

pricePerUnit

quantity

sellerID: The hash of the seller's content ID.

timestamp: The UNIX timestamp of the sale.

total: pricePerUnit * quantity

worldName: The name of the world.

Multi-item Queries

You can query multiple items at once by separating their IDs with commas.

Example: https://universalis.app/api/74/26465,4

World Names Instead of World IDs

You can query for a World Name instead of a World ID.

Example: https://universalis.app/api/Coeurl/26465

DC-Wide Queries

You can query the whole DC at once, as well.

Example: https://universalis.app/api/Crystal/26465

Extended History

https://universalis.app/api/history/worldID/itemID

Example: https://universalis.app/api/history/74/26465

World ID 74 corresponds to Coeurl, and item ID corresponds to the Facet Tabard of Aiming. The same advanced queries can be run as described above. This endpoint is primarily to be used for graphing.

Each entry has the following properties:

hq: Whether or not the item is high-quality.

pricePerUnit

timestamp: The UNIX timestamp of the sale.

Entry-Limiting

You can request fewer entries using a query parameter.

Example: https://universalis.app/api/history/74/26465?entries=1

Content IDs

https://universalis.app/api/extra/content/contentID

Example: https://universalis.app/api/extra/content/32jfd98234fjwioehio4

This endpoint allows you to look up what limited data is available associated with a content ID.

TODO: How does this work, exactly?

Stats - Upload History

https://universalis.app/api/extra/stats/upload-history

https://universalis.app/api/extra/stats/upload-history

This endpoint allows you to see how many uploads occurred over the past 30 days.

The smaller indices describe more recent days.

Entry-Limiting

You can request fewer entries using a query parameter.

Example: https://universalis.app/api/extra/stats/upload-history?entries=1

Stats - Recently Updated

https://universalis.app/api/extra/stats/recently-updated

https://universalis.app/api/extra/stats/recently-updated

This endpoint provides the item IDs of the most-recently updated items on the website.

The smaller indices describe more-recently updated items.

Entry-Limiting

You can request fewer entries using a query parameter.

Example: https://universalis.app/api/extra/stats/recently-updated?entries=1

Stats - Least-Recently Updated

https://universalis.app/api/extra/stats/least-recently-updated

https://universalis.app/api/extra/stats/least-recently-updated

This endpoint provides the item IDs of the least-recently updated items on the website.

The smaller indices describe less-recently updated items.

Entry-Limiting

You can request fewer entries using a query parameter.

Example: https://universalis.app/api/extra/stats/least-recently-updated?entries=1

World and DC Filtering

You can request data for a World or whole DC using a query parameter. World names can also be provided as described above. If both parameters are provided, the World will take priority if it is not 0.

Example: https://universalis.app/api/extra/stats/least-recently-updated?world=74

Example: https://universalis.app/api/extra/stats/least-recently-updated?world=Coeurl

Example: https://universalis.app/api/extra/stats/least-recently-updated?dcName=Crystal