🎟️ Wallet APIs
An API key is required to access KryptoGO Wallet APIs. Please contact sales to get an API key.
Request Header for all following endpoints:
KG-WALLET-API-KEY: Your API key
Available endpoints:
Create Wallet
[POST] /v1/external/wallet/createUserWithMnemonicCreate a user and their corresponding multi-chain wallets via a phone number.
Supported chains include: Bitcoin, Ethereum, Polygon, Solana, Binance Smart Chain, Tron, Arbitrum, Kucoin Community Chain, Ronin, Oasys.
Request
{
"phone_number": "+886912345678"
}
Response
{
"code": 0
}
Status Codes
0 - Success
1010 - KMS Error
4001 - Error generating mnemonic
4002 - Error generating address
Retrieve Wallet
[GET] /v1/external/wallet/getAddressesByPhoneRetrieves a user's multi-chain wallets via a phone number.
Request
{
"phone_number": "+886912345678"
}
Response
{
"code": 0,
"data": {
"btc": "bc1qsk727gg82mrggwnhy0mxly3t7naqxkxymlmkd9",
"eth": "0xc7d88AEd2355D7e37EA6f2AF52213C05ba820bCF",
"matic": "0xc7d88AEd2355D7e37EA6f2AF52213C05ba820bCF",
"arb": "0xc7d88AEd2355D7e37EA6f2AF52213C05ba820bCF",
"kcc": "0xc7d88AEd2355D7e37EA6f2AF52213C05ba820bCF",
"bsc": "0xc7d88AEd2355D7e37EA6f2AF52213C05ba820bCF",
"sol": "HsJkT3DDyXUobtryLYhHdUgop9asd1R33aXnZSM69qFi",
"tron": "TWsPDmEjt5axSgsLkTtKSfbPGH5i7jzaem"
}
}
Status Codes
0 - Success
2100 - User does not exist
Airdrop NFT
[POST] /v1/external/nfts/minttip
Please contact sales and let us know your contract address before using this API.
Mint and airdrop a Polygon NFT to an address or a phone number.
Notes:
- If a phone number is specified and the associated user does not yet exist, we will create wallets for that new user.
- KryptoGO needs to either be the smart contract owner, or have permission to mint an NFT from your smart contract.
- Once the mint transaction is confirmed on the blockchain, a callback request will be sent to your specified endpoint, notifying you of the transaction result.
Request
{
"contract_address": "0x12345",
"transfer_to_address": "0xfffff",
"request_id": "SOME UUID",
"callback_endpoint": "https://callback.endpoint"
}
{
"contract_address": "0x12345",
"transfer_to_phone": "+886912345678",
"request_id": "SOME UUID",
"callback_endpoint": "https://callback.endpoint"
}
Response
{
"code": 0
}
Status Codes
0: Success
1000: Unexpected Error
1004: Incorrect Parameters
1017: Duplicate request_id
2000: Auth token not provided
2001: Invalid auth token
2302: Invalid Contract Address
2303: Invalid Transfer to Address
2304: No NFT tokens left
Retrieve User NFTs
[GET] /v1/external/nftsRetrieve a user’s NFTs via their phone number, and filter the NFTs by contract address and blockchain.
Request
GET /v1/nfts?phone_number=&contract_addresses=&chain_ids=&page_number=1
phone_number
User’s phone number
phone_number=+886912345678
chain_ids[]
Fill in all desired chain IDs. We currently support eth and matic
chain_ids=eth&chain_ids=matic
contract_addresses[]
The contract addresses to use as filters.
contract_addresses=0xa82fa2c0fd1fc6bb964d9302d3507b88a5f1b8d0&contract_addresses=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d
Response
{
"code": 0,
"data": [
{
"chain_id": "ethereum",
"contract_address": "0x60e4d786628fea6478f785a6d7e704777c86a7c6",
"token_id": "24059",
"collection_slug": "mutant-ape-yacht-club",
"contract_schema_name": "ERC721",
"owner_address": "0x300736a2c7eacac5524930aff74779ecb2c775ed",
"image_url": "https://lh3.googleusercontent.com/k7d4rPjPosBpl-PtKnqH8bcQqaEjZ7AlXHx27RKC6gSA9yduLsjOcBy5GNPC_kdNkc88sen6pm14X23eM0Pb8QNsaa4arswDO8kcQ6w",
"image_preview_url": "https://lh3.googleusercontent.com/k7d4rPjPosBpl-PtKnqH8bcQqaEjZ7AlXHx27RKC6gSA9yduLsjOcBy5GNPC_kdNkc88sen6pm14X23eM0Pb8QNsaa4arswDO8kcQ6w=s250",
"listing_time": 0,
"floor_price": "799900000000000000",
"floor_price_symbol": "WEI",
"last_price": "6750000000000000000",
"last_price_symbol": "WEI"
"creator": {
"address": "0x9056d15c49b19df52ffad1e6c11627f035c0c960",
"config": "verified",
"profile_img_url": "https://storage.googleapis.com/opensea-static/opensea-profile/22.png",
"user": {
"username": "MutantApeYachtClub"
}
},
"traits": [
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 203,
"trait_type": "Fur",
"value": "M2 Cheetah"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 332,
"trait_type": "Eyes",
"value": "M2 Sleepy"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 291,
"trait_type": "Mouth",
"value": "M2 Bored Cigarette"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 103,
"trait_type": "Clothes",
"value": "M2 Puffy Vest"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 546,
"trait_type": "Background",
"value": "M2 Orange"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 236,
"trait_type": "Hat",
"value": "M2 Beanie"
}
],
"amount": "1",
"owner_address": "0x...."
},
{
"chain_id": "ethereum",
"contract_address": "0x08613bff1268dc9b0928f760b86f520fb3727c5c",
"token_id": "3485",
"collection_slug": "derpyapemfers",
"contract_schema_name": "ERC721",
"owner_address": "0x300736a2c7eacac5524930aff74779ecb2c775ed",
"image_url": "https://lh3.googleusercontent.com/cZVlQ8enODgLXlZQq8_Pks3wN2HPECJ55DpAiVOy9X0Ol7ZC_RcoCNLO--Gl0dLGJwNkOtl2tvJ6GJ8Kw9L9CR9Klt_U7DPApBBHiA",
"image_preview_url": "https://lh3.googleusercontent.com/cZVlQ8enODgLXlZQq8_Pks3wN2HPECJ55DpAiVOy9X0Ol7ZC_RcoCNLO--Gl0dLGJwNkOtl2tvJ6GJ8Kw9L9CR9Klt_U7DPApBBHiA=s250",
"listing_time": 0,
"floor_price": "799900000000000000",
"floor_price_symbol": "WEI",
"last_price": "6750000000000000000",
"last_price_symbol": "WEI"
"creator": {
"address": "0xa561400ccffb3186a39693fc1cac388d68c8ec4e",
"config": "",
"profile_img_url": "https://storage.googleapis.com/opensea-static/opensea-profile/16.png",
"user": {
"username": "derpyapemfers-deployer"
}
},
"traits": [
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 1153,
"trait_type": "background",
"value": "orange"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 449,
"trait_type": "face",
"value": "purple ninja mask"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 1020,
"trait_type": "watch",
"value": "green watch"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 922,
"trait_type": "ape",
"value": "purple"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 234,
"trait_type": "body",
"value": "bumblebee tee"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 64,
"trait_type": "hat",
"value": "neon crown"
}
],
"amount": "1",
"owner_address": "0x...."
},
{
"chain_id": "ethereum",
"contract_address": "0x08613bff1268dc9b0928f760b86f520fb3727c5c",
"token_id": "3484",
"collection_slug": "derpyapemfers",
"contract_schema_name": "ERC721",
"owner_address": "0x300736a2c7eacac5524930aff74779ecb2c775ed",
"image_url": "https://lh3.googleusercontent.com/KrWC920p-intj06byRci9VqPntw1Yt8_9D_wcD_KjHnHJ841HYNHT0EQxkEDt2bfmypuH193Gd2B7AnYOYDtcvR4zQE3Eg4nMroNlA",
"image_preview_url": "https://lh3.googleusercontent.com/KrWC920p-intj06byRci9VqPntw1Yt8_9D_wcD_KjHnHJ841HYNHT0EQxkEDt2bfmypuH193Gd2B7AnYOYDtcvR4zQE3Eg4nMroNlA=s250",
"listing_time": 0,
"floor_price": "799900000000000000",
"floor_price_symbol": "WEI",
"last_price": "6750000000000000000",
"last_price_symbol": "WEI"
"creator": {
"address": "0xa561400ccffb3186a39693fc1cac388d68c8ec4e",
"config": "",
"profile_img_url": "https://storage.googleapis.com/opensea-static/opensea-profile/16.png",
"user": {
"username": "derpyapemfers-deployer"
}
},
"traits": [
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 987,
"trait_type": "watch",
"value": "red watch"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 952,
"trait_type": "ape",
"value": "brown"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 345,
"trait_type": "hat",
"value": "icecream"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 334,
"trait_type": "body",
"value": "duck tee"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 1087,
"trait_type": "background",
"value": "pink"
},
{
"display_type": null,
"max_value": null,
"order": null,
"trait_count": 425,
"trait_type": "face",
"value": "funny glasses"
}
],
"amount": "1",
"owner_address": "0x...."
}
],
"paging": {
"page_number": 1,
"page_size": 10,
"total_count": 3,
"page_sort": "floor_price:d"
}
}
Retrieve User NFT Utilities
[GET] /v1/external/rewardsRetrieve a user’s NFT rewards via their phone number, and filter the rewards by contract address and blockchain.
Request
GET /v1/rewards?phone_number=&contract_addresses=&chain_ids=&page_number=1
phone_number
User’s phone number
phone_number=+886912345678
chain_ids[]
Fill in all desired chain IDs. We currently support eth and matic
chain_ids=eth&chain_ids=matic
contract_addresses[]
The contract addresses to use as filters.
contract_addresses=0xa82fa2c0fd1fc6bb964d9302d3507b88a5f1b8d0&contract_addresses=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d
Response
{
"code": 0,
"data": [
{
"id": 719,
"title": "SecuX虛擬通貨冷錢包官網購物車整單8折 (20%OFF)",
"amount": 1,
"image_url": "https://wallet-static.kryptogo.com/public/luckybag2022/prize/069.jpg",
"same_code": null,
"project_image_url": "",
"project_name": "KryptoGO x DemiVerse Lucky Bag 2022",
"project_verified": true,
"token_id": "107",
"is_favorite": false,
"is_hidden": false,
"is_seen": false,
"start_time": 1643558400,
"end_time": 1672502400,
"publish_time": 1640995200,
"redeemed_qty": 0,
"detail": "「商家名稱」\n．SecuX虛擬通貨冷錢包\n\n「商品內容」\n．SecuX虛擬通貨冷錢包官網購物車整單8折優惠 (20%OFF)\n\n「注意事項」\n．點擊 \"兌換\" 後，請複製或記下「兌換碼」，點擊「商家連結」至 SecuX 官網將 XSEED 相關商品加入購物車，並於 SecuX 官網購物車結帳時輸入此「兌換碼」，方能享有整單20%OFF（商品定價8折)（官網購物連結：https://shop.secuxtech.com/）\n\n．此優惠折扣碼僅適用單品，不適用於任何組合套裝優惠。\n\n．此優惠折扣碼不能找零。\n\n．此優惠折扣碼每次結帳，僅能使用一次。\n\n．此優惠折扣碼不能折抵運費（SecuX商品訂單於台灣境內收貨地址出貨免運；國外訂單收貨地址需自行負擔運費與所有衍生税率費用）。\n\n．此優惠折扣碼不可與其他行銷、優惠或折扣活動併用。",
"limitation": null,
"merchant_name": null,
"merchant_contact": null,
"matched_trait": "{\"value\": \"SecuX虛擬通貨冷錢包官網購物車整單打8折\"}",
"redeem_url": "https://shop.secuxtech.com/",
"show_code": true
}
],
"paging": {
"page_number": 1,
"page_size": 20,
"total_count": 1,
"page_sort": "publish_time:d"
}
}