Update the bid whitelist

POST 
https://minatokens.com/api/v1//token/bid/whitelist

Allows administrators to update the whitelist of addresses permitted to interact with the Bid contract. This is essential for managing participation in bidding processes, especially for controlled or private auctions.

Request

application/json

Bodyrequired

txTypeTokenTransactionType (string)
Must be "token:bid:whitelist"
Possible values: [token:bid:whitelist]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
bidAddressstringrequired
The address of the bid to update whitelist for.
whitelist objectrequired
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string

Responses

200

Successfully built update bid whitelist transaction.

application/json

Schema

Schema

senderstringrequired
The address initiating the transaction.
nonceint64required
The nonce for the transaction.
memostringrequired
A memo for the transaction.
feedoublerequired
The fee for the transaction.
walletPayload objectrequired
nonceint64
The nonce for the transaction.
transactionstring
The transaction data.
onlySignboolean
Indicates if only signature is needed.
feePayer object
feedouble
The fee for the transaction.
memostring
A memo for the transaction.
minaSignerPayload objectrequired
zkappCommand objectrequired
The zkApp command data.
property name*any
The zkApp command data.
feePayer objectrequired
feePayerstring
The fee payer's address.
feedouble
The fee for the transaction.
nonceint64
The nonce for the transaction.
memostring
A memo for the transaction.
proverPayloadstringrequired
The payload for the prover.
signedDatastringrequired
The signed data for the transaction.
transactionstringrequired
The raw transaction data.
sendTransactionboolean
Optional. Whether to broadcast the transaction after proving.
symbolstringrequired
The symbol of the token.
request objectrequired
oneOf
LaunchTokenStandardAdminParams
txTypeTokenTransactionType (string)
Must be "token:launch"
Possible values: [token:launch]
tokenAddressstring
Optional. The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
adminContractstringrequired
Must be "standard" for standard admin contract.
Possible values: [standard]
symbolstringrequired
The symbol of the token.
decimalsint32
Optional. The number of decimal places for the token.
uri objectrequired
URI or token info object containing metadata.
oneOf
MOD1
string
TokenInfo
symbolstring
The symbol of the token.
namestring
Optional. The name of the token.
descriptionstring
Optional. Description of the token.
imageUrluri
Optional. URL of the token image.
imageBase64string
Optional. Base64-encoded image data (max 1 MB).
twitterstring
Optional. Twitter handle associated with the token.
discordstring
Optional. Discord link associated with the token.
telegramstring
Optional. Telegram link associated with the token.
instagramstring
Optional. Instagram handle associated with the token.
facebookstring
Optional. Facebook page associated with the token.
websiteuri
Optional. Official website of the token.
tokenContractCodestring
Optional. Code for the token contract.
adminContractsCodestring[]
Optional. Code for the admin contracts.
adminContractAddressstring
Optional. The address of the admin contract.
tokenContractPrivateKeystring
Optional. Private key for the token contract.
adminContractPrivateKeystring
Optional. Private key for the admin contract.
LaunchTokenAdvancedAdminParams
txTypeTokenTransactionType (string)
Must be "token:launch"
Possible values: [token:launch]
tokenAddressstring
Optional. The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
adminContractstringrequired
Must be "advanced" for advanced admin contract.
Possible values: [advanced]
symbolstringrequired
The symbol of the token.
decimalsint32
Optional. The number of decimal places for the token.
uri objectrequired
URI or token info object containing metadata.
oneOf
MOD1
string
TokenInfo
symbolstring
The symbol of the token.
namestring
Optional. The name of the token.
descriptionstring
Optional. Description of the token.
imageUrluri
Optional. URL of the token image.
imageBase64string
Optional. Base64-encoded image data (max 1 MB).
twitterstring
Optional. Twitter handle associated with the token.
discordstring
Optional. Discord link associated with the token.
telegramstring
Optional. Telegram link associated with the token.
instagramstring
Optional. Instagram handle associated with the token.
facebookstring
Optional. Facebook page associated with the token.
websiteuri
Optional. Official website of the token.
tokenContractCodestring
Optional. Code for the token contract.
adminContractsCodestring[]
Optional. Code for the admin contracts.
adminContractAddressstring
Optional. The address of the admin contract.
tokenContractPrivateKeystring
Optional. Private key for the token contract.
adminContractPrivateKeystring
Optional. Private key for the admin contract.
canMintstringrequired
Specifies who can mint tokens.
Possible values: [whitelist, anyone]
requireAdminSignatureForMintboolean
Optional. Whether admin signature is required for minting.
whitelist object
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string
totalSupplydouble
Optional. Maximum total supply. Uses UInt64.MAXINT() if not provided.
TokenMintTransactionParams
txTypeTokenTransactionType (string)
Must be "token:mint"
Possible values: [token:mint]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
tostringrequired
The address to which tokens are to be minted.
amountdoublerequired
The amount of tokens to mint.
pricedouble
The price of the token in the bonding curve.
TokenBurnTransactionParams
txTypeTokenTransactionType (string)
Must be "token:burn"
Possible values: [token:burn]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
fromstringrequired
The address from which tokens are to be burned.
amountdoublerequired
The amount of tokens to burn.
TokenRedeemTransactionParams
txTypeTokenTransactionType (string)
Must be "token:redeem"
Possible values: [token:redeem]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
amountdoublerequired
The amount of tokens to redeem.
pricedoublerequired
The minimum price of the tokens to be redeemed.
slippageint32
The maximum slippage allowed for the redemption, default is 50 (5%).
Possible values: >= 0 and <= 999
TokenTransferTransactionParams
txTypeTokenTransactionType (string)
Must be "token:transfer"
Possible values: [token:transfer]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
tostringrequired
The address to which tokens are to be transferred.
amountdoublerequired
The amount of tokens to transfer.
TokenAirdropTransactionParams
txTypeTokenTransactionType (string)
Must be "token:airdrop"
Possible values: [token:airdrop]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
recipients object[]required
List of recipients and amounts for the airdrop
Array [
addressstringrequired
The recipient's address
amountdoublerequired
The amount to airdrop
memostring
Optional memo for this recipient
]
TokenOfferTransactionParams
txTypeTokenTransactionType (string)
Must be "token:offer:create"
Possible values: [token:offer:create]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
offerPrivateKeystring
Optional. The private key for offering.
offerAddressstring
Optional. The address for offering.
amountdoublerequired
The amount to offer.
pricedoublerequired
The price to offer.
whitelist object
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string
TokenBidTransactionParams
txTypeTokenTransactionType (string)
Must be "token:bid:create"
Possible values: [token:bid:create]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
bidPrivateKeystring
Optional. The private key for bidding.
bidAddressstring
Optional. The address for bidding.
amountdoublerequired
The amount to bid.
pricedoublerequired
The price to bid.
whitelist object
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string
TokenBuyTransactionParams
txTypeTokenTransactionType (string)
Must be "token:offer:buy"
Possible values: [token:offer:buy]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
offerAddressstringrequired
The address of the offer to buy from.
amountdoublerequired
The amount of tokens to buy.
TokenSellTransactionParams
txTypeTokenTransactionType (string)
Must be "token:bid:sell"
Possible values: [token:bid:sell]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
bidAddressstringrequired
The address of the bid to sell to.
amountdoublerequired
The amount of tokens to sell.
TokenWithdrawBidTransactionParams
txTypeTokenTransactionType (string)
Must be "token:bid:withdraw"
Possible values: [token:bid:withdraw]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
bidAddressstringrequired
The address of the bid to withdraw from.
amountdoublerequired
The amount to withdraw from the bid.
TokenWithdrawOfferTransactionParams
txTypeTokenTransactionType (string)
Must be "token:offer:withdraw"
Possible values: [token:offer:withdraw]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
offerAddressstringrequired
The address of the offer to withdraw from.
amountdoublerequired
The amount to withdraw from the offer.
TokenUpdateBidWhitelistTransactionParams
txTypeTokenTransactionType (string)
Must be "token:bid:whitelist"
Possible values: [token:bid:whitelist]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
bidAddressstringrequired
The address of the bid to update whitelist for.
whitelist objectrequired
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string
TokenUpdateOfferWhitelistTransactionParams
txTypeTokenTransactionType (string)
Must be "token:offer:whitelist"
Possible values: [token:offer:whitelist]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
offerAddressstringrequired
The address of the offer to update whitelist for.
whitelist objectrequired
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string
TokenUpdateAdminWhitelistTransactionParams
txTypeTokenTransactionType (string)
Must be "token:admin:whitelist"
Possible values: [token:admin:whitelist]
tokenAddressstringrequired
The address of the token contract.
senderstringrequired
The address (public key) of the sender.
senderPrivateKeystring
The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.
nonceint64
Optional. The nonce for the transaction.
memostring
Optional. A memo for the transaction.
developerFeedouble
Optional. The developer fee for the transaction.
adminAddressstringrequired
The address of the admin to update whitelist for.
whitelist objectrequired
Optional. List of whitelisted addresses with optional amounts, or a string.
oneOf
MOD1
Array [
addressstringrequired
The whitelisted address.
amountdouble
Optional. The amount allowed to bid.
]
MOD2
string

Example (auto)

{
  "sender": "string",
  "nonce": 0,
  "memo": "string",
  "fee": 0,
  "walletPayload": {
    "nonce": 0,
    "transaction": "string",
    "onlySign": true,
    "feePayer": {
      "fee": 0,
      "memo": "string"
    }
  },
  "minaSignerPayload": {
    "zkappCommand": {},
    "feePayer": {
      "feePayer": "string",
      "fee": 0,
      "nonce": 0,
      "memo": "string"
    }
  },
  "proverPayload": "string",
  "signedData": "string",
  "transaction": "string",
  "sendTransaction": true,
  "symbol": "string",
  "request": {
    "txType": "token:launch",
    "tokenAddress": "string",
    "sender": "string",
    "senderPrivateKey": "string",
    "nonce": 0,
    "memo": "string",
    "developerFee": 0,
    "adminContract": "standard",
    "symbol": "string",
    "decimals": 0,
    "uri": "string",
    "adminContractAddress": "string",
    "tokenContractPrivateKey": "string",
    "adminContractPrivateKey": "string"
  }
}

400

Bad request - invalid input parameters.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

401

Unauthorized - user not authenticated.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

403

Forbidden - user doesn't have permission.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

429

Too many requests.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

500

Internal server error - something went wrong during the request.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

503

Service unavailable - blockchain or other external service is down.

application/json

Schema

Schema

errorstring

Error message detailing the issue.

Example (auto)

{
  "error": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: headerdescription: API key for authorization. Get your API key at https://minatokens.com/api

• curl
• javascript
• nodejs
• python
• rust
• ocaml
• go
• java
• powershell

• CURL

curl -L 'https://minatokens.com/api/v1/token/bid/whitelist' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <x-api-key>' \
-d '{
  "txType": "token:bid:whitelist",
  "tokenAddress": "string",
  "sender": "string",
  "senderPrivateKey": "string",
  "nonce": 0,
  "memo": "string",
  "developerFee": 0,
  "bidAddress": "string",
  "whitelist": [
    {
      "address": "string",
      "amount": 0
    }
  ]
}'

Request Collapse all

Base URL

https://minatokens.com/api/v1

Auth

ApiKeyAuth

Body required

{
  "txType": "token:bid:whitelist",
  "tokenAddress": "string",
  "sender": "string",
  "senderPrivateKey": "string",
  "nonce": 0,
  "memo": "string",
  "developerFee": 0,
  "bidAddress": "string",
  "whitelist": [
    {
      "address": "string",
      "amount": 0
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!