Response Schema¶
Each response has been mapped into a pydantic schema in a way that makes it easy to read and write codes that use them.
The classes identifying the response schema of an endpoint are the only ones ending with Response word, all other sub-schemes are used to identify the structures obtained from the responses.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.HeliusSortConfig[HeliusSortConfig]
click cyhole.helius.schema.HeliusSortConfig href "" "cyhole.helius.schema.HeliusSortConfig"
Sort configuration used in DAS asset collection request bodies.
Attributes:
| Name | Type | Description |
|---|---|---|
sort_by |
str
|
field to sort by (see |
sort_direction |
str
|
sort order (see |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.HeliusDisplayOptions[HeliusDisplayOptions]
click cyhole.helius.schema.HeliusDisplayOptions href "" "cyhole.helius.schema.HeliusDisplayOptions"
Display options that control which extra fields are returned in DAS collection responses.
All fields default to None (API default: False).
class-attribute
instance-attribute
¶
show_fungible: bool | None = Field(
default=None, alias="showFungible"
)
class-attribute
instance-attribute
¶
show_native_balance: bool | None = Field(
default=None, alias="showNativeBalance"
)
class-attribute
instance-attribute
¶
show_collection_metadata: bool | None = Field(
default=None, alias="showCollectionMetadata"
)
class-attribute
instance-attribute
¶
show_unverified_collections: bool | None = Field(
default=None, alias="showUnverifiedCollections"
)
class-attribute
instance-attribute
¶
show_grand_total: bool | None = Field(
default=None, alias="showGrandTotal"
)
class-attribute
instance-attribute
¶
show_inscription: bool | None = Field(
default=None, alias="showInscription"
)
class-attribute
instance-attribute
¶
show_zero_balance: bool | None = Field(
default=None, alias="showZeroBalance"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetFile[AssetFile]
click cyhole.helius.schema.AssetFile href "" "cyhole.helius.schema.AssetFile"
A file attachment in an asset's content (image, animation, etc.).
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetAttribute[AssetAttribute]
click cyhole.helius.schema.AssetAttribute href "" "cyhole.helius.schema.AssetAttribute"
A single trait attribute for an NFT asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetMetadata[AssetMetadata]
click cyhole.helius.schema.AssetMetadata href "" "cyhole.helius.schema.AssetMetadata"
On-chain metadata fields for a digital asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetLinks[AssetLinks]
click cyhole.helius.schema.AssetLinks href "" "cyhole.helius.schema.AssetLinks"
External links associated with a digital asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetContent[AssetContent]
click cyhole.helius.schema.AssetContent href "" "cyhole.helius.schema.AssetContent"
Content fields of a digital asset, including metadata and attached files.
class-attribute
instance-attribute
¶
schema_uri: str | None = Field(
default=None, alias="$schema"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetAuthority[AssetAuthority]
click cyhole.helius.schema.AssetAuthority href "" "cyhole.helius.schema.AssetAuthority"
Update authority record for a digital asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetCompression[AssetCompression]
click cyhole.helius.schema.AssetCompression href "" "cyhole.helius.schema.AssetCompression"
Compression state and Merkle tree details for a compressed NFT (cNFT).
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetCollectionMetadata[AssetCollectionMetadata]
click cyhole.helius.schema.AssetCollectionMetadata href "" "cyhole.helius.schema.AssetCollectionMetadata"
Metadata for the collection an asset belongs to.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetGrouping[AssetGrouping]
click cyhole.helius.schema.AssetGrouping href "" "cyhole.helius.schema.AssetGrouping"
Grouping membership (e.g. collection) for a digital asset.
class-attribute
instance-attribute
¶
collection_metadata: AssetCollectionMetadata | None = None
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetRoyalty[AssetRoyalty]
click cyhole.helius.schema.AssetRoyalty href "" "cyhole.helius.schema.AssetRoyalty"
Royalty configuration for a digital asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetCreator[AssetCreator]
click cyhole.helius.schema.AssetCreator href "" "cyhole.helius.schema.AssetCreator"
A creator entry in an asset's creator array.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetOwnership[AssetOwnership]
click cyhole.helius.schema.AssetOwnership href "" "cyhole.helius.schema.AssetOwnership"
Ownership details of a digital asset.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetSupply[AssetSupply]
click cyhole.helius.schema.AssetSupply href "" "cyhole.helius.schema.AssetSupply"
Print supply details for a master/edition NFT.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetPriceInfo[AssetPriceInfo]
click cyhole.helius.schema.AssetPriceInfo href "" "cyhole.helius.schema.AssetPriceInfo"
Price information for a fungible token.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetTokenInfo[AssetTokenInfo]
click cyhole.helius.schema.AssetTokenInfo href "" "cyhole.helius.schema.AssetTokenInfo"
Token-specific information returned for fungible assets.
class-attribute
instance-attribute
¶
associated_token_address: str | None = None
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetInscription[AssetInscription]
click cyhole.helius.schema.AssetInscription href "" "cyhole.helius.schema.AssetInscription"
Inscription data attached to a digital asset.
class-attribute
instance-attribute
¶
inscription_data_account: str | None = None
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetNativeBalance[AssetNativeBalance]
click cyhole.helius.schema.AssetNativeBalance href "" "cyhole.helius.schema.AssetNativeBalance"
SOL native balance for the asset owner, returned when showNativeBalance is enabled.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.Asset[Asset]
click cyhole.helius.schema.Asset href "" "cyhole.helius.schema.Asset"
Full digital asset record returned by the Helius DAS API.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetList[AssetList]
click cyhole.helius.schema.AssetList href "" "cyhole.helius.schema.AssetList"
Paginated list of digital assets returned by DAS collection endpoints.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetProof[AssetProof]
click cyhole.helius.schema.AssetProof href "" "cyhole.helius.schema.AssetProof"
Merkle proof for a compressed NFT, required for on-chain operations.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.AssetSignatureList[AssetSignatureList]
click cyhole.helius.schema.AssetSignatureList href "" "cyhole.helius.schema.AssetSignatureList"
Paginated list of transaction signatures for a digital asset.
Each item in items is a two-element list: [signature, transaction_type].
Bases: BaseModel
flowchart TD
cyhole.helius.schema.TokenAccount[TokenAccount]
click cyhole.helius.schema.TokenAccount href "" "cyhole.helius.schema.TokenAccount"
A single SPL token account record.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.TokenAccountList[TokenAccountList]
click cyhole.helius.schema.TokenAccountList href "" "cyhole.helius.schema.TokenAccountList"
Paginated list of SPL token accounts.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.NftEditionItem[NftEditionItem]
click cyhole.helius.schema.NftEditionItem href "" "cyhole.helius.schema.NftEditionItem"
A single print edition of a master NFT.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.NftEditionList[NftEditionList]
click cyhole.helius.schema.NftEditionList href "" "cyhole.helius.schema.NftEditionList"
Paginated list of print editions for a master NFT.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetOptions[PostGetAssetOptions]
click cyhole.helius.schema.PostGetAssetOptions href "" "cyhole.helius.schema.PostGetAssetOptions"
Optional display flags for the getAsset DAS endpoint.
All fields default to None (API default: False).
class-attribute
instance-attribute
¶
show_unverified_collections: bool | None = Field(
default=None, alias="showUnverifiedCollections"
)
class-attribute
instance-attribute
¶
show_collection_metadata: bool | None = Field(
default=None, alias="showCollectionMetadata"
)
class-attribute
instance-attribute
¶
show_fungible: bool | None = Field(
default=None, alias="showFungible"
)
class-attribute
instance-attribute
¶
show_inscription: bool | None = Field(
default=None, alias="showInscription"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByOwnerBody[PostGetAssetsByOwnerBody]
click cyhole.helius.schema.PostGetAssetsByOwnerBody href "" "cyhole.helius.schema.PostGetAssetsByOwnerBody"
Request body for the getAssetsByOwner DAS endpoint.
Attributes:
| Name | Type | Description |
|---|---|---|
owner_address |
str
|
wallet address of the asset owner. |
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page, max 1,000 (default 1,000). |
display_options |
HeliusDisplayOptions | None
|
optional flags controlling extra fields in the response. |
sort_by |
HeliusSortConfig | None
|
optional sort configuration. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByGroupBody[PostGetAssetsByGroupBody]
click cyhole.helius.schema.PostGetAssetsByGroupBody href "" "cyhole.helius.schema.PostGetAssetsByGroupBody"
Request body for the getAssetsByGroup DAS endpoint.
Attributes:
| Name | Type | Description |
|---|---|---|
group_key |
str
|
grouping key, typically |
group_value |
str
|
collection mint address. |
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page, max 1,000 (default 1,000). |
display_options |
HeliusDisplayOptions | None
|
optional flags controlling extra fields in the response. |
sort_by |
HeliusSortConfig | None
|
optional sort configuration. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByCreatorBody[PostGetAssetsByCreatorBody]
click cyhole.helius.schema.PostGetAssetsByCreatorBody href "" "cyhole.helius.schema.PostGetAssetsByCreatorBody"
Request body for the getAssetsByCreator DAS endpoint.
Attributes:
| Name | Type | Description |
|---|---|---|
creator_address |
str
|
wallet address of the creator. |
only_verified |
bool | None
|
if True, return only assets where the creator is verified (default False). |
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page, max 1,000 (default 1,000). |
display_options |
HeliusDisplayOptions | None
|
optional flags controlling extra fields in the response. |
sort_by |
HeliusSortConfig | None
|
optional sort configuration. |
class-attribute
instance-attribute
¶
creator_address: str = Field(alias='creatorAddress')
class-attribute
instance-attribute
¶
only_verified: bool | None = Field(
default=None, alias="onlyVerified"
)
class-attribute
instance-attribute
¶
display_options: HeliusDisplayOptions | None = Field(
default=None, alias="displayOptions"
)
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByAuthorityBody[PostGetAssetsByAuthorityBody]
click cyhole.helius.schema.PostGetAssetsByAuthorityBody href "" "cyhole.helius.schema.PostGetAssetsByAuthorityBody"
Request body for the getAssetsByAuthority DAS endpoint.
Attributes:
| Name | Type | Description |
|---|---|---|
authority_address |
str
|
update authority address. |
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page, max 1,000 (default 1,000). |
display_options |
HeliusDisplayOptions | None
|
optional flags controlling extra fields in the response. |
sort_by |
HeliusSortConfig | None
|
optional sort configuration. |
class-attribute
instance-attribute
¶
authority_address: str = Field(alias='authorityAddress')
class-attribute
instance-attribute
¶
display_options: HeliusDisplayOptions | None = Field(
default=None, alias="displayOptions"
)
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostSearchAssetsBody[PostSearchAssetsBody]
click cyhole.helius.schema.PostSearchAssetsBody href "" "cyhole.helius.schema.PostSearchAssetsBody"
Request body for the searchAssets DAS endpoint.
All fields are optional — combine filters as needed.
Attributes:
| Name | Type | Description |
|---|---|---|
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page, max 1,000 (default 1,000). |
owner_address |
str | None
|
filter by owner wallet address. |
creator_address |
str | None
|
filter by creator wallet address. |
creator_verified |
bool | None
|
if True, only return assets from verified creators. |
grouping |
list[str] | None
|
collection filter as a two-element list |
burnt |
bool | None
|
if True, include burnt assets. |
compressed |
bool | None
|
filter by compression status. |
token_type |
str | None
|
filter by token type (see |
sort_by |
HeliusSortConfig | None
|
optional sort configuration. |
class-attribute
instance-attribute
¶
owner_address: str | None = Field(
default=None, alias="ownerAddress"
)
class-attribute
instance-attribute
¶
creator_address: str | None = Field(
default=None, alias="creatorAddress"
)
class-attribute
instance-attribute
¶
creator_verified: bool | None = Field(
default=None, alias="creatorVerified"
)
class-attribute
instance-attribute
¶
token_type: str | None = Field(
default=None, alias="tokenType"
)
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTokenAccountsBody[PostGetTokenAccountsBody]
click cyhole.helius.schema.PostGetTokenAccountsBody href "" "cyhole.helius.schema.PostGetTokenAccountsBody"
Request body for the getTokenAccounts DAS endpoint.
Provide at least one of mint or owner to narrow the results.
Attributes:
| Name | Type | Description |
|---|---|---|
mint |
str | None
|
SPL token mint address to filter by. |
owner |
str | None
|
wallet address of the token account owner. |
page |
int | None
|
page number for pagination (default 1). |
limit |
int | None
|
results per page (default 100). |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.HeliusComparisonFilter[HeliusComparisonFilter]
click cyhole.helius.schema.HeliusComparisonFilter href "" "cyhole.helius.schema.HeliusComparisonFilter"
Numeric range filter used by
PostGetTransfersByAddressFilters
and PostGetTransactionsForAddressFilters.
All operators are optional and can be combined freely; an omitted bound means the value is unconstrained on that side.
Attributes:
| Name | Type | Description |
|---|---|---|
gt |
int | None
|
greater than this value (exclusive). |
gte |
int | None
|
greater than or equal to this value (inclusive). |
lt |
int | None
|
less than this value (exclusive). |
lte |
int | None
|
less than or equal to this value (inclusive). |
eq |
int | None
|
exact match. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.HeliusSignatureComparisonFilter[HeliusSignatureComparisonFilter]
click cyhole.helius.schema.HeliusSignatureComparisonFilter href "" "cyhole.helius.schema.HeliusSignatureComparisonFilter"
Lexicographic range filter on a transaction signature, used by the signature
filter of PostGetTransactionsForAddressFilters.
Values are base58-encoded signature strings; comparison is performed lexicographically by the API.
Attributes:
| Name | Type | Description |
|---|---|---|
gt |
str | None
|
greater than this signature (exclusive). |
gte |
str | None
|
greater than or equal to this signature (inclusive). |
lt |
str | None
|
less than this signature (exclusive). |
lte |
str | None
|
less than or equal to this signature (inclusive). |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransfersByAddressFilters[PostGetTransfersByAddressFilters]
click cyhole.helius.schema.PostGetTransfersByAddressFilters href "" "cyhole.helius.schema.PostGetTransfersByAddressFilters"
Optional numeric filters for the getTransfersByAddress RPC method.
Attributes:
| Name | Type | Description |
|---|---|---|
amount |
HeliusComparisonFilter | None
|
filter by raw transfer amount (not UI amount). |
block_time |
HeliusComparisonFilter | None
|
filter by block timestamp in Unix seconds. |
slot |
HeliusComparisonFilter | None
|
filter by slot number. |
class-attribute
instance-attribute
¶
block_time: HeliusComparisonFilter | None = Field(
default=None, alias="blockTime"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransfersByAddressBody[PostGetTransfersByAddressBody]
click cyhole.helius.schema.PostGetTransfersByAddressBody href "" "cyhole.helius.schema.PostGetTransfersByAddressBody"
Request body (the config object) for the getTransfersByAddress RPC method.
The owner address is passed as the first positional parameter of the JSON-RPC
call and is therefore handled separately by the
Helius._post_get_transfers_by_address
method; every field of this body model is optional.
Attributes:
| Name | Type | Description |
|---|---|---|
with_address |
str | None
|
counterparty address — return only transfers to or from this wallet.
|
direction |
str | None
|
transfer direction relative to the queried address. Accepts the
values of |
mint |
str | None
|
token mint address to filter by. Use |
sol_mode |
str | None
|
how native SOL and WSOL are represented. Accepts the values of
|
filters |
PostGetTransfersByAddressFilters | None
|
optional numeric filters for amount, block time, and slot. |
limit |
int | None
|
maximum number of transfers returned per page (range |
pagination_token |
str | None
|
cursor from the previous response — pass the value
received in |
commitment |
str | None
|
data commitment level. Accepts the values of
|
sort_order |
str | None
|
result ordering. Accepts the values of
|
class-attribute
instance-attribute
¶
with_address: str | None = Field(default=None, alias="with")
class-attribute
instance-attribute
¶
sol_mode: str | None = Field(default=None, alias='solMode')
class-attribute
instance-attribute
¶
filters: PostGetTransfersByAddressFilters | None = None
class-attribute
instance-attribute
¶
pagination_token: str | None = Field(
default=None, alias="paginationToken"
)
class-attribute
instance-attribute
¶
sort_order: str | None = Field(
default=None, alias="sortOrder"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.Transfer[Transfer]
click cyhole.helius.schema.Transfer href "" "cyhole.helius.schema.Transfer"
A single parsed transfer record returned by the getTransfersByAddress RPC method.
Attributes:
| Name | Type | Description |
|---|---|---|
signature |
str
|
transaction signature this transfer belongs to. |
slot |
int
|
slot at which the transaction landed. |
block_time |
int
|
block timestamp in Unix seconds. |
type |
str
|
transfer behavior — one of |
from_user_account |
str | None
|
sender wallet (owner) address. |
to_user_account |
str | None
|
recipient wallet (owner) address. |
from_token_account |
str | None
|
source SPL token account address. |
to_token_account |
str | None
|
destination SPL token account address. |
mint |
str
|
token mint address for the transfer. In |
amount |
str
|
raw transfer amount as a string (token base units). For Token-2022 transfers with fees, this is the amount credited to the destination. |
decimals |
int
|
number of decimal places for the mint. |
ui_amount |
str
|
human-readable amount (already scaled by |
fee_amount |
str | None
|
raw Token-2022 withheld fee as a string. |
fee_ui_amount |
str | None
|
human-readable Token-2022 withheld fee, returned as a string.
|
confirmation_status |
str
|
commitment level at the time of the response —
|
transaction_idx |
int
|
index of the transaction within its block. |
instruction_idx |
int
|
index of the originating top-level instruction within the transaction. |
inner_instruction_idx |
int
|
index of the inner instruction (CPI) within its parent top-level instruction. |
class-attribute
instance-attribute
¶
from_user_account: str | None = Field(
default=None, alias="fromUserAccount"
)
class-attribute
instance-attribute
¶
to_user_account: str | None = Field(
default=None, alias="toUserAccount"
)
class-attribute
instance-attribute
¶
from_token_account: str | None = Field(
default=None, alias="fromTokenAccount"
)
class-attribute
instance-attribute
¶
to_token_account: str | None = Field(
default=None, alias="toTokenAccount"
)
class-attribute
instance-attribute
¶
fee_amount: str | None = Field(
default=None, alias="feeAmount"
)
class-attribute
instance-attribute
¶
fee_ui_amount: str | None = Field(
default=None, alias="feeUiAmount"
)
class-attribute
instance-attribute
¶
confirmation_status: str = Field(alias="confirmationStatus")
class-attribute
instance-attribute
¶
transaction_idx: int = Field(alias='transactionIdx')
class-attribute
instance-attribute
¶
instruction_idx: int = Field(alias='instructionIdx')
class-attribute
instance-attribute
¶
inner_instruction_idx: int = Field(
alias="innerInstructionIdx"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.TransferList[TransferList]
click cyhole.helius.schema.TransferList href "" "cyhole.helius.schema.TransferList"
Paginated list of parsed transfer rows returned inside the
getTransfersByAddress JSON-RPC result.
Attributes:
| Name | Type | Description |
|---|---|---|
data |
list[Transfer]
|
list of transfer rows for the current page, ordered as requested by
|
pagination_token |
str | None
|
cursor to retrieve the next page, or |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetResponse[PostGetAssetResponse]
click cyhole.helius.schema.PostGetAssetResponse href "" "cyhole.helius.schema.PostGetAssetResponse"
JSON-RPC 2.0 response for the getAsset DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetBatchResponse[PostGetAssetBatchResponse]
click cyhole.helius.schema.PostGetAssetBatchResponse href "" "cyhole.helius.schema.PostGetAssetBatchResponse"
JSON-RPC 2.0 response for the getAssetBatch DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetProofResponse[PostGetAssetProofResponse]
click cyhole.helius.schema.PostGetAssetProofResponse href "" "cyhole.helius.schema.PostGetAssetProofResponse"
JSON-RPC 2.0 response for the getAssetProof DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetProofBatchResponse[PostGetAssetProofBatchResponse]
click cyhole.helius.schema.PostGetAssetProofBatchResponse href "" "cyhole.helius.schema.PostGetAssetProofBatchResponse"
JSON-RPC 2.0 response for the getAssetProofBatch DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByOwnerResponse[PostGetAssetsByOwnerResponse]
click cyhole.helius.schema.PostGetAssetsByOwnerResponse href "" "cyhole.helius.schema.PostGetAssetsByOwnerResponse"
JSON-RPC 2.0 response for the getAssetsByOwner DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByGroupResponse[PostGetAssetsByGroupResponse]
click cyhole.helius.schema.PostGetAssetsByGroupResponse href "" "cyhole.helius.schema.PostGetAssetsByGroupResponse"
JSON-RPC 2.0 response for the getAssetsByGroup DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByCreatorResponse[PostGetAssetsByCreatorResponse]
click cyhole.helius.schema.PostGetAssetsByCreatorResponse href "" "cyhole.helius.schema.PostGetAssetsByCreatorResponse"
JSON-RPC 2.0 response for the getAssetsByCreator DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetAssetsByAuthorityResponse[PostGetAssetsByAuthorityResponse]
click cyhole.helius.schema.PostGetAssetsByAuthorityResponse href "" "cyhole.helius.schema.PostGetAssetsByAuthorityResponse"
JSON-RPC 2.0 response for the getAssetsByAuthority DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostSearchAssetsResponse[PostSearchAssetsResponse]
click cyhole.helius.schema.PostSearchAssetsResponse href "" "cyhole.helius.schema.PostSearchAssetsResponse"
JSON-RPC 2.0 response for the searchAssets DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetSignaturesForAssetResponse[PostGetSignaturesForAssetResponse]
click cyhole.helius.schema.PostGetSignaturesForAssetResponse href "" "cyhole.helius.schema.PostGetSignaturesForAssetResponse"
JSON-RPC 2.0 response for the getSignaturesForAsset DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetNftEditionsResponse[PostGetNftEditionsResponse]
click cyhole.helius.schema.PostGetNftEditionsResponse href "" "cyhole.helius.schema.PostGetNftEditionsResponse"
JSON-RPC 2.0 response for the getNftEditions DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTokenAccountsResponse[PostGetTokenAccountsResponse]
click cyhole.helius.schema.PostGetTokenAccountsResponse href "" "cyhole.helius.schema.PostGetTokenAccountsResponse"
JSON-RPC 2.0 response for the getTokenAccounts DAS method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransfersByAddressResponse[PostGetTransfersByAddressResponse]
click cyhole.helius.schema.PostGetTransfersByAddressResponse href "" "cyhole.helius.schema.PostGetTransfersByAddressResponse"
JSON-RPC 2.0 response for the getTransfersByAddress RPC method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransactionsForAddressFilters[PostGetTransactionsForAddressFilters]
click cyhole.helius.schema.PostGetTransactionsForAddressFilters href "" "cyhole.helius.schema.PostGetTransactionsForAddressFilters"
Optional filters for the getTransactionsForAddress RPC method.
Attributes:
| Name | Type | Description |
|---|---|---|
slot |
HeliusComparisonFilter | None
|
filter by slot number using numeric comparison operators. |
block_time |
HeliusComparisonFilter | None
|
filter by block timestamp in Unix seconds. |
signature |
HeliusSignatureComparisonFilter | None
|
filter by transaction signature with lexicographic comparison. |
status |
str | None
|
filter by transaction success/failure. Accepts the values of
|
token_accounts |
str | None
|
include transactions for token accounts owned by the
queried address. Accepts the values of
|
class-attribute
instance-attribute
¶
block_time: HeliusComparisonFilter | None = Field(
default=None, alias="blockTime"
)
class-attribute
instance-attribute
¶
signature: HeliusSignatureComparisonFilter | None = None
class-attribute
instance-attribute
¶
token_accounts: str | None = Field(
default=None, alias="tokenAccounts"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransactionsForAddressBody[PostGetTransactionsForAddressBody]
click cyhole.helius.schema.PostGetTransactionsForAddressBody href "" "cyhole.helius.schema.PostGetTransactionsForAddressBody"
Request body (the config object) for the getTransactionsForAddress RPC method.
The queried address is passed as the first positional parameter of the JSON-RPC
call and is therefore handled separately by the
Helius._post_get_transactions_for_address
method; every field of this body model is optional.
Attributes:
| Name | Type | Description |
|---|---|---|
transaction_details |
str | None
|
level of detail returned for each transaction. Accepts the
values of |
sort_order |
str | None
|
result ordering. Accepts the values of
|
limit |
int | None
|
maximum number of transactions returned. Up to |
pagination_token |
str | None
|
cursor from the previous response — pass the value received
in |
commitment |
str | None
|
data commitment level. Accepts the values of
|
filters |
PostGetTransactionsForAddressFilters | None
|
advanced filters — see
|
encoding |
str | None
|
encoding format for the transaction payload — only meaningful when
|
max_supported_transaction_version |
int | None
|
maximum transaction version to return.
When |
min_context_slot |
int | None
|
minimum slot at which the request may be evaluated. |
class-attribute
instance-attribute
¶
transaction_details: str | None = Field(
default=None, alias="transactionDetails"
)
class-attribute
instance-attribute
¶
sort_order: str | None = Field(
default=None, alias="sortOrder"
)
class-attribute
instance-attribute
¶
pagination_token: str | None = Field(
default=None, alias="paginationToken"
)
class-attribute
instance-attribute
¶
filters: PostGetTransactionsForAddressFilters | None = None
class-attribute
instance-attribute
¶
max_supported_transaction_version: int | None = Field(
default=None, alias="maxSupportedTransactionVersion"
)
class-attribute
instance-attribute
¶
min_context_slot: int | None = Field(
default=None, alias="minContextSlot"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.TransactionForAddressItem[TransactionForAddressItem]
click cyhole.helius.schema.TransactionForAddressItem href "" "cyhole.helius.schema.TransactionForAddressItem"
A single transaction record returned by getTransactionsForAddress.
Fields populated depend on the transaction_details mode requested:
"signatures"mode (API default) populatessignature,err,memo, andconfirmation_status."full"mode populatestransactionandmetainstead.
Fields outside the active mode are None.
Attributes:
| Name | Type | Description |
|---|---|---|
slot |
int
|
slot containing the block with this transaction. Always present. |
transaction_index |
int
|
zero-based index of the transaction within its block.
Always present; unique to |
block_time |
int | None
|
estimated production time as a Unix timestamp (seconds).
|
signature |
str | None
|
base58-encoded transaction signature. Populated only in |
err |
dict | None
|
transaction error object, or |
memo |
str | None
|
memo attached to the transaction, or |
confirmation_status |
str | None
|
cluster confirmation status ( |
transaction |
dict | None
|
full transaction payload (message, signatures, instructions) in the
shape returned by Solana's |
meta |
dict | None
|
transaction metadata (fee, pre/post balances, inner instructions, log
messages, etc.) in the shape returned by Solana's |
class-attribute
instance-attribute
¶
transaction_index: int = Field(alias='transactionIndex')
class-attribute
instance-attribute
¶
block_time: int | None = Field(
default=None, alias="blockTime"
)
class-attribute
instance-attribute
¶
confirmation_status: str | None = Field(
default=None, alias="confirmationStatus"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.TransactionForAddressList[TransactionForAddressList]
click cyhole.helius.schema.TransactionForAddressList href "" "cyhole.helius.schema.TransactionForAddressList"
Paginated list of transactions returned inside the getTransactionsForAddress
JSON-RPC result.
Attributes:
| Name | Type | Description |
|---|---|---|
data |
list[TransactionForAddressItem]
|
list of transaction items for the current page, ordered as requested
by |
pagination_token |
str | None
|
cursor (format |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.PostGetTransactionsForAddressResponse[PostGetTransactionsForAddressResponse]
click cyhole.helius.schema.PostGetTransactionsForAddressResponse href "" "cyhole.helius.schema.PostGetTransactionsForAddressResponse"
JSON-RPC 2.0 response for the getTransactionsForAddress RPC method.
Bases: BaseModel
flowchart TD
cyhole.helius.schema.GetTransactionsByAddressQuery[GetTransactionsByAddressQuery]
click cyhole.helius.schema.GetTransactionsByAddressQuery href "" "cyhole.helius.schema.GetTransactionsByAddressQuery"
Query parameters for the getTransactionsByAddress Enhanced Transactions REST endpoint.
All fields are optional. Omitted fields apply no constraint on that dimension.
Use HeliusCommitment,
HeliusTokenAccountFilter, and
HeliusSortOrder for the corresponding .value strings.
Attributes:
| Name | Type | Description |
|---|---|---|
before_signature |
str | None
|
paginate backwards — return only transactions that occurred
before this transaction signature. |
after_signature |
str | None
|
paginate forwards — return only transactions that occurred
after this transaction signature. |
commitment |
str | None
|
block finality level ( |
token_accounts |
str | None
|
include transactions for token accounts owned by the queried
address ( |
sort_order |
str | None
|
result ordering ( |
gt_slot |
int | None
|
return only transactions in a slot strictly greater than this value.
|
gte_slot |
int | None
|
return only transactions in a slot greater than or equal to this value.
|
lt_slot |
int | None
|
return only transactions in a slot strictly less than this value.
|
lte_slot |
int | None
|
return only transactions in a slot less than or equal to this value.
|
gt_time |
int | None
|
return only transactions with a block time strictly greater than this
Unix timestamp (seconds). |
gte_time |
int | None
|
return only transactions with a block time greater than or equal to
this Unix timestamp (seconds). |
lt_time |
int | None
|
return only transactions with a block time strictly less than this
Unix timestamp (seconds). |
lte_time |
int | None
|
return only transactions with a block time less than or equal to
this Unix timestamp (seconds). |
source |
str | None
|
filter by transaction source (e.g. |
type |
str | None
|
filter by transaction type (e.g. |
limit |
int | None
|
maximum number of transactions to return (range |
class-attribute
instance-attribute
¶
before_signature: str | None = Field(
default=None, alias="before-signature"
)
class-attribute
instance-attribute
¶
after_signature: str | None = Field(
default=None, alias="after-signature"
)
class-attribute
instance-attribute
¶
token_accounts: str | None = Field(
default=None, alias="token-accounts"
)
class-attribute
instance-attribute
¶
sort_order: str | None = Field(
default=None, alias="sort-order"
)
class-attribute
instance-attribute
¶
gt_slot: int | None = Field(default=None, alias='gt-slot')
class-attribute
instance-attribute
¶
gte_slot: int | None = Field(default=None, alias="gte-slot")
class-attribute
instance-attribute
¶
lt_slot: int | None = Field(default=None, alias='lt-slot')
class-attribute
instance-attribute
¶
lte_slot: int | None = Field(default=None, alias="lte-slot")
class-attribute
instance-attribute
¶
gt_time: int | None = Field(default=None, alias='gt-time')
class-attribute
instance-attribute
¶
gte_time: int | None = Field(default=None, alias="gte-time")
class-attribute
instance-attribute
¶
lt_time: int | None = Field(default=None, alias='lt-time')
class-attribute
instance-attribute
¶
lte_time: int | None = Field(default=None, alias="lte-time")
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionNativeTransfer[EnhancedTransactionNativeTransfer]
click cyhole.helius.schema.EnhancedTransactionNativeTransfer href "" "cyhole.helius.schema.EnhancedTransactionNativeTransfer"
A native SOL transfer within an enhanced transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
from_user_account |
str | None
|
sender wallet address. |
to_user_account |
str | None
|
recipient wallet address. |
amount |
int
|
transferred amount in lamports (1 SOL = 1,000,000,000 lamports). |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionTokenTransfer[EnhancedTransactionTokenTransfer]
click cyhole.helius.schema.EnhancedTransactionTokenTransfer href "" "cyhole.helius.schema.EnhancedTransactionTokenTransfer"
An SPL token transfer within an enhanced transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
from_user_account |
str | None
|
sender wallet (owner) address. |
to_user_account |
str | None
|
recipient wallet (owner) address. |
from_token_account |
str | None
|
source SPL token account address. |
to_token_account |
str | None
|
destination SPL token account address. |
token_amount |
float
|
transferred amount as a UI-scaled float (already divided by the mint's decimal places). |
mint |
str
|
token mint address. |
class-attribute
instance-attribute
¶
from_user_account: str | None = Field(
default=None, alias="fromUserAccount"
)
class-attribute
instance-attribute
¶
to_user_account: str | None = Field(
default=None, alias="toUserAccount"
)
class-attribute
instance-attribute
¶
from_token_account: str | None = Field(
default=None, alias="fromTokenAccount"
)
class-attribute
instance-attribute
¶
to_token_account: str | None = Field(
default=None, alias="toTokenAccount"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionRawTokenAmount[EnhancedTransactionRawTokenAmount]
click cyhole.helius.schema.EnhancedTransactionRawTokenAmount href "" "cyhole.helius.schema.EnhancedTransactionRawTokenAmount"
Raw token amount with its decimal precision, used inside account-data balance changes.
Attributes:
| Name | Type | Description |
|---|---|---|
token_amount |
str
|
token balance in base units (before dividing by |
decimals |
int
|
number of decimal places for the mint. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionTokenBalanceChange[EnhancedTransactionTokenBalanceChange]
click cyhole.helius.schema.EnhancedTransactionTokenBalanceChange href "" "cyhole.helius.schema.EnhancedTransactionTokenBalanceChange"
A token balance change record within account data, showing how a token account's balance shifted as a result of the transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
user_account |
str
|
wallet (owner) address of the token account. |
token_account |
str
|
SPL token account address whose balance changed. |
mint |
str
|
token mint address. |
raw_token_amount |
EnhancedTransactionRawTokenAmount
|
balance change expressed in base units, with decimal precision encoded separately. |
class-attribute
instance-attribute
¶
raw_token_amount: EnhancedTransactionRawTokenAmount = Field(
alias="rawTokenAmount"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionAccountData[EnhancedTransactionAccountData]
click cyhole.helius.schema.EnhancedTransactionAccountData href "" "cyhole.helius.schema.EnhancedTransactionAccountData"
Account-level balance-change data for one account involved in an enhanced transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
account |
str
|
the account's public key. |
native_balance_change |
int
|
net lamport change for this account. Negative means the account paid lamports (e.g. paid the fee or transferred SOL); positive means it received lamports. |
token_balance_changes |
list[EnhancedTransactionTokenBalanceChange] | None
|
list of per-token-account balance deltas for this
account. Empty list when no SPL token balances changed for this account.
|
class-attribute
instance-attribute
¶
native_balance_change: int = Field(
alias="nativeBalanceChange"
)
class-attribute
instance-attribute
¶
token_balance_changes: (
list[EnhancedTransactionTokenBalanceChange] | None
) = Field(default=None, alias="tokenBalanceChanges")
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionError[EnhancedTransactionError]
click cyhole.helius.schema.EnhancedTransactionError href "" "cyhole.helius.schema.EnhancedTransactionError"
Error details for a failed transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
error |
str
|
human-readable error message describing why the transaction failed. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionInnerInstruction[EnhancedTransactionInnerInstruction]
click cyhole.helius.schema.EnhancedTransactionInnerInstruction href "" "cyhole.helius.schema.EnhancedTransactionInnerInstruction"
A Cross-Program Invocation (CPI) inner instruction nested inside a top-level instruction.
Attributes:
| Name | Type | Description |
|---|---|---|
accounts |
list[str]
|
ordered list of account public keys referenced by this instruction. |
data |
str
|
base58-encoded instruction data payload. |
program_id |
str
|
public key of the program that owns this instruction. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionInstruction[EnhancedTransactionInstruction]
click cyhole.helius.schema.EnhancedTransactionInstruction href "" "cyhole.helius.schema.EnhancedTransactionInstruction"
A top-level instruction in an enhanced transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
accounts |
list[str]
|
ordered list of account public keys referenced by this instruction. |
data |
str
|
base58-encoded instruction data payload. |
program_id |
str
|
public key of the program that owns this instruction. |
inner_instructions |
list[EnhancedTransactionInnerInstruction] | None
|
list of CPI inner instructions invoked by this instruction.
Empty list when no CPIs were made. |
class-attribute
instance-attribute
¶
inner_instructions: (
list[EnhancedTransactionInnerInstruction] | None
) = Field(default=None, alias="innerInstructions")
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionNFTEventNFT[EnhancedTransactionNFTEventNFT]
click cyhole.helius.schema.EnhancedTransactionNFTEventNFT href "" "cyhole.helius.schema.EnhancedTransactionNFTEventNFT"
A single NFT item referenced in an NFT event.
Attributes:
| Name | Type | Description |
|---|---|---|
mint |
str
|
mint address of the NFT. |
token_standard |
str
|
token standard of the NFT (e.g. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionNFTEvent[EnhancedTransactionNFTEvent]
click cyhole.helius.schema.EnhancedTransactionNFTEvent href "" "cyhole.helius.schema.EnhancedTransactionNFTEvent"
Decoded NFT event data for an enhanced transaction (sale, listing, mint, bid, etc.).
Attributes:
| Name | Type | Description |
|---|---|---|
description |
str | None
|
human-readable description of the NFT event. |
type |
str | None
|
NFT event type (e.g. |
source |
str | None
|
marketplace or program that generated the event (e.g. |
amount |
int | None
|
transaction amount in lamports. |
fee |
int | None
|
transaction fee in lamports. |
fee_payer |
str | None
|
wallet address that paid the transaction fee. |
signature |
str | None
|
transaction signature. |
slot |
int | None
|
slot containing the transaction. |
timestamp |
int | None
|
block time as a Unix timestamp (seconds). |
sale_type |
str | None
|
sale mechanism ( |
buyer |
str | None
|
wallet address of the buyer. |
seller |
str | None
|
wallet address of the seller. |
staker |
str | None
|
wallet address of the staker. |
nfts |
list[EnhancedTransactionNFTEventNFT] | None
|
list of NFT items involved in the event. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionNativeBalanceChange[EnhancedTransactionNativeBalanceChange]
click cyhole.helius.schema.EnhancedTransactionNativeBalanceChange href "" "cyhole.helius.schema.EnhancedTransactionNativeBalanceChange"
A native SOL balance change entry within a swap event.
Attributes:
| Name | Type | Description |
|---|---|---|
account |
str
|
public key of the account whose SOL balance changed. |
amount |
str
|
SOL amount as a string in lamports (serialised as string to avoid integer overflow for large values). |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionSwapProgramInfo[EnhancedTransactionSwapProgramInfo]
click cyhole.helius.schema.EnhancedTransactionSwapProgramInfo href "" "cyhole.helius.schema.EnhancedTransactionSwapProgramInfo"
Program metadata for an inner swap hop, identifying the DEX program used.
Attributes:
| Name | Type | Description |
|---|---|---|
source |
str | None
|
human-readable source name (e.g. |
account |
str | None
|
program account public key. |
program_name |
str | None
|
name of the program (e.g. |
instruction_name |
str | None
|
name of the instruction invoked (e.g. |
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionInnerSwap[EnhancedTransactionInnerSwap]
click cyhole.helius.schema.EnhancedTransactionInnerSwap href "" "cyhole.helius.schema.EnhancedTransactionInnerSwap"
A single hop within a multi-hop swap, showing per-program token movements.
Attributes:
| Name | Type | Description |
|---|---|---|
token_inputs |
list[EnhancedTransactionTokenTransfer] | None
|
SPL tokens entering this hop. |
token_outputs |
list[EnhancedTransactionTokenTransfer] | None
|
SPL tokens leaving this hop. |
token_fees |
list[EnhancedTransactionTokenTransfer] | None
|
SPL token fees paid for this hop. |
native_fees |
list[EnhancedTransactionNativeTransfer] | None
|
native SOL fees paid for this hop. |
program_info |
EnhancedTransactionSwapProgramInfo | None
|
metadata about the DEX program that executed this hop.
|
class-attribute
instance-attribute
¶
token_inputs: (
list[EnhancedTransactionTokenTransfer] | None
) = Field(default=None, alias="tokenInputs")
class-attribute
instance-attribute
¶
token_outputs: (
list[EnhancedTransactionTokenTransfer] | None
) = Field(default=None, alias="tokenOutputs")
class-attribute
instance-attribute
¶
token_fees: (
list[EnhancedTransactionTokenTransfer] | None
) = Field(default=None, alias="tokenFees")
class-attribute
instance-attribute
¶
native_fees: (
list[EnhancedTransactionNativeTransfer] | None
) = Field(default=None, alias="nativeFees")
class-attribute
instance-attribute
¶
program_info: EnhancedTransactionSwapProgramInfo | None = (
Field(default=None, alias="programInfo")
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionSwapEvent[EnhancedTransactionSwapEvent]
click cyhole.helius.schema.EnhancedTransactionSwapEvent href "" "cyhole.helius.schema.EnhancedTransactionSwapEvent"
Decoded swap event data for an enhanced transaction, showing token flows across hops.
Attributes:
| Name | Type | Description |
|---|---|---|
native_input |
EnhancedTransactionNativeBalanceChange | None
|
net native SOL entering the swap (before fees). |
native_output |
EnhancedTransactionNativeBalanceChange | None
|
net native SOL leaving the swap (after fees). |
token_inputs |
list[EnhancedTransactionTokenBalanceChange] | None
|
SPL tokens entering the overall swap. |
token_outputs |
list[EnhancedTransactionTokenBalanceChange] | None
|
SPL tokens leaving the overall swap. |
token_fees |
list[EnhancedTransactionTokenBalanceChange] | None
|
SPL token fees paid for the overall swap. |
native_fees |
list[EnhancedTransactionNativeBalanceChange] | None
|
native SOL fees paid for the overall swap. |
inner_swaps |
list[EnhancedTransactionInnerSwap] | None
|
ordered list of individual DEX hops that make up the route.
|
class-attribute
instance-attribute
¶
native_input: (
EnhancedTransactionNativeBalanceChange | None
) = Field(default=None, alias="nativeInput")
class-attribute
instance-attribute
¶
native_output: (
EnhancedTransactionNativeBalanceChange | None
) = Field(default=None, alias="nativeOutput")
class-attribute
instance-attribute
¶
token_inputs: (
list[EnhancedTransactionTokenBalanceChange] | None
) = Field(default=None, alias="tokenInputs")
class-attribute
instance-attribute
¶
token_outputs: (
list[EnhancedTransactionTokenBalanceChange] | None
) = Field(default=None, alias="tokenOutputs")
class-attribute
instance-attribute
¶
token_fees: (
list[EnhancedTransactionTokenBalanceChange] | None
) = Field(default=None, alias="tokenFees")
class-attribute
instance-attribute
¶
native_fees: (
list[EnhancedTransactionNativeBalanceChange] | None
) = Field(default=None, alias="nativeFees")
class-attribute
instance-attribute
¶
inner_swaps: list[EnhancedTransactionInnerSwap] | None = (
Field(default=None, alias="innerSwaps")
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionCompressedNFTEvent[EnhancedTransactionCompressedNFTEvent]
click cyhole.helius.schema.EnhancedTransactionCompressedNFTEvent href "" "cyhole.helius.schema.EnhancedTransactionCompressedNFTEvent"
Decoded compressed NFT (cNFT) event data for an enhanced transaction.
Attributes:
| Name | Type | Description |
|---|---|---|
type |
str | None
|
compressed NFT event type (e.g. |
tree_id |
str | None
|
Merkle tree account address containing the cNFT. |
asset_id |
str | None
|
asset ID (canonical on-chain identifier) of the cNFT. |
leaf_index |
int | None
|
zero-based position of the cNFT leaf in the Merkle tree.
|
instruction_index |
int | None
|
index of the top-level instruction that triggered the event.
|
inner_instruction_index |
int | None
|
index of the inner instruction (CPI) within its parent
top-level instruction. |
new_leaf_owner |
str | None
|
wallet address of the new owner after the event. |
old_leaf_owner |
str | None
|
wallet address of the previous owner before the event. |
class-attribute
instance-attribute
¶
tree_id: str | None = Field(default=None, alias='treeId')
class-attribute
instance-attribute
¶
asset_id: str | None = Field(default=None, alias='assetId')
class-attribute
instance-attribute
¶
leaf_index: int | None = Field(
default=None, alias="leafIndex"
)
class-attribute
instance-attribute
¶
instruction_index: int | None = Field(
default=None, alias="instructionIndex"
)
class-attribute
instance-attribute
¶
inner_instruction_index: int | None = Field(
default=None, alias="innerInstructionIndex"
)
class-attribute
instance-attribute
¶
new_leaf_owner: str | None = Field(
default=None, alias="newLeafOwner"
)
class-attribute
instance-attribute
¶
old_leaf_owner: str | None = Field(
default=None, alias="oldLeafOwner"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransactionEvents[EnhancedTransactionEvents]
click cyhole.helius.schema.EnhancedTransactionEvents href "" "cyhole.helius.schema.EnhancedTransactionEvents"
Parsed event data for an enhanced transaction, categorised by event type.
Only the event type(s) relevant to the transaction are populated; all others
are None.
Attributes:
| Name | Type | Description |
|---|---|---|
nft |
EnhancedTransactionNFTEvent | None
|
NFT event details (sale, listing, mint, etc.). |
swap |
EnhancedTransactionSwapEvent | None
|
DEX swap event details. |
compressed |
list[EnhancedTransactionCompressedNFTEvent] | None
|
Compressed NFT event details. |
distribute_compression_rewards |
dict | None
|
compression reward distribution event data.
Returned as a raw dict; |
set_authority |
list[dict] | dict | None
|
set-authority event data. Returned as a raw dict; |
class-attribute
instance-attribute
¶
compressed: (
list[EnhancedTransactionCompressedNFTEvent] | None
) = None
class-attribute
instance-attribute
¶
distribute_compression_rewards: dict | None = Field(
default=None, alias="distributeCompressionRewards"
)
class-attribute
instance-attribute
¶
set_authority: list[dict] | dict | None = Field(
default=None, alias="setAuthority"
)
Bases: BaseModel
flowchart TD
cyhole.helius.schema.EnhancedTransaction[EnhancedTransaction]
click cyhole.helius.schema.EnhancedTransaction href "" "cyhole.helius.schema.EnhancedTransaction"
A fully decoded, human-readable transaction returned by the Helius Enhanced
Transactions API (getTransactionsByAddress).
Helius enriches the raw Solana transaction data with human-readable descriptions, typed transfer records, and structured event payloads for common on-chain actions (swaps, NFT sales, compressed NFT operations).
Attributes:
| Name | Type | Description |
|---|---|---|
description |
str | None
|
human-readable English summary of the transaction. |
type |
str | None
|
transaction type classification (e.g. |
source |
str | None
|
the program or protocol that generated the transaction
(e.g. |
fee |
int
|
transaction fee in lamports paid by the fee payer. |
fee_payer |
str
|
wallet address that paid the transaction fee. |
signature |
str
|
base58-encoded transaction signature. |
slot |
int
|
slot number of the block containing this transaction. |
timestamp |
int
|
block production time as a Unix timestamp (seconds). |
native_transfers |
list[EnhancedTransactionNativeTransfer] | None
|
list of native SOL movements within the transaction.
|
token_transfers |
list[EnhancedTransactionTokenTransfer] | None
|
list of SPL token movements within the transaction.
|
account_data |
list[EnhancedTransactionAccountData] | None
|
per-account balance deltas (native SOL and tokens) for every
account touched by the transaction. |
transaction_error |
EnhancedTransactionError | None
|
error details if the transaction failed; |
instructions |
list[EnhancedTransactionInstruction] | None
|
top-level instructions executed in the transaction, each with
its CPI inner instructions. |
events |
EnhancedTransactionEvents | None
|
structured event data parsed by Helius (NFT, swap, compressed NFT).
|
class-attribute
instance-attribute
¶
native_transfers: (
list[EnhancedTransactionNativeTransfer] | None
) = Field(default=None, alias="nativeTransfers")
class-attribute
instance-attribute
¶
token_transfers: (
list[EnhancedTransactionTokenTransfer] | None
) = Field(default=None, alias="tokenTransfers")
class-attribute
instance-attribute
¶
account_data: (
list[EnhancedTransactionAccountData] | None
) = Field(default=None, alias="accountData")
class-attribute
instance-attribute
¶
transaction_error: EnhancedTransactionError | None = Field(
default=None, alias="transactionError"
)
class-attribute
instance-attribute
¶
instructions: (
list[EnhancedTransactionInstruction] | None
) = None
Bases: RootModel[list[EnhancedTransaction]]
flowchart TD
cyhole.helius.schema.GetTransactionsByAddressResponse[GetTransactionsByAddressResponse]
click cyhole.helius.schema.GetTransactionsByAddressResponse href "" "cyhole.helius.schema.GetTransactionsByAddressResponse"
Response for the getTransactionsByAddress Enhanced Transactions REST endpoint.
Wraps a list of EnhancedTransaction objects.
Access the transactions via .root.
Bases: RootModel[list[EnhancedTransaction]]
flowchart TD
cyhole.helius.schema.PostGetTransactionsResponse[PostGetTransactionsResponse]
click cyhole.helius.schema.PostGetTransactionsResponse href "" "cyhole.helius.schema.PostGetTransactionsResponse"
Response for the getTransactions Enhanced Transactions REST endpoint.
Wraps a list of EnhancedTransaction
objects, one per signature submitted in the request body, preserving input order.
Access the transactions via .root.