itemdb API Guide
    itemdb API Guide
    • Getting Started
    • API Access
    • Slugs
    • Widget
    • Widget Tabs Exemple
    • Item
      • Get latest items
        GET
      • Get an item
        GET
      • Get item's price history
        GET
      • Get item's auction history
        GET
      • Get item's restock history
        GET
      • Get item's trade history
        GET
      • Get items color palette
        GET
      • Get item's color palette
        POST
      • Get many items
        GET
      • Get many items
        POST
      • Get Item Drops Data
        GET
      • Get Dyeworks Variants
        GET
      • Get MME Paths
        GET
      • Get Item Effects
        GET
      • Get Cooking Pot Recipes
        GET
    • Search
      • Search for an item
        GET
    • Lists
      • Get List Info
        GET
      • Get List Item Info
        GET
      • Get List Item Data
        GET
    • Misc
      • Get all ways to change a Pet Color/Species
        GET
      • Get wearable preview
        GET
      • Get cached item's thumbnail
        GET
    • Schemas
      • Schemas
        • SaleStatus
        • ItemMallData
        • UseTypes
        • ListData
        • ListItemInfo
        • ItemData
        • itemColorData
        • ItemPriceData
        • OwlsData
        • ItemRestockData
        • ItemAuctionData
        • TradeData
        • TradeItem
        • UserList
        • ListItemInfo
        • ColorData
        • SearchFilters

    API Access

    Starting March 2026, we will be enforcing changes to our API usage.
    Server side applications will need an API Key to access our resources.
    Client-side applications (including userscripts) will require a session cookie, which requires a visit to itemdb.com.br every 24 hours (for non-logged-in users) or every 14 days (for logged-in users).

    Checking if changes are needed#

    During the transition period, our API will accept any requests. If your request is not compliant with the new rules it will be blocked in the future.
    You can check for the presence of x-itemdb-block header at the response. This indicates that changes are required to prevent future issues.
    Some endpoints are exempt from any changes (notably the Widget). You will notice the x-itemdb-skip header at those

    Client Side Applications#

    You will need to send cookies with your request. If using Fetch, you need to add credentials: "include"
    Some domains may need to be whitelisted to avoid CORS issues when using fetch. Hit us at lucca[at]itemdb.com.br if that's your case.
    Userscripts can leverage the GM_xmlhttpRequest function and probably no other changes are required.
    After the session expires, users will need to visit itemdb.com.br again to get a new session cookie. Until then the api will return status code401
    Be mindful when fetching items or you might trigger the Rate Limit. Learn more

    Server Side Applications#

    You will need to generate an API Token using an API Key. This key will be linked to your itemdb account and can be revoked if used against our Terms of Use
    Do NOT use API Tokens/Keys on client side (especially userscripts...)
    With your API Key in hands, hit the /api/auth/token endpoint sending your key using the x-itemdb-key header.
    You will receive a JSON Web Token (JWT) as response. Send this token using x-itemdb-token header.
    API Tokens are short lived, you will need to generate a new one every 60 minutes.
    Learn more about JWTs
    Each API Key starts with a default item limit. If your use case need a bigger limit hit us at lucca[at]itemdb.com.br
    You can use a function like this to get your tokens
    Modified at 2026-02-18 04:32:13
    Previous
    Getting Started
    Next
    Slugs
    Built with