Skip to content

Latest commit

 

History

History
85 lines (49 loc) · 3.43 KB

CandyMachineSearchRequest.md

File metadata and controls

85 lines (49 loc) · 3.43 KB

CandyMachineSearchRequest

Properties

Name Type Description Notes
updateAuthority String The public key of the update authority of the candy machine [optional]
updateAuthoritySearchMethod UpdateAuthoritySearchMethodEnum Only `exact_match` supported at this time [optional]
configAddress String The public key of the configuration of the candy machine [optional]
configAddressSearchMethod ConfigAddressSearchMethodEnum Only `exact_match` supported at this time [optional]
uuid 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 UuidSearchMethodEnum Only `exact_match` supported at this time [optional]
symbol String The symbol associated with the candy machine [optional]
symbolSearchMethod SymbolSearchMethodEnum [optional]
nftName 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 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 NftNameSearchMethodEnum [optional]
network NetworkEnum [optional]
candyMachineContractVersion CandyMachineContractVersionEnum 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: UpdateAuthoritySearchMethodEnum

Name Value
EXACT_MATCH "exact_match"

Enum: ConfigAddressSearchMethodEnum

Name Value
EXACT_MATCH "exact_match"

Enum: UuidSearchMethodEnum

Name Value
EXACT_MATCH "exact_match"

Enum: SymbolSearchMethodEnum

Name Value
BEGINS_WITH "begins_with"
EXACT_MATCH "exact_match"

Enum: NftNameSearchMethodEnum

Name Value
BEGINS_WITH "begins_with"
EXACT_MATCH "exact_match"

Enum: NetworkEnum

Name Value
DEVNET "devnet"
MAINNET_BETA "mainnet-beta"

Enum: CandyMachineContractVersionEnum

Name Value
V1 "v1"
V2 "v2"