As a protocol, it is important for us to have a wide assortment of tools available for developers to work with and extend our platform. We have APIs, NPMs, best practices and access to our development team through Discord.
Get an API Key
Send an email to email@example.com and we will generate and send one over to you quickly.
We’ve got over half a dozen endpoints in our API that will help you get information about, validate and mint Darkblocks for your NFTs. You will need your own API key.
You can find our Stoplight API implementation here:
The Darkblock Viewer enables you to add unlockable content to any website with ease. The best way to add the Darkblock Viewer to your website is to use one of our chain-specific NPM packages.
We have built out a robust set of npms available across 5 different chains.
We have npms for each of these chains:
And we also have a viewer widget that helps support many of the different content types that can be served from a Darkblock:
Use collection upgrades to deliver content to all owners of the NFTs across an entire NFT collection.
One piece of unlockable content can be delivered to all owners in the collection with one API call.
You can use this collection as a type of exclusive club that gives the owners access to a stream of content over time. If you create more NFTs on the same collection then those new owners will automatically have access to all the same content. This is great for the web3 versions of Patreon and Onlyfans, and a great way to increase utility of your NFT collection!
For manual upgrades you can use our handy-dandy upprade forms (chain dependent!):
If you are looking for programmatic access you can use this endpoint to create new Darkblocks that target a collection:
(More info about how to construct the request found there!)
Try before you buy! We recommend creating a test collection and playing around with the tools first. Darkblock creation is permanent!
There are some subtle differences in how collection upgrades work based on the chain.
We target by collection name because this is the data available on-chain for each NFT for the Metaplex standard.
EVM Compatible (Ethereum, Polygon, Avalanche)
We use the contract address to target a collection for EVM NFTs because there is no popular on-chain metadata standard to target a collection of NFTs.
Listing the available content
To see a list of unlockable content for an NFT you can use this API call: https://api.darkblock.io/v1/darkblock/info?nft_platform=&nft_id=
Platforms supported: Ethereum, Solana, Tezos, Polygon, Avalanche
NFT_ID composition for EVM Chains and Tezos: <CONTRACT_ID>:<TOKEN_ID>
NFT_ID composition for Solana: <TOKEN_ID>
Here is an example for Solana: https://api.darkblock.io/v1/darkblock/info?nft_id=412EiTpy6Uee5uB1GktpmTJaCUgFgDKLZDKQ419DCAGK&nft_platform=Solana
Example when no Darkblock is found: https://api.darkblock.io/v1/darkblock/info?nft_id=0x130cfab3817467f532c179d4e6502f5a7e7d44c7:4&nft_platform=Ethereum
More info on that endpoint here: https://darkblock.stoplight.io/docs/darkblock-openapi-1/74f56892076b1-get-darkblock-info
Darkblock Protocol Requests
Once Darkblock unlockable content is detected we need to construct a session token to access the content. This session token is a combination of the epoch timestamp (milliseconds), the signature of the concatenation of the current epoch timestamp and the wallet address of the user, and the chain.
One session token is needed per chain, and can be cached, as they do not currently expire. They will be prone to expiration in the future, the rules around this will be coming soon based on partner feedback.
Here is the format of the session token: <EPOCH>_<SIGNATURE>_<PLATFORM>
Signature of 16529845012790x438cba7e454b59a9f897d4731fd3eaef37160c0a
Becomes the following session token: 1652984501279_0x23ddc5b8767a3c2c7c9bab3bdcb86c88a328d21b214e2edad91c6d40b4ad34860c99cfbbf06381c718d8ef3c8068145834ba9a2c8bd442afae7468fef1d10a2f1c_Ethereum
The ArtId can be taken from the Darkblock info response and combined with the session token, owner wallet address, NFT Contract and Token Id, and platform to construct a Gateway request.
(not a working example)
For Ethereum compatible chains you can use this handy-dandy signature tool that allows you to paste in some arbitrary text and create a signature with Metamask: