Market

Get in-game market board information for any server, at any time. Market data is tracked and updated behind the scenes and stored in ElasticSearch. This provides you with fast access to all Market Data on any server. Items update based on their sale frequency across all servers. The faster an item sells, the faster it updates. In addition usage on MogBoard v2 will also increase the update frequency.

Notice of usage

Mass Data Consideration
If you are interested in grabbing a lot of data, please consider what impact this may have on the service if you begin spamming it with requests. It is important that you know what you're doing and that you can work to the service. An abnormal amount of requests will very likely cause your key to be suspended. It may be enticing to think that because you have an API Key and can do lots of requests, that you should keep spamming the API. If you do this you are very likely to get banned, consider that item prices do not change that often (10-15 minutes minimum). If you need any help, jump into the discord.

Some servers are not supported
Due to world congestion, some servers are not on the API at this time. Please view the full supported servers at the bottom.


/market/[server]/item/[item_id] #

https://xivapi.com/market/Phoenix/item/3

Obtain the prices & history for an item on a specific server.

Param Description
max_history Limit the number of history results returned.

Response

{
	"History": [
		{
			"Added": 1553824455,
			"CharacterID": "(UUID) 218068bc-7fc4-4298-8730-f6212bb98918",
			"CharacterName": "FirstName LastName",
			"ID": "(sha1 hash) da39a3ee5e6b4b0d3255bfef95601890afd80709",
			"IsHQ": false,
			"PricePerUnit": 99,
			"PriceTotal": 77220,
			"PurchaseDate": 1553819274,
			"PurchaseDateMS": "1553819274000",
			"Quantity": 780
		},
	],
	"ID": "46_3",
	"ItemID": 3,
	"Prices": [
		{
			"Added": 1553871386,
			"CreatorSignatureID": null,
			"CreatorSignatureName": "",
			"ID": "(sha1 hash) da39a3ee5e6b4b0d3255bfef95601890afd80709",
			"IsCrafted": false,
			"IsHQ": false,
			"Materia": [],
			"PricePerUnit": 92,
			"PriceTotal": 105248,
			"Quantity": 1144,
			"RetainerID": "c33f54aa-47c4-4829-91af-e9d5792d3978",
			"RetainerName": "RetainerName",
			"StainID": 0,
			"TownID": 1
		},
	],
	"Server": 46,
	"Updated": 1553871386
}



/market/item/[item_id]?servers=[x,y,z] #

https://xivapi.com/market/item/3?servers=Phoenix,Lich,Moogle

Obtain the prices & history for an item on multiple servers or an entire Data-Center. The maximum number of servers is 15.

Param Description
servers A comma seperated listed of servers.
dc A Data-Center name, all servers in that DC will be returned, eg: ?dc=Chaos.
max_history Limit the number of history results returned.

Response

The response for this query is the same as querying a single server except the root is an object of server names with each entry being a single query, eg:

{
	"Lich": {
		"History": [],
		"ID": "35_3",
		"ItemID": 3,
		"Prices": [],
		"Server": 35,
		"Updated": 1553868851
	},
	"Moogle": {
		"History": [],
		"ID": "42_3",
		"ItemID": 3,
		"Prices": [],
		"Server": 42,
		"Updated": 1553868496
	},
	"Phoenix": {
		"History": [],
		"ID": "46_3",
		"ItemID": 3,
		"Prices": [],
		"Server": 46,
		"Updated": 1553871386
	}
}


Obtain the prices & history for multiple items on multiple servers or an entire Data-Center. The maximum number of items is 100.

This query works exactly the same as querying multiple servers however it is an array for each item, eg:

[
	{
		"Lich": {},
		"Moogle": {},
		"Phoenix": {}
	},
	{
		"Lich": {},
		"Moogle": {},
		"Phoenix": {}
	},
	{
		"Lich": {},
		"Moogle": {},
		"Phoenix": {}
	}
]


Returns every item ID that is sellable in the Market Board.



Get a list of market Search Categories.



Search will be coming to the market API after infrastructure has stabilised. The endpoint will accept full ElasticSearch Queries.



/search?indexes=item&filters=ItemSearchCategory.ID>=9 #

https://xivapi.com/search?indexes=item&filters=ItemSearchCategory.ID>=9

List of sellable items

We can use the Search endpoint to get a list of sellable items. The field ItemSearchCategory on an Item states what category it is in on the market board. All items will have an ID above or equal to 9. The ID's below these are top level categories (Weapons, Armor, medicine, Misc, etc)

You can combine the search API with custom queries and filters, along with the market endpoint to build some very powerful interfaces!


Server Status

At this time ALL JP Servers are offline.

To view which servers are live, please check the MogBoard Server Status page.