Docs
Search…
Getting Started
At this time, you need an API key to interact with the Upshot API. If you would like to request a key, please fill out this form. Once acquired, you will need to pass the API key into the header as the property x-api-key.
This public API key is available if you'd like to play around with the API before getting your own, dedicated key: UP-39ef673e560bde0b20e95358
In order to use the Upshot API to fetch asset prices and metadata, you'll need to know a few things about the asset you're looking for. First, make sure that the asset is currently supported by the Upshot API by referring to the 'Contract Addresses' section of the documentation. While you're there, grab the address for the asset you're interested in--you'll need it to filter the results from the API. And if you're looking for something we don't support at the moment, don't worry: soon Upshot will be capable of appraising almost any NFT.
Now that you have your asset's contract address, you can use it to create an assetId. This is simply a pairing of the asset's contract address and its ID (in terms of the contract's IDs). For example, if you want to find the price data for CryptoPunk #3869, its assetId within Upshot would be 0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB/3869.
If you want to retrieve metadata about the asset, check out the documentation for the Assets endpoints. If you're interested in our price data, refer to the Prices section.
You'll notice two possible price sources are available via the Prices endpoints: MARKET and UPSHOT.
  • MARKET prices are what they sound like: historical prices for real sales on-chain.
  • UPSHOT prices are the predictions made by Upshot's machine learning models.
If the source parameter is omitted from the query, the API will return UPSHOT prices by default.
Copy link