Utility Search API
Threshr's Search API allows users to search for NFT collections based on utility.
Users supply a query term and API Key as part of an https GET request.
Request
URL
https://threshr.co/api-gateway/search (opens in a new tab)?
Parameters
All three parameters are optional and can be combined:
query allows users to perform a search based on a string.
category allows users to search based on category.
Possible categories are:
Merch, Events, Gaming, Conference, Discounts, Voting, Food, Drink, IP Rights, Apparel, Video, Music/Audio, Virtual Property, Airdrops, Sports, eSports, Sustainability, Staking
pageNum allows users to retrieve pages of query results.
Headers
One header is required to supply your API key:
Authorization: Bearer
Samples using Curl
Search for NFT's about coffee
curl "https://threshr.co/api-gateway/search?query=coffee" -H "Authorization: Bearer <API Key>"Search for all conference NFT's
curl "https://threshr.co/api-gateway/search?category=Conference" -H "Authorization: Bearer <API Key>"Get the second page of a search for shoe merch NFT's
curl "https://threshr.co/api-gateway/search?query=shoe&category=Merch&pageNum=2" -H "Authorization: Bearer <API Key>"Response
Search response has two fields.
NumPages is the number of pages of search results.
Docs is an array of search results sorted by relevance. The Perks field is not hydrated. An individual nft can be retrieved using the NFT API based on the returned ThreshrNFTId field.
Sample Response Body:
{
"NumPages": 1,
"Docs": [
{
"BlockchainSyncLocation": "jX6vzDIXoPTciSOZ1cdjikJbFXWmlnl0GnHDwrKopLE",
"BlockchainSyncStatus": "Synced",
"CollectionDescription": "A Gary Vaynerchuk NFT project around meaningful intellectual property and an extraordinary community.",
"ContractAddress": "0xa3aee8bce55beea1951ef834b99f3ac60d1abeeb",
"ContractChain": "ETH",
"ContractText": "",
"Creator": "VeeFriendsVault",
"ImagePic": "https://lh3.googleusercontent.com/5y-UCAXiNOFXH551w5bWdZEYOCdHPwbqmcKb-xa3uVQEjQgxvih3HtZWSmzqDqd0uk7kIqFrZhw32Gt6xPBFg4t_n9BKhpou-dwnOg=s168",
"Managers": [
"Users/HDSdFAxYufULvgSS2cP5ABfRYcs2"
],
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/veefriends",
"Perks": [
"Perks/73",
"Perks/7OpKKA2FWjod6Xfsc9sR",
"Perks/sovZ8IqI3BvOzmWgv2Fg",
"Perks/eDuaxWmoyy5ajJYUIesg"
],
"PriceRange": "",
"PropertiesNames": [],
"PropertiesValues": [],
"ReleaseStatus": "Available",
"ThreshrNFTId": "50",
"Title": "VeeFriends",
"TokenQuantity": 0,
"TokenQuantityIssued": 0,
"Version": 2,
"Website": "https://veefriends.com/",
"floorPrice": "notset",
"openseaSlug": "veefriends",
"path": "NFTs/50"
},
{
"BlockchainSyncLocation": "-nWKxvapYDeIjBNL0y6VdZYFVyY94efKTJq2LlhEc_0",
"BlockchainSyncStatus": "Updating",
"ContractAddress": "0x9378368ba6b85c1fba5b131b530f5f5bedf21a18",
"ContractChain": "ETH",
"ContractText": "",
"Creator": "VFSeries2",
"ImagePic": "https://lh3.googleusercontent.com/LrXPPC-y_I4qu9Y1PytwmYUUn7WVu9bXJDUFwKZYzmGuXzdNz41eINzOGOZHKmjv1aFtn5GPqKPk1RJd-Tjkv9CPIG32EG9ygGtJeOk=s168",
"Managers": [
"Users/HDSdFAxYufULvgSS2cP5ABfRYcs2"
],
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/veefriends-series-2",
"PriceRange": "",
"PropertiesNames": [],
"PropertiesValues": [],
"ReleaseStatus": "Available",
"ThreshrNFTId": "100",
"Title": "VeeFriends Series 2",
"TokenQuantity": 0,
"TokenQuantityIssued": 0,
"Version": 1,
"Website": "https://series2.veefriends.com/",
"openseaSlug": "veefriends-series-2",
"path": "NFTs/100"
},
{
"BlockchainSyncLocation": "F1c_xyasvqF_-Rcw3Ub__Xos7D05fPV3ki9gJdFq5F4",
"BlockchainSyncStatus": "Synced",
"CollectionDescription": "Art. Community. Events.",
"ContractAddress": "0x93317e87a3a47821803caadc54ae418af80603da",
"ContractChain": "ETH",
"ContractText": "",
"CreationDate": "2/11/2022",
"Creator": "CameoPass",
"ImagePic": "https://openseauserdata.com/files/7572aef06110b4e365817f60d37eff0d.svg",
"Managers": [
"Users/HDSdFAxYufULvgSS2cP5ABfRYcs2"
],
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/cameo-pass",
"Perks": [
"Perks/51",
"Perks/52",
"Perks/53"
],
"PriceRange": "",
"PropertiesNames": [],
"PropertiesValues": [],
"ReleaseStatus": "Available",
"ThreshrNFTId": "30",
"Title": "CameoPass",
"TokenQuantity": 6000,
"TokenQuantityIssued": 0,
"Version": 2,
"Website": "https://pass.cameo.com/",
"floorPrice": "notset",
"lastmodified": 1682718015617,
"openseaSlug": "cameo-pass",
"path": "NFTs/30"
},
{
"BlockchainSyncLocation": "whenx-enJleSjbK0vEKl06aMZsUXcAiI2VYZVIPys4M",
"BlockchainSyncStatus": "Synced",
"ContractAddress": "https://etherscan.io/address/0xc9d8f15803c645e98b17710a0b6593f097064bef",
"ContractChain": "ETH",
"ContractText": "",
"CreationDate": "12/15/2021",
"Creator": "Flyfish Club",
"ImagePic": "https://lh3.googleusercontent.com/3mPdo7sj92tMMNcr8-t51cFsTPVJuEZaxkL8Wx_1rPo5mHIqdRmCwC33u6bdLSR7y3TwN2mS4rBCPffsDTdtDGebDWJ-cG2WD-Ha4g=s130",
"Managers": [
"Users/VcpHbkAuPRT9dmvMSlfEnJ69O2V2"
],
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/flyfish-club",
"Perks": [
"Perks/15",
"Perks/16",
"Perks/17",
"Perks/18",
"Perks/19",
"Perks/20"
],
"PriceRange": "-",
"PropertiesNames": [],
"PropertiesValues": [],
"ReleaseStatus": "Available",
"ThreshrNFTId": "6",
"Title": "Flyfish Club (FFO)",
"TokenQuantity": 385,
"TokenQuantityIssued": 385,
"Version": 2,
"Website": "https://www.flyfishclub.com/membership",
"lastmodified": 1682718016416,
"openseaSlug": "flyfish-club",
"path": "NFTs/6"
},
{
"BlockchainSyncLocation": "tfn7fbCmIlT9Xgb_j1gGiyo9rmXG-DIUCXtQXeW9zoM",
"BlockchainSyncStatus": "Synced",
"ContractAddress": "0xc9d8f15803c645e98b17710a0b6593f097064bef",
"ContractChain": "ETH",
"ContractText": "",
"CreationDate": "12/15/2021",
"Creator": "Flyfish Club",
"ImagePic": "https://lh3.googleusercontent.com/3mPdo7sj92tMMNcr8-t51cFsTPVJuEZaxkL8Wx_1rPo5mHIqdRmCwC33u6bdLSR7y3TwN2mS4rBCPffsDTdtDGebDWJ-cG2WD-Ha4g=s130",
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/flyfish-club",
"Perks": [
"Perks/9",
"Perks/10",
"Perks/11",
"Perks/12",
"Perks/13"
],
"PriceRange": "-",
"PropertiesNames": [],
"PropertiesValues": [],
"ReleaseStatus": "Available",
"ThreshrNFTId": 5,
"Title": "Flyfish Club (FF)",
"TokenQuantity": 2650,
"TokenQuantityIssued": 2650,
"Version": 2,
"Website": "https://www.flyfishclub.com/membership",
"lastmodified": 1682718016174,
"openseaSlug": "flyfish-club",
"path": "NFTs/5"
}
]
}Errors
Too Many Requests
Surpassing the rate limit for the API will return status code 429 Too Many Requests. The body of the response will be JSON:
{"error":"Too Many Requests"}