Droplink APIs
GET Unclaimed 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 Unclaimed Droplinks
Returns available claim codes matching the passed in ids that the current user has not yet claimed.
GET
/
v1
/
claim-codes
/
unclaimed
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
ids
string
*
ids
Required
string
An array of claim ids
curl -X 'GET' \
'https://api.bitski.com/v1/claim-codes/unclaimed?ids={ids}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
{
"claim_codes": [
{
"claim_code": {
"claimableType": "RAFFLE",
"code": "BIRDFAN2023",
"createdAt": "2023-04-20T18:10:09.848Z",
"description": "A free bird NFT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxClaims": 1,
"storeUsername": "nft_fans"
},
"network": "mainnet",
"token_metadata": {
"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.
Parameters
ids
string
requiredAn array of claim ids
Examples
Response
claimCodes
array
requiredid
string
requiredclaimableType
string
requiredcode
string
createdAt
string
description
string
maxClaims
number
storeUsername
number
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 -X 'GET' \
'https://api.bitski.com/v1/claim-codes/unclaimed?ids={ids}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
{
"claim_codes": [
{
"claim_code": {
"claimableType": "RAFFLE",
"code": "BIRDFAN2023",
"createdAt": "2023-04-20T18:10:09.848Z",
"description": "A free bird NFT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"maxClaims": 1,
"storeUsername": "nft_fans"
},
"network": "mainnet",
"token_metadata": {
"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
}
}
]
}