itemdb API Guide
  1. Search
itemdb API Guide
  • Getting Started
  • 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
  1. Search

Search for an item

GET
https://itemdb.com.br/api/v1/search
It searchs... for an item.
You can send search filters as query params using the empty square bracket notation for arrays
You can use ! to deny an entry. Example: type[]=!nc&type[]=wearable will return items that are not NC but are wearable
When using hex color codes, make sure to encode the # to %23
eg:
returns all itens sorted by price:
/api/v1/search?sortBy=price&sortDir=desc
returns all wearable itens that are not NC:
/api/v1/search?type[]=!nc&type[]=wearable

Request

Query Params
s
string 
optional
Search Query. Can also be a hex color string
Example:
#fff000
limit
integer 
optional
Results per page limit
Default:
48
page
integer 
optional
Page number
Default:
1
category
array[string]
optional
Neopets Official Categories (or Types)
type
array[string]
optional
Special types, such as NC, Wearable etc..
Allowed values:
ncnppbwearableneohome
status
array[string]
optional
Item status
Allowed values:
activeno trade
color
string 
optional
filter by vibrant color using a hex color string
Example:
#ff0000
price
array[number]
optional
an array in the format [min, max]
>= 1 items<= 2 items
rarity
array[number]
optional
an array in the format [min, max]
>= 1 items<= 2 items
weight
array[number]
optional
an array in the format [min, max]
>= 1 items<= 2 items
estVal
array[number]
optional
an array in the format [min, max]
>= 1 items<= 2 items
sortBy
enum<string> 
optional
Allowed values:
namepricecolorweightaddedid
sortDir
enum<string> 
optional
Allowed values:
ascdesc

Responses

🟢200OK
application/json
Body
content
array[object (ItemData) {27}] 
optional
internal_id
number 
optional
itemdb internal id for this item
item_id
number  | null 
optional
Represents the id that Neopets uses for this item
name
string 
optional
description
string 
optional
image
string 
optional
item thumbnail url
image_id
string 
optional
represents the item's image filename without the file extension aka .gif
category
string  | null 
optional
item official "type"
rarity
number  | null 
optional
weight
number  | null 
optional
estVal
number  | null 
optional
Neopets Official Estimate Value for this item.
Does not reflect the actual item price
type
enum<string> 
optional
Represents whether is a NP, NC or Paint Brush item
Allowed values:
npncpb
Default:
np
isNC
boolean 
optional
whether is a Neocash Item
defaults to false if we don't have all the information about the item
isWearable
boolean 
optional
whether is an wearable Item
defaults to false if we don't have all the information about the item
isNeohome
boolean 
optional
whether is an neohome item
defaults to false if we don't have all the information about the item
status
enum<string> 
optional
item status
defaults to 'active' if we don't have all the information about the item
Allowed values:
activeno trade
comment
string  | null 
optional
any relevant comment about this item
color
object (itemColorData) 
optional
object with information about the vibrant color of this item.
findAt
object 
optional
Convenience links to find this item in places such as SDB, Shops, Shop Wizard, etc...
price
object (ItemPriceData) 
optional
Market value data for this item.
owls
object (OwlsData)  | null 
optional
Owls NC Value data
isMissingInfo
boolean 
optional
Whether there is missing data or not. Keep in mind that fields with default values may be incorrect even if this field is false
slug
string  | null 
optional
URL Slug
saleStatus
optional
canonical_id
integer  | null 
optional
When we have duplicates, one item is chosen as the Canonical one
useTypes
object (UseTypes) 
optional
firstSeen
string <date-time> | null 
optional
First time we seen an item. Only exists for items released after itemdb was created
mallData
optional
page
integer 
optional
current page
totalResults
integer 
optional
resultsPerPage
integer 
optional
aka: the limit
Example
{
    "content": [
        {
            "internal_id": 71,
            "image": "https://images.neopets.com/items/negg.gif",
            "image_id": "negg",
            "item_id": 8,
            "rarity": 45,
            "name": "Negg",
            "specialType": "trading",
            "isNC": false,
            "type": "np",
            "estVal": 4371,
            "weight": 3,
            "description": "A Negg is a Neopian delicacy.  *** WORTH 1 NEGG POINT AT THE NEGGERY ***",
            "status": "active",
            "category": "Food",
            "isNeohome": false,
            "isWearable": false,
            "color": {
                "hsv": [
                    28.643216080402,
                    98.02955665024629,
                    79.6078431372549
                ],
                "rgb": [
                    203,
                    99,
                    4
                ],
                "lab": [
                    53.63108729347468,
                    36.90719903461171,
                    61.33641181173597
                ],
                "hex": "#CB6304",
                "type": "vibrant",
                "population": 58
            },
            "findAt": {
                "safetyDeposit": "https://www.neopets.com/safetydeposit.phtml?obj_name=Negg&category=0",
                "shopWizard": "https://www.neopets.com/shops/wizard.phtml?string=Negg",
                "auction": "https://www.neopets.com/genie.phtml?type=process_genie&criteria=exact&auctiongenie=Negg",
                "trading": "https://www.neopets.com/island/tradingpost.phtml?type=browse&criteria=item_exact&search_string=Negg",
                "closet": null,
                "restockShop": "https://www.neopets.com/objects.phtml?type=shop&obj_type=1",
                "dti": null
            },
            "isMissingInfo": false,
            "price": {
                "value": 22450,
                "addedAt": "2023-03-23T06:32:55.181Z",
                "inflated": false
            },
            "comment": null
        }
    ],
    "page": 0,
    "totalResults": 0,
    "resultsPerPage": 0
}
Modified at 2025-03-02 19:24:05
Previous
Get Cooking Pot Recipes
Next
Get List Info
Built with