NFT Data Retrieval API
Threshr's "NFT" API allows users to retrieve all NFT and Perk utility data from our database.
Users supply an ID or Address/Chain combination and API Key as part of an https GET request.
Request
URL
https://threshr.co/api-gateway/nft (opens in a new tab)
Parameters
One parameter is required, nftId
OR
Two parameters are required:
address and chain.
Chain must be one of these options:
ETH, POLY, OPTIMISM, SOL
Headers
One header is required to supply your API key:
Authorization: Bearer
Samples using Curl
Retrieve all data for Doodles (nftId = 2)
curl https://threshr.co/api-gateway/nft?nftId=2 -H "Authorization: Bearer <API Key>"Retrieve all data for a contract with address 0x8a90cab2b38dba80c64b7734e58ee1db38b8992e and chain ETH (this happens to also be Doodles)
curl "https://threshr.co/api-gateway/nft?address=0x8a90cab2b38dba80c64b7734e58ee1db38b8992e&chain=ETH" -H "Authorization: Bearer <API Key>"Performance Notes
Using nftId has noticeably faster performance. You may want to use the address/chain combo to find an nft and get results the first time, then use the returned ThreshrNFTId field for further queries.
Response
Expect to see some extra fields while the schema evolves, but guaranteed fields are listed here for NFTs and here for Perks
Sample Response Body:
{
"BlockchainSyncLocation": "jMhqJMV-9gjAaIEt4BdepLRb9zDXqWwj5R1FWqJc9qs",
"BlockchainSyncStatus": "Synced",
"CollectionDescription": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come in a joyful range of colors, traits and sizes with a collection size of 10,000. Each Doodle allows its owner to vote for experiences and activations paid for by the Doodles Community Treasury.",
"ContractAddress": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
"ContractChain": "ETH",
"ContractText": "",
"CreationDate": "10/15/2021",
"Creator": "Doodles_LLC",
"ImagePic": "https://lh3.googleusercontent.com/7B0qai02OdHA8P_EOVK672qUliyjQdQDGNrACxs7WnTgZAkJa_wWURnIFKeOh5VTf8cfTqW3wQpozGedaC9mteKphEOtztls02RlWQ=s0",
"Managers": [
{
"ID": "HDSdFAxYufULvgSS2cP5ABfRYcs2"
},
{
"ID": "VcpHbkAuPRT9dmvMSlfEnJ69O2V2"
},
{
"ID": "aswvIhyiUBQGuGbtxDgR49l7RsK2"
},
{
"ID": "5u7k3K4lgNcPIgtn11O56yFWVP12"
}
],
"MarketPlace": "OpenSea",
"MarketPlaceLink": "https://opensea.io/collection/doodles-official",
"Name": "NFT.NYC",
"PerkData": [
{
"BlockchainSyncLocation": "_oKSmj0X-I30ZUErcx9F27oHyWxACB0g8LuAIwinETE",
"BlockchainSyncStatus": "Synced",
"Creator": {
"ID": "HDSdFAxYufULvgSS2cP5ABfRYcs2"
},
"Date": {},
"LongDescription": "Owning a Doodle gives holders the ability to propose and vote on a variety of proposals via the Doodlebank. Previous prososals have used funds from the Doodlebank to conduct in-person events, marketing expenditures, and scaling up the Doodles team.",
"OneTime": "",
"ShortDescription": "Community Voting",
"Site": "https://forum.doodles.app/",
"Status": "Ongoing",
"Tags": [
"Voting"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "1",
"TokensRequired": 1,
"Version": 2
},
{
"BlockchainSyncLocation": "R1hjprpxCcvRv8xZWLGLICwvqqyfGuEswV7jNMcGovk",
"BlockchainSyncStatus": "Synced",
"Creator": {
"ID": "HDSdFAxYufULvgSS2cP5ABfRYcs2"
},
"Date": {
"dt": "2022-03-12T07:00:00Z",
"timeSet": false
},
"Location": "",
"LongDescription": "Holders are given VIP status apon check in at the Doodles official VIP event at SXSW. Additionally, exclusive physical merchandise will be available for purchase at the event.",
"OneTime": false,
"ShortDescription": "VIP at Doodles SXSW 2022",
"Site": "https://doodles.app/events/sxsw-2022",
"Status": "Past",
"Tags": [
"Events",
"Merch",
"SXSW"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "2",
"TokensRequired": "",
"Version": 1
},
{
"BlockchainSyncLocation": "J53VPiPyiQF-pw4Phbp41s4GrOPrDepmlI9sUiUyp0I",
"BlockchainSyncStatus": "Synced",
"Creator": {
"ID": "aswvIhyiUBQGuGbtxDgR49l7RsK2"
},
"Date": "",
"LongDescription": "A backpack-sized device with extraordinary powers usable in our next major product release. Watch it in action at the premiere of our trailer during NFT NYC. What’s inside? Well, all we can say for now is that it’s in the process of forming nebulous Doodley matter. Traits and rarities will be revealed on June 23rd.",
"OneTime": "",
"ShortDescription": "The Dooplicator",
"Site": "https://doodles.app/dooplicator",
"Status": "Past",
"Tags": [
"Unknown"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "3",
"TokensRequired": 1,
"Version": 1
},
{
"BlockchainSyncLocation": "IMACigvEwFFZa9roh72noFn0BbWlsW08Mn18TTK8J9E",
"BlockchainSyncStatus": "Synced",
"Creator": {
"ID": "HDSdFAxYufULvgSS2cP5ABfRYcs2"
},
"Date": {
"dt": "2022-06-21T06:00:00Z",
"timeSet": false
},
"EndDate": "6/21/2022",
"Location": {
"GeoPoint": {
"latitude": 40.7578239,
"longitude": -73.9861373
},
"address": "1515 Broadway, New York, NY 10036, USA",
"latitude": 40.7578239,
"longitude": -73.9861373,
"placeId": "ChIJf9YYUIhZwokR0DCXuN7Mnbo"
},
"LongDescription": "Join Doodle and Dooplicator holders from around the world at NFT NYC for a Doodles product trailer premiere, a brand new IRL experience, and exclusive holder-only benefits over 3 days of events.",
"OneTime": false,
"ShortDescription": "Holder Party at NFT.NYC 2022",
"Site": "https://doodles.app/events/nftnyc",
"Status": "Past",
"Tags": [
"Events",
"NFT.NYC",
"City"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "76",
"TokensRequired": "",
"Version": 1
},
{
"BlockchainSyncLocation": "ai_waWX8GzUDb1iLlhGkZJhe9ahDyVjjZEa9ZiN0Kjw",
"BlockchainSyncStatus": "Synced",
"Date": "",
"LongDescription": "Doodles store",
"OneTime": "",
"ShortDescription": "ShopDoodles",
"Site": "https://shop.doodles.app/password",
"Status": "Ongoing",
"Tags": [
"Merch"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "124",
"TokensRequired": 0,
"Version": 1
},
{
"BlockchainSyncLocation": "_7IXarDMDknN2N6b0scg21dF8gs9-DM_sNDBsX4Y8q4",
"BlockchainSyncStatus": "Synced",
"Creator": {
"ID": "aswvIhyiUBQGuGbtxDgR49l7RsK2"
},
"Date": {
"dt": "2022-12-02T19:00:00Z",
"timeSet": true
},
"Location": {
"GeoPoint": {
"latitude": 25.8012192,
"longitude": -80.1952652
},
"address": "2534 N Miami Ave, Miami, FL 33127, USA",
"latitude": 25.8012192,
"longitude": -80.1952652,
"placeId": "ChIJ0f5D-Ky22YgRS7E5Vz8SdcI"
},
"LongDescription": "Doodle Holders can register in advance for free admission and priority access to tee-times for you and a guest.",
"OneTime": false,
"ShortDescription": "DoodlePutt",
"Site": "https://doodles.app/events/doodleputt",
"Status": "Past",
"Tags": [
"Events",
"Sports",
"Golf"
],
"ThreshrNFTId": "2",
"ThreshrPerkId": "HUETQOA9UX0mQ2SzSpko",
"TokensRequired": "",
"Version": 1
}
],
"Perks": [
{
"ID": "1"
},
{
"ID": "2"
},
{
"ID": "3"
},
{
"ID": "76"
},
{
"ID": "124"
},
{
"ID": "HUETQOA9UX0mQ2SzSpko"
}
],
"PriceRange": "-",
"PropertiesNames": null,
"PropertiesValues": null,
"ReleaseStatus": "Available",
"ThreshrNFTId": 2,
"Title": "Doodles",
"TokenQuantity": 10000,
"TokenQuantityIssued": 10000,
"Version": 1,
"Website": "https://doodles.app/",
"floorPrice": "notset",
"openseaSlug": "doodles-official"
}Errors
Bad NFT Id
Using a bad NFT Id (try with "asdf") will return status code 400 Bad Request. The body of the response will be JSON:
{ "error": "Bad NFT Id" }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"}