GET
/
v1
/
claim-codes
/
{id}
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
required

The Droplink ID, raffle ID, or claim code

​
Examples

​
Response

​
claimCode
Claim Code object
required
​
claimCodeThemes
array
required
​
network
string
default:"mainnet"
required

The ethereum network identifier

​
tokenMetadata
Token Metadata object
required
{
  "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
    }
  ]
}