Parameters

Some endpoints require input parameters belonging to specific domains.
On this page, all domains can be found in order to be in line with the standards required by the API.

cyhole.helius.param

HeliusNetwork

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusNetwork[HeliusNetwork]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusNetwork
                


              click cyhole.helius.param.HeliusNetwork href "" "cyhole.helius.param.HeliusNetwork"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Network environment for the Helius RPC endpoint.

Used to select between mainnet and devnet when initialising a Helius instance.

HeliusSortBy

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusSortBy[HeliusSortBy]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusSortBy
                


              click cyhole.helius.param.HeliusSortBy href "" "cyhole.helius.param.HeliusSortBy"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Sort criteria available for DAS asset collection queries (e.g. getAssetsByOwner).

Pass the .value to HeliusSortConfig when building a request body.

HeliusSortDirection

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusSortDirection[HeliusSortDirection]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusSortDirection
                


              click cyhole.helius.param.HeliusSortDirection href "" "cyhole.helius.param.HeliusSortDirection"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Sort direction for DAS asset collection queries.

Pass the .value to HeliusSortConfig when building a request body.

HeliusTokenType

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusTokenType[HeliusTokenType]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusTokenType
                


              click cyhole.helius.param.HeliusTokenType href "" "cyhole.helius.param.HeliusTokenType"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Token type filter for the searchAssets DAS endpoint.

Pass the .value to PostSearchAssetsBody as the token_type parameter.

HeliusTransferDirection

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusTransferDirection[HeliusTransferDirection]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusTransferDirection
                


              click cyhole.helius.param.HeliusTransferDirection href "" "cyhole.helius.param.HeliusTransferDirection"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Direction filter for the getTransfersByAddress RPC endpoint.

Pass the .value to PostGetTransfersByAddressBody as the direction parameter.

IN class-attribute instance-attribute

IN = 'in'

Transfers received by the queried address.

OUT class-attribute instance-attribute

OUT = 'out'

Transfers sent by the queried address.

ANY class-attribute instance-attribute

ANY = 'any'

Both incoming and outgoing transfers (API default).

HeliusSolMode

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusSolMode[HeliusSolMode]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusSolMode
                


              click cyhole.helius.param.HeliusSolMode href "" "cyhole.helius.param.HeliusSolMode"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

SOL/WSOL representation mode for the getTransfersByAddress RPC endpoint.

Pass the .value to PostGetTransfersByAddressBody as the sol_mode parameter.

MERGED class-attribute instance-attribute

MERGED = 'merged'

Treat WSOL as native SOL: WSOL mints are rewritten to the native SOL mint and wrap/unwrap lifecycle rows are excluded (API default).

SEPARATE class-attribute instance-attribute

SEPARATE = 'separate'

Keep WSOL as a distinct SPL mint and include wrap/unwrap lifecycle rows.

HeliusCommitment

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusCommitment[HeliusCommitment]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusCommitment
                


              click cyhole.helius.param.HeliusCommitment href "" "cyhole.helius.param.HeliusCommitment"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Commitment level for the getTransfersByAddress RPC endpoint.

Pass the .value to PostGetTransfersByAddressBody as the commitment parameter.

FINALIZED class-attribute instance-attribute

FINALIZED = 'finalized'

Only include transfers from finalized blocks (API default).

CONFIRMED class-attribute instance-attribute

CONFIRMED = 'confirmed'

Include transfers from confirmed (not yet finalized) blocks.

HeliusSortOrder

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusSortOrder[HeliusSortOrder]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusSortOrder
                


              click cyhole.helius.param.HeliusSortOrder href "" "cyhole.helius.param.HeliusSortOrder"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Result ordering for the getTransfersByAddress and getTransactionsForAddress RPC endpoints.

Pass the .value to PostGetTransfersByAddressBody or PostGetTransactionsForAddressBody as the sort_order parameter.

DESC class-attribute instance-attribute

DESC = 'desc'

Newest first (API default).

ASC class-attribute instance-attribute

ASC = 'asc'

Oldest first.

HeliusTransactionDetails

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusTransactionDetails[HeliusTransactionDetails]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusTransactionDetails
                


              click cyhole.helius.param.HeliusTransactionDetails href "" "cyhole.helius.param.HeliusTransactionDetails"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Transaction detail level for the getTransactionsForAddress RPC endpoint.

Pass the .value to PostGetTransactionsForAddressBody as the transaction_details parameter.

SIGNATURES class-attribute instance-attribute

SIGNATURES = 'signatures'

Return only signature-level info — faster, default mode (limit up to 1,000).

FULL class-attribute instance-attribute

FULL = 'full'

Return the complete transaction payload — eliminates the need for follow-up getTransaction calls (limit must be <= 100).

HeliusTransactionStatus

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusTransactionStatus[HeliusTransactionStatus]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusTransactionStatus
                


              click cyhole.helius.param.HeliusTransactionStatus href "" "cyhole.helius.param.HeliusTransactionStatus"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Transaction status filter for the getTransactionsForAddress RPC endpoint.

Pass the .value to PostGetTransactionsForAddressFilters as the status parameter.

SUCCEEDED class-attribute instance-attribute

SUCCEEDED = 'succeeded'

Only successful transactions.

FAILED class-attribute instance-attribute

FAILED = 'failed'

Only failed transactions.

ANY class-attribute instance-attribute

ANY = 'any'

Both successful and failed transactions (API default).

HeliusTokenAccountFilter

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusTokenAccountFilter[HeliusTokenAccountFilter]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusTokenAccountFilter
                


              click cyhole.helius.param.HeliusTokenAccountFilter href "" "cyhole.helius.param.HeliusTokenAccountFilter"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Token-account inclusion filter for the getTransactionsForAddress RPC endpoint.

Pass the .value to PostGetTransactionsForAddressFilters as the token_accounts parameter.

Not supported for transactions older than December 2022.

NONE class-attribute instance-attribute

NONE = 'none'

Only return transactions that directly reference the wallet address (API default).

BALANCE_CHANGED class-attribute instance-attribute

BALANCE_CHANGED = 'balanceChanged'

Include transactions that reference the address or modify the balance of a token account it owns (recommended).

ALL class-attribute instance-attribute

ALL = 'all'

Include any transaction that references the address or any token account it owns.

HeliusEncoding

Bases: CyholeParam

              flowchart TD
              cyhole.helius.param.HeliusEncoding[HeliusEncoding]
              cyhole.core.param.CyholeParam[CyholeParam]

                              cyhole.core.param.CyholeParam --> cyhole.helius.param.HeliusEncoding
                


              click cyhole.helius.param.HeliusEncoding href "" "cyhole.helius.param.HeliusEncoding"
              click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
            

Encoding format for the transaction payload, used by the getTransactionsForAddress RPC endpoint when transaction_details = "full".

Pass the .value to PostGetTransactionsForAddressBody as the encoding parameter.

JSON class-attribute instance-attribute

JSON = 'json'

Default JSON encoding (raw account keys and instruction data).

JSON_PARSED class-attribute instance-attribute

JSON_PARSED = 'jsonParsed'

JSON encoding with parsed instructions for known programs (SPL Token, System, etc.).

BASE64 class-attribute instance-attribute

BASE64 = 'base64'

Base64 encoding of the raw transaction bytes.

BASE58 class-attribute instance-attribute

BASE58 = 'base58'

Base58 encoding of the raw transaction bytes.