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.
cyhole.helius.schema
¶
HeliusSortConfig
¶
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 |
HeliusDisplayOptions
¶
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).
show_fungible
class-attribute
instance-attribute
¶
show_fungible: bool | None = Field(
default=None, alias="showFungible"
)
show_native_balance
class-attribute
instance-attribute
¶
show_native_balance: bool | None = Field(
default=None, alias="showNativeBalance"
)
show_collection_metadata
class-attribute
instance-attribute
¶
show_collection_metadata: bool | None = Field(
default=None, alias="showCollectionMetadata"
)
show_unverified_collections
class-attribute
instance-attribute
¶
show_unverified_collections: bool | None = Field(
default=None, alias="showUnverifiedCollections"
)
show_grand_total
class-attribute
instance-attribute
¶
show_grand_total: bool | None = Field(
default=None, alias="showGrandTotal"
)
show_inscription
class-attribute
instance-attribute
¶
show_inscription: bool | None = Field(
default=None, alias="showInscription"
)
show_zero_balance
class-attribute
instance-attribute
¶
show_zero_balance: bool | None = Field(
default=None, alias="showZeroBalance"
)
AssetFile
¶
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.).
AssetAttribute
¶
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.
AssetMetadata
¶
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.
AssetLinks
¶
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.
AssetContent
¶
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.
schema_uri
class-attribute
instance-attribute
¶
schema_uri: str | None = Field(
default=None, alias="$schema"
)
AssetAuthority
¶
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.
AssetCompression
¶
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).
AssetCollectionMetadata
¶
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.
AssetGrouping
¶
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.
collection_metadata
class-attribute
instance-attribute
¶
collection_metadata: AssetCollectionMetadata | None = None
AssetRoyalty
¶
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.
AssetCreator
¶
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.
AssetOwnership
¶
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.
AssetSupply
¶
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.
AssetPriceInfo
¶
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.
AssetTokenInfo
¶
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.
associated_token_address
class-attribute
instance-attribute
¶
associated_token_address: str | None = None
AssetInscription
¶
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.
inscription_data_account
class-attribute
instance-attribute
¶
inscription_data_account: str | None = None
AssetNativeBalance
¶
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.
Asset
¶
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.
AssetList
¶
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.
AssetProof
¶
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.
AssetSignatureList
¶
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].
TokenAccount
¶
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.
TokenAccountList
¶
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.
NftEditionItem
¶
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.
NftEditionList
¶
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.
PostGetAssetOptions
¶
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).
show_unverified_collections
class-attribute
instance-attribute
¶
show_unverified_collections: bool | None = Field(
default=None, alias="showUnverifiedCollections"
)
show_collection_metadata
class-attribute
instance-attribute
¶
show_collection_metadata: bool | None = Field(
default=None, alias="showCollectionMetadata"
)
show_fungible
class-attribute
instance-attribute
¶
show_fungible: bool | None = Field(
default=None, alias="showFungible"
)
show_inscription
class-attribute
instance-attribute
¶
show_inscription: bool | None = Field(
default=None, alias="showInscription"
)
PostGetAssetsByOwnerBody
¶
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. |
PostGetAssetsByGroupBody
¶
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. |
PostGetAssetsByCreatorBody
¶
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. |
creator_address
class-attribute
instance-attribute
¶
creator_address: str = Field(alias='creatorAddress')
only_verified
class-attribute
instance-attribute
¶
only_verified: bool | None = Field(
default=None, alias="onlyVerified"
)
display_options
class-attribute
instance-attribute
¶
display_options: HeliusDisplayOptions | None = Field(
default=None, alias="displayOptions"
)
sort_by
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
PostGetAssetsByAuthorityBody
¶
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. |
authority_address
class-attribute
instance-attribute
¶
authority_address: str = Field(alias='authorityAddress')
display_options
class-attribute
instance-attribute
¶
display_options: HeliusDisplayOptions | None = Field(
default=None, alias="displayOptions"
)
sort_by
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
PostSearchAssetsBody
¶
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. |
owner_address
class-attribute
instance-attribute
¶
owner_address: str | None = Field(
default=None, alias="ownerAddress"
)
creator_address
class-attribute
instance-attribute
¶
creator_address: str | None = Field(
default=None, alias="creatorAddress"
)
creator_verified
class-attribute
instance-attribute
¶
creator_verified: bool | None = Field(
default=None, alias="creatorVerified"
)
token_type
class-attribute
instance-attribute
¶
token_type: str | None = Field(
default=None, alias="tokenType"
)
sort_by
class-attribute
instance-attribute
¶
sort_by: HeliusSortConfig | None = Field(
default=None, alias="sortBy"
)
PostGetTokenAccountsBody
¶
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). |
HeliusComparisonFilter
¶
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. |
HeliusSignatureComparisonFilter
¶
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). |
PostGetTransfersByAddressFilters
¶
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. |
block_time
class-attribute
instance-attribute
¶
block_time: HeliusComparisonFilter | None = Field(
default=None, alias="blockTime"
)
PostGetTransfersByAddressBody
¶
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
|
with_address
class-attribute
instance-attribute
¶
with_address: str | None = Field(default=None, alias="with")
sol_mode
class-attribute
instance-attribute
¶
sol_mode: str | None = Field(default=None, alias='solMode')
filters
class-attribute
instance-attribute
¶
filters: PostGetTransfersByAddressFilters | None = None
pagination_token
class-attribute
instance-attribute
¶
pagination_token: str | None = Field(
default=None, alias="paginationToken"
)
sort_order
class-attribute
instance-attribute
¶
sort_order: str | None = Field(
default=None, alias="sortOrder"
)
Transfer
¶
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. |
from_user_account
class-attribute
instance-attribute
¶
from_user_account: str | None = Field(
default=None, alias="fromUserAccount"
)
to_user_account
class-attribute
instance-attribute
¶
to_user_account: str | None = Field(
default=None, alias="toUserAccount"
)
from_token_account
class-attribute
instance-attribute
¶
from_token_account: str | None = Field(
default=None, alias="fromTokenAccount"
)
to_token_account
class-attribute
instance-attribute
¶
to_token_account: str | None = Field(
default=None, alias="toTokenAccount"
)
fee_amount
class-attribute
instance-attribute
¶
fee_amount: str | None = Field(
default=None, alias="feeAmount"
)
fee_ui_amount
class-attribute
instance-attribute
¶
fee_ui_amount: str | None = Field(
default=None, alias="feeUiAmount"
)
confirmation_status
class-attribute
instance-attribute
¶
confirmation_status: str = Field(alias="confirmationStatus")
transaction_idx
class-attribute
instance-attribute
¶
transaction_idx: int = Field(alias='transactionIdx')
instruction_idx
class-attribute
instance-attribute
¶
instruction_idx: int = Field(alias='instructionIdx')
inner_instruction_idx
class-attribute
instance-attribute
¶
inner_instruction_idx: int = Field(
alias="innerInstructionIdx"
)
TransferList
¶
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 |
PostGetAssetResponse
¶
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.
PostGetAssetBatchResponse
¶
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.
PostGetAssetProofResponse
¶
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.
PostGetAssetProofBatchResponse
¶
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.
PostGetAssetsByOwnerResponse
¶
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.
PostGetAssetsByGroupResponse
¶
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.
PostGetAssetsByCreatorResponse
¶
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.
PostGetAssetsByAuthorityResponse
¶
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.
PostSearchAssetsResponse
¶
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.
PostGetSignaturesForAssetResponse
¶
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.
PostGetNftEditionsResponse
¶
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.
PostGetTokenAccountsResponse
¶
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.
PostGetTransfersByAddressResponse
¶
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.
PostGetTransactionsForAddressFilters
¶
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
|
block_time
class-attribute
instance-attribute
¶
block_time: HeliusComparisonFilter | None = Field(
default=None, alias="blockTime"
)
signature
class-attribute
instance-attribute
¶
signature: HeliusSignatureComparisonFilter | None = None
token_accounts
class-attribute
instance-attribute
¶
token_accounts: str | None = Field(
default=None, alias="tokenAccounts"
)
PostGetTransactionsForAddressBody
¶
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. |
transaction_details
class-attribute
instance-attribute
¶
transaction_details: str | None = Field(
default=None, alias="transactionDetails"
)
sort_order
class-attribute
instance-attribute
¶
sort_order: str | None = Field(
default=None, alias="sortOrder"
)
pagination_token
class-attribute
instance-attribute
¶
pagination_token: str | None = Field(
default=None, alias="paginationToken"
)
filters
class-attribute
instance-attribute
¶
filters: PostGetTransactionsForAddressFilters | None = None
max_supported_transaction_version
class-attribute
instance-attribute
¶
max_supported_transaction_version: int | None = Field(
default=None, alias="maxSupportedTransactionVersion"
)
min_context_slot
class-attribute
instance-attribute
¶
min_context_slot: int | None = Field(
default=None, alias="minContextSlot"
)
TransactionForAddressItem
¶
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 |
transaction_index
class-attribute
instance-attribute
¶
transaction_index: int = Field(alias='transactionIndex')
block_time
class-attribute
instance-attribute
¶
block_time: int | None = Field(
default=None, alias="blockTime"
)
confirmation_status
class-attribute
instance-attribute
¶
confirmation_status: str | None = Field(
default=None, alias="confirmationStatus"
)
TransactionForAddressList
¶
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 |
PostGetTransactionsForAddressResponse
¶
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.