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 the following servers are not supported due to world congestion: Gungnir, Bahamut, Chocobo, Mandragora, Shinryu and Balmung - Server Offline are likely due to login issues and will be re-attempted every hour.

Server Status Last Checked
Adamantoise ‼️ OFFLINE April 22, 2019 12:00
Cactuar ‼️ OFFLINE April 22, 2019 12:10
Coeurl ‼️ OFFLINE April 22, 2019 12:15
Faerie ‼️ OFFLINE April 22, 2019 12:20
Gilgamesh ‼️ OFFLINE April 22, 2019 12:25
Goblin Market Online April 22, 2019 03:00
Jenova Market Online April 22, 2019 02:50
Mateus Market Online April 22, 2019 02:55
Midgardsormr Market Online April 22, 2019 04:55
Sargatanas Market Online April 22, 2019 03:45
Siren Market Online April 22, 2019 03:50
Zalera Market Online April 22, 2019 05:05
Behemoth Market Online April 22, 2019 04:50
Brynhildr Market Online April 22, 2019 08:05
Diabolos Market Online April 22, 2019 03:30
Excalibur Market Online April 22, 2019 03:40
Exodus Market Online April 22, 2019 05:35
Famfrit Market Online April 22, 2019 03:35
Hyperion Market Online April 22, 2019 03:55
Lamia Market Online April 22, 2019 04:05
Leviathan Market Online April 22, 2019 04:40
Malboro Market Online April 22, 2019 04:45
Ultros Market Online April 22, 2019 05:00
Cerberus Market Online April 22, 2019 05:50
Lich Market Online April 22, 2019 05:40
Louisoix Market Online April 22, 2019 05:45
Moogle Market Online April 22, 2019 05:55
Odin Market Online April 22, 2019 07:00
Omega Market Online April 22, 2019 06:05
Phoenix Market Online April 22, 2019 06:55
Ragnarok Market Online April 22, 2019 06:50
Shiva Market Online April 22, 2019 06:35
Zodiark Market Online April 22, 2019 06:40
Aegis Market Online April 22, 2019 06:45
Atomos Market Online April 22, 2019 07:30
Carbuncle Market Online April 22, 2019 07:35
Garuda Market Online April 22, 2019 07:40
Kujata Market Online April 22, 2019 08:35
Ramuh Market Online April 22, 2019 09:30
Tonberry Market Online April 22, 2019 07:45
Typhon Market Online April 22, 2019 07:50
Unicorn Market Online April 22, 2019 07:55
Alexander Market Online April 22, 2019 08:55
Durandal Market Online April 22, 2019 08:40
Fenrir Market Online April 22, 2019 09:00
Ifrit Market Online April 22, 2019 08:45
Ridill Market Online April 22, 2019 08:50
Tiamat Market Online April 22, 2019 09:40
Ultima Market Online April 22, 2019 09:35
Valefor Market Online April 22, 2019 09:45
Yojimbo Market Online April 22, 2019 09:50
Zeromus Market Online April 22, 2019 10:30
Anima Market Online April 22, 2019 10:00
Asura Market Online April 22, 2019 09:55
Belias Market Online April 22, 2019 10:35
Hades Market Online April 22, 2019 10:40
Ixion Market Online April 22, 2019 10:55
Masamune Market Online April 22, 2019 10:45
Pandaemonium Market Online April 22, 2019 11:55
Titan Market Online April 22, 2019 10:50
Balmung ‼️ OFFLINE April 22, 2019 12:30
Gungnir ‼️ OFFLINE January 1, 1970 00:00
Bahamut ‼️ OFFLINE January 1, 1970 00:00
Chocobo ‼️ OFFLINE January 1, 1970 00:00
Shinryu ‼️ OFFLINE April 22, 2019 12:05