Droplink APIs
GET Droplinks
- Documentation
- Introduction
- Overview
- Quickstart
- Errors
- Pagination
Wallet Creation APIs
Wallet Experience APIs
NFT APIs
- Overview
Minting APIs
Commerce APIs
Droplink APIs
Token Gating APIs
- Miscellaneous NFT APIs
Web3 APIs
SDK
Overview
Wallet as a Service (WaaS)
Droplink APIs
GET Droplinks
Allow users to create a wallet and claim an NFT via QR code, URL, or in app experience.
GET
/
v1
/
claim-codes
/
{id}
id
string
*
id
Required
string
The Droplink ID, raffle ID, or claim code
curl --request GET \
--url https://api.bitski.com/v1/claim-codes/{id}
{
"claimCode": {
"claimableType": "RAFFLE",
"code": "BIRDFAN2023",
"createdAt": "2023-04-20T17:46:44.109Z",
"description": "A free bird NFT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxClaims": 1,
"storeUsername": "nft_fans"
},
"claimCodeThemes": [
{
"appId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"backgroundImageUrl": null,
"footerHtml": "Find more tokens",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"linkColor": "#0101ff",
"linkHoverColor": "#01ff01",
"logoUrl": null,
"postClaimRedirectButtonText": "Explore with your new token",
"postClaimRedirectButtonUrl": "https://www.bitski.com/explore",
"primaryBackgroundColor": "#0101ff",
"primaryButtonColor": "#01ff01",
"primaryButtonHoverColor": "#0101ff",
"primaryButtonTextColor": "#01ff01",
"primaryTextColor": "#ff0101",
"progressBarActiveTextColor": "#0101ff",
"progressBarBackgroundColor": "#0101ff",
"progressBarBorderColor": "#01ff01",
"progressBarColor": "#01ff01",
"progressBarInactiveTextColor": "#01ff01",
"secondaryBackgroundColor": "#01ff01",
"secondaryButtonColor": "#0101ff",
"secondaryButtonHoverColor": "#01ff01",
"secondaryButtonTextColor": "#0101ff",
"secondaryTextColor": "#01ff01",
"signInWithEthSetting": "DEFAULT",
"tertiaryTextColor": "#0101ff"
}
],
"network": "mainnet",
"tokenMetadata": [
{
"animation_url": null,
"attributes": null,
"background_color": null,
"description": "A very special NFT",
"external_url": "https://www.bitski.com/@Stapleverse",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"name": "NFT Token #1",
"properties": {},
"youtube_url": null
}
]
}
Access to this API is available upon request to sales@bitski.com.
Path
id
string
requiredThe Droplink ID, raffle ID, or claim code
Examples
Response
claimCode
Claim Code object
requiredid
string
requiredclaimableType
string
requiredcode
string
createdAt
string
description
string
maxClaims
number
storeUsername
number
claimCodeThemes
array
requiredid
string
requiredappId
string
requiredbackgroundImageUrl
string
footerHtml
string
linkColor
string
linkHoverColor
string
logoUrl
string
postClaimRedirectButtonText
string
postClaimRedirectButtonUrl
string
primaryBackgroundColor
string
primaryButtonColor
string
primaryButtonHoverColor
string
primaryButtonTextColor
string
primaryTextColor
string
progressBarActiveTextColor
string
progressBarBackgroundColor
string
progressBarBorderColor
string
progressBarColor
string
progressBarInactiveTextColor
string
secondaryBackgroundColor
string
secondaryButtonColor
string
secondaryButtonHoverColor
string
secondaryButtonTextColor
string
secondaryTextColor
string
signInWithEthSetting
string
tertiaryTextColor
string
network
string
default: "mainnet"requiredThe ethereum network identifier
tokenMetadata
Token Metadata object
requiredname
string
image
string
description
string
animation_url
string
attributes
object
background_color
string
external_url
string
properties
object
youtube_url
string
curl --request GET \
--url https://api.bitski.com/v1/claim-codes/{id}
{
"claimCode": {
"claimableType": "RAFFLE",
"code": "BIRDFAN2023",
"createdAt": "2023-04-20T17:46:44.109Z",
"description": "A free bird NFT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxClaims": 1,
"storeUsername": "nft_fans"
},
"claimCodeThemes": [
{
"appId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"backgroundImageUrl": null,
"footerHtml": "Find more tokens",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"linkColor": "#0101ff",
"linkHoverColor": "#01ff01",
"logoUrl": null,
"postClaimRedirectButtonText": "Explore with your new token",
"postClaimRedirectButtonUrl": "https://www.bitski.com/explore",
"primaryBackgroundColor": "#0101ff",
"primaryButtonColor": "#01ff01",
"primaryButtonHoverColor": "#0101ff",
"primaryButtonTextColor": "#01ff01",
"primaryTextColor": "#ff0101",
"progressBarActiveTextColor": "#0101ff",
"progressBarBackgroundColor": "#0101ff",
"progressBarBorderColor": "#01ff01",
"progressBarColor": "#01ff01",
"progressBarInactiveTextColor": "#01ff01",
"secondaryBackgroundColor": "#01ff01",
"secondaryButtonColor": "#0101ff",
"secondaryButtonHoverColor": "#01ff01",
"secondaryButtonTextColor": "#0101ff",
"secondaryTextColor": "#01ff01",
"signInWithEthSetting": "DEFAULT",
"tertiaryTextColor": "#0101ff"
}
],
"network": "mainnet",
"tokenMetadata": [
{
"animation_url": null,
"attributes": null,
"background_color": null,
"description": "A very special NFT",
"external_url": "https://www.bitski.com/@Stapleverse",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"name": "NFT Token #1",
"properties": {},
"youtube_url": null
}
]
}