Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 3.44 KB

CandyMachineSearchRequest.md

File metadata and controls

71 lines (52 loc) · 3.44 KB

CandyMachineSearchRequest

Properties

Name Type Description Notes
updateAuthority kotlin.String The public key of the update authority of the candy machine [optional]
updateAuthoritySearchMethod inline Only `exact_match` supported at this time [optional]
configAddress kotlin.String The public key of the configuration of the candy machine [optional]
configAddressSearchMethod inline Only `exact_match` supported at this time [optional]
uuid kotlin.String The alphanumeric string of length six that corresponds to the candy machine. This is NOT the candy machine ID. This is the first six letters of the configuration address and is also used to identify the candy machine. An example is `4zKV6i`. [optional]
uuidSearchMethod inline Only `exact_match` supported at this time [optional]
symbol kotlin.String The symbol associated with the candy machine [optional]
symbolSearchMethod inline [optional]
nftName kotlin.String The name of an NFT on the candy machine, minted or unminted. For example, to find The Solana Money Boys candy machine, you already know that each NFT is named "Solana Money Boy #0", "Solana Money Boy #1", and so on. So you could search with nft_name="Solana Money Boy #0", nft_name_index=0, nft_name_search_method='exact_match', for example, which would return the candy machine ID. This also works with candy machines that are not live but are uploaded. [optional]
nftNameIndex kotlin.String The index of the NFT to check, e.g., the 2nd NFT would have an index of 1. We cannot search all NFTs on a candy machine currently, so you must search an NFT at a particular position, such as the first, second, and so on. In general, nft_name_index=0 works for most use cases. [optional]
nftNameSearchMethod inline [optional]
network inline [optional]
candyMachineContractVersion inline The candy machine contract you want to search. If you want to search `v1` candy machines, set this to `v1`. If you want to search `v2` candy machines. set this to `v2`. [optional]

Enum: update_authority_search_method

Name Value
updateAuthoritySearchMethod exact_match

Enum: config_address_search_method

Name Value
configAddressSearchMethod exact_match

Enum: uuid_search_method

Name Value
uuidSearchMethod exact_match

Enum: symbol_search_method

Name Value
symbolSearchMethod begins_with, exact_match

Enum: nft_name_search_method

Name Value
nftNameSearchMethod begins_with, exact_match

Enum: network

Name Value
network devnet, mainnet-beta

Enum: candy_machine_contract_version

Name Value
candyMachineContractVersion v1, v2