GET: Tokens

Returns token information which can be used to populate sales pages. The contract id for a contract can be found on the Collection screen in the Dashboard.

https://api.hypermint.com/v1/nft-contract/:contractId/tokens

Get Tokens

Returns all tokens related to the contract. Requires authentication for draft or deploying contracts.

Allows unauthenticated access for contracts that have been fully deployed, but only reveals information that is publicly available on the blockchain.

Parameters

Header

ParameterDescription
HM_ACCESS_KEYHyperMint Access Key
HM_ACCESS_KEY_SECRETHyperMint Access Key Secret

Response

CodeMeaning
🟒 200: OKResponds with an interaction ID which can be used to check the status of the transaction
🟠 404: Not FoundUnable to find token details for the give contract ID
interface ContractTokensResponse {
    tokens: ContractToken[];
};

interface ContractToken {
    id: number;
    totalSupply: number;
    price: number;
    supply?: number;
    remaining?: number;
    maxPerTransaction: number;
}

Feedback

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


What’s Next