API Documentation

This API is stable and no breaking changes are anticipated.

Current API (November 2022 onwards)

Set callerID to a string of the name of your add-on.

-- Returns how many postings on the auction house of a given
-- item identified by item name have failed
--   callerID: string
--   itemName: string
Journalator.API.v1.GetRealmFailureCountByItemName(callerID, itemName)

-- Returns how many postings on the auction house of a given
-- item identified by item name have succeeded
--   callerID: string
--   itemName: string
Journalator.API.v1.GetRealmSuccessCountByItemName(callerID, itemName)

-- Returns the last price you sold an item given by itemName
-- Returns the price in coppers, or nil if one wasn't found
--   callerID: string
--   itemID  : number
Journalator.API.v1.GetRealmLastSoldByItemName(callerID, itemName)

-- Returns the last price you purchased an item given by itemName
-- Returns the price in coppers, or nil if one wasn't found
--   callerID: string
--   itemID  : number
Journalator.API.v1.GetRealmLastBoughtByItemName(callerID, itemName)

March 2023

Journalator.API.v1.GetRealmLastBoughtByItemLink(callerID, itemLink)

May 2023

Journalator.API.v1.GetRealmMeanBoughtByItemName(callerID, itemName)
Journalator.API.v1.GetRealmMeanBoughtByItemLink(callerID, itemLink)

Journalator.API.v1.GetRealmMinBoughtByItemName(callerID, itemName)
Journalator.API.v1.GetRealmMinBoughtByItemLink(callerID, itemLink)

Journalator.API.v1.GetRealmMaxBoughtByItemName(callerID, itemName)
Journalator.API.v1.GetRealmMaxBoughtByItemLink(callerID, itemLink)

Journalator.API.v1.GetRealmMeanSoldByItemName(callerID, itemName)
Journalator.API.v1.GetRealmMinSoldByItemName(callerID, itemName)
Journalator.API.v1.GetRealmMaxSoldByItemName(callerID, itemName)