GET: Token Allocation

Returns a breakdown of token allocation and purchasing options for a given wallet address as it relates to a given contract. This endpoint considers all the Access Lists attached to a contract. Access lists and allocations only apply for Mint With Crypto and Fiat Minting.

🚧

This endpoint currently only supports ERC-721 contracts.

https://api.hypermint.com/v1/token/:tokenId/allocation/:address

Gets Token Allocation for a Given Address

The :tokenId param should be set as 0 for ERC721 contracts.

Parameters

Header

ParameterDescription
HM_ACCESS_KEYHyperMint Access Key
HM_ACCESS_KEY_SECRETHyperMint Access Key Secret

Response

CodeMeaning
🟢 200: OKReturns status of the transfer
🟠 404: Not FoundNot Found
interface TokenAllocationResponse {
    allocation: TokenAllocationBreakdown[];
}

interface TokenAllocationBreakdown {
    remainingAllocation?: number; // will not be present if the supply is unlimited
    pricePerToken: number;
}

Feedback

Something not quite right, unclear or can't find what you are looking for? Please let us know at support.moonpay.com and we will get back to you as soon as we can.