Response Schema¶
cyhole.solana_fm.schema
¶
SolanaFMBaseResponse
¶
SolanaFMPagination
¶
GetAccountTransactionsParam
¶
Bases: BaseModel
Model used to identify the parameters of the GET "Account - Transactions" endpoint.
utc_from_unix_time
class-attribute
instance-attribute
¶
utc_from_unix_time: int | None = Field(
default=None, serialization_alias="utcFrom"
)
The start date of the transactions to filter by in Unix time.
utc_to_unix_time
class-attribute
instance-attribute
¶
utc_to_unix_time: int | None = Field(
default=None, serialization_alias="utcTo"
)
The end date of the transactions to filter by in Unix time.
inflow
class-attribute
instance-attribute
¶
inflow: bool | None = None
Whether to include inflow transactions.
outflow
class-attribute
instance-attribute
¶
outflow: bool | None = None
Whether to include outflow transactions.
mints
class-attribute
instance-attribute
¶
mints: str | list[str] | None = None
The mint ID(s) to filter by.
amount_from
class-attribute
instance-attribute
¶
amount_from: int | None = Field(
default=None, serialization_alias="amountFrom", gt=0
)
The minimum amount of the transaction.
amount_to
class-attribute
instance-attribute
¶
amount_to: int | None = Field(
default=None, serialization_alias="amountTo", gt=0
)
The maximum amount of the transaction.
programs
class-attribute
instance-attribute
¶
programs: str | list[str] | None = None
The program ID(s) to filter by.
limit
class-attribute
instance-attribute
¶
limit: int | None = Field(default=None, le=1000, gt=0)
The number of transactions to return.
page
class-attribute
instance-attribute
¶
page: int = Field(default=1, gt=0)
The page number to return.
serialize_str_list_input
classmethod
¶
serialize_str_list_input(
str_input: str | list[str] | None,
) -> str | None
Source code in src/cyhole/solana_fm/schema.py
58 59 60 61 | |
serialize_flows
classmethod
¶
serialize_flows(value: bool | None) -> str | None
Source code in src/cyhole/solana_fm/schema.py
63 64 65 66 67 68 | |
GetAccountTransactionsData
¶
Bases: BaseModel
Model used to identify the data of the GET "Account - Transactions" endpoint.
confirmation_status
class-attribute
instance-attribute
¶
confirmation_status: str = Field(alias="confirmationStatus")
GetAccountTransactionsResult
¶
GetAccountTransactionsResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Account - Transactions" endpoint.
GetAccountTransfersParam
¶
Bases: BaseModel
Model used to identify the parameters of the GET "Account - Transfers" endpoint.
utc_from_unix_time
class-attribute
instance-attribute
¶
utc_from_unix_time: int | None = Field(
default=None, serialization_alias="utcFrom"
)
The start date of the transactions to filter by in Unix time.
utc_to_unix_time
class-attribute
instance-attribute
¶
utc_to_unix_time: int | None = Field(
default=None, serialization_alias="utcTo"
)
The end date of the transactions to filter by in Unix time.
inflow
class-attribute
instance-attribute
¶
inflow: bool | None = None
Whether to include inflow transactions.
outflow
class-attribute
instance-attribute
¶
outflow: bool | None = None
Whether to include outflow transactions.
mint
class-attribute
instance-attribute
¶
mint: str | list[str] | None = None
The mint ID(s) to filter by.
limit
class-attribute
instance-attribute
¶
limit: int | None = Field(default=None, le=100, gt=0)
The number of transactions to return.
page
class-attribute
instance-attribute
¶
page: int = Field(default=1, gt=0)
The page number to return.
serialize_str_list_input
classmethod
¶
serialize_str_list_input(
str_input: str | list[str] | None,
) -> str | None
Source code in src/cyhole/solana_fm/schema.py
122 123 124 125 | |
serialize_flows
classmethod
¶
serialize_flows(value: bool | None) -> str | None
Source code in src/cyhole/solana_fm/schema.py
127 128 129 130 131 132 | |
GetAccountTransfersData
¶
Bases: BaseModel
Model used to identify the data of the GET "Account - Transfers" endpoint.
instruction_index
class-attribute
instance-attribute
¶
instruction_index: int = Field(alias='instructionIndex')
inner_instruction_index
class-attribute
instance-attribute
¶
inner_instruction_index: int = Field(
alias="innerInstructionIndex"
)
source_association
class-attribute
instance-attribute
¶
source_association: str | None = Field(
default=None, alias="sourceAssociation"
)
destination_association
class-attribute
instance-attribute
¶
destination_association: str | None = Field(
default=None, alias="destinationAssociation"
)
GetAccountTransfersResults
¶
GetAccountTransfersResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Account - Transfers" endpoint.
GetAccountTransfersCsvExportParam
¶
Bases: GetAccountTransactionsParam
Model used to identify the parameters of the GET "Account - Transfers CSV Export" endpoint.
GetAccountTransfersCsvExportResponse
¶
Bases: BaseModel
Model used to identify the response of the GET "Account - Transfers CSV Export" endpoint.
GetAccountTransactionsFeesData
¶
Bases: BaseModel
Model used to identify the data of the GET "Account Transactions Fees" endpoint.
serialize_time
classmethod
¶
serialize_time(time: datetime) -> str
Source code in src/cyhole/solana_fm/schema.py
189 190 191 192 | |
GetAccountTransactionsFeesResponse
¶
Bases: BaseModel
Model used to identify the response of the GET "Account Transactions Fees" endpoint.
SolanaFMBlockData
¶
Bases: BaseModel
Model used to identify the data of the SolanaFM block.
number_of_transactions
class-attribute
instance-attribute
¶
number_of_transactions: int = Field(
alias="numberOfTransactions"
)
successful_transactions
class-attribute
instance-attribute
¶
successful_transactions: int = Field(
alias="successfulTransactions"
)
vote_transactions
class-attribute
instance-attribute
¶
vote_transactions: int = Field(alias='voteTransactions')
number_of_rewards
class-attribute
instance-attribute
¶
number_of_rewards: int = Field(alias='numberOfRewards')
total_reward_amount
class-attribute
instance-attribute
¶
total_reward_amount: int = Field(alias='totalRewardAmount')
total_compute_units_consumed
class-attribute
instance-attribute
¶
total_compute_units_consumed: int = Field(
alias="totalComputeUnitsConsumed"
)
total_compute_units_limit
class-attribute
instance-attribute
¶
total_compute_units_limit: int = Field(
alias="totalComputeUnitsLimit"
)
GetBlocksDataData
¶
GetBlocksData
¶
GetBlocksPagination
¶
GetBlocksResult
¶
GetBlocksResponse
¶
GetBlockResult
¶
GetBlockResponse
¶
PostMultipleBlocksProducerData
¶
Bases: BaseModel
Model used to identify the data of the producer from POST "Multiple Blocks" endpoint.
logo_uri
class-attribute
instance-attribute
¶
logo_uri: str | None = Field(default=None, alias='logoURI')
PostMultipleBlocksProducer
¶
PostMultipleBlocksData
¶
PostMultipleBlocksResult
¶
PostMultipleBlocksResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the POST "Multiple Blocks" endpoint.
GetSolanaDailyTransactionFeesResult
¶
Bases: BaseModel
Model used to identify the result of the GET "Solana Daily Transaction Fees" endpoint.
parse_date
classmethod
¶
parse_date(dt: str) -> datetime
Source code in src/cyhole/solana_fm/schema.py
319 320 321 322 | |
serialize_date
classmethod
¶
serialize_date(dt: datetime) -> str
Source code in src/cyhole/solana_fm/schema.py
324 325 326 327 | |
GetSolanaDailyTransactionFeesResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Solana Daily Transaction Fees" endpoint.
GetTaggedTokensListPagination
¶
GetTaggedTokensListDataData
¶
Bases: BaseModel
Model used to identify the data of a token inside the GET "Tagged Tokens List" endpoint.
metadata_token
class-attribute
instance-attribute
¶
metadata_token: str = Field(alias='metadataToken')
GetTaggedTokensListData
¶
GetTaggedTokensListResult
¶
GetTaggedTokensListResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Tagged Tokens List" endpoint.
GetTokenInfoV0Result
¶
Bases: GetTaggedTokensListData
Model used to identify the data of the GET "Token Info (v0)" endpoint.
GetTokenInfoV0Response
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Token Info (v0)" endpoint.
PostTokenMultipleInfoV0Result
¶
Bases: GetTaggedTokensListData
Model used to identify the data of the POST "Token Multiple Info (v0)" endpoint
PostTokenMultipleInfoV0Response
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the POST "Token Multiple Info (v0)" endpoint.
GetTokenInfoV1ChainInfo
¶
Bases: BaseModel
Model used to identify the chain metadata of the token in the GET "Token Info (v1)" endpoint.
update_authority
class-attribute
instance-attribute
¶
update_authority: str = Field(alias='updateAuthority')
is_master_edition
class-attribute
instance-attribute
¶
is_master_edition: bool | None = Field(
default=None, alias="isMasterEdition"
)
seller_fee_basis_points
class-attribute
instance-attribute
¶
seller_fee_basis_points: int = Field(
alias="sellerFeeBasisPoints"
)
primary_sale_happened
class-attribute
instance-attribute
¶
primary_sale_happened: bool = Field(
alias="primarySaleHappened"
)
rule_set
class-attribute
instance-attribute
¶
rule_set: str | None = Field(default=None, alias='ruleSet')
collection_details
class-attribute
instance-attribute
¶
collection_details: str | None = Field(
default=None, alias="collectionDetails"
)
GetTokenInfoV1OffChainInfo
¶
Bases: GetTokenInfoV1ChainInfo
Model used to identify the off-chain metadata of the token in the GET "Token Info (v1)" endpoint.
GetTokenInfoV1OnChainInfo
¶
Bases: GetTokenInfoV1ChainInfo
Model used to identify the on-chain metadata of the token in the GET "Token Info (v1)" endpoint.
GetTokenInfoV1TokenMetadata
¶
Bases: BaseModel
Model used to identify the metadata of the token in the GET "Token Info (v1)" endpoint.
GetTokenInfoV1TokenList
¶
Bases: BaseModel
Model used to identify the token list in the GET "Token Info (v1)" endpoint.
GetTokenInfoV1Response
¶
Bases: BaseModel
Model used to identify the response of the GET "Token Info (v0)" endpoint.
freeze_authority
class-attribute
instance-attribute
¶
freeze_authority: str | None = Field(
default=None, alias="freezeAuthority"
)
mint_authority
class-attribute
instance-attribute
¶
mint_authority: str | None = Field(
default=None, alias="mintAuthority"
)
token_list
class-attribute
instance-attribute
¶
token_list: GetTokenInfoV1TokenList = Field(
alias="tokenList"
)
token_metadata
class-attribute
instance-attribute
¶
token_metadata: GetTokenInfoV1TokenMetadata = Field(
alias="tokenMetadata"
)
PostTokenMultipleInfoV1Response
¶
Bases: BaseModel
Model used to identify the response of the POST "Token Multiple Info (v1)" endpoint.
PostUserTokenAccountsInfoExtensionStateTransferFee
¶
Bases: BaseModel
Model used to identify the transfer fee of the extension state of the token in the POST "User's Token Accounts" endpoint.
PostUserTokenAccountsInfoExtensionState
¶
Bases: BaseModel
Model used to identify the state of the extension of the token in the POST "User's Token Accounts" endpoint.
newer_transfer_fee
class-attribute
instance-attribute
¶
newer_transfer_fee: (
PostUserTokenAccountsInfoExtensionStateTransferFee
| None
) = Field(default=None, alias="newerTransferFee")
older_transfer_fee
class-attribute
instance-attribute
¶
older_transfer_fee: (
PostUserTokenAccountsInfoExtensionStateTransferFee
| None
) = Field(default=None, alias="olderTransferFee")
withheld_amount
class-attribute
instance-attribute
¶
withheld_amount: int | None = Field(
default=None, alias="withheldAmount"
)
withdraw_withheld_authority
class-attribute
instance-attribute
¶
withdraw_withheld_authority: str | None = Field(
default=None, alias="withdrawWithheldAuthority"
)
transfer_fee_config_authority
class-attribute
instance-attribute
¶
transfer_fee_config_authority: str | None = Field(
default=None, alias="transferFeeConfigAuthority"
)
PostUserTokenAccountsInfoExtension
¶
PostUserTokenAccountsInfoTokenAmount
¶
Bases: BaseModel
Model used to identify the token amount of the token in the POST "User's Token Accounts" endpoint.
PostUserTokenAccountsInfo
¶
Bases: BaseModel
Model used to identify the info of the token of the POST "User's Token Accounts" endpoint.
PostUserTokenAccounts
¶
PostUserTokenAccountsResponse
¶
Bases: BaseModel
Model used to identify the response of the POST "User's Token Accounts" endpoint.
GetMintTokenAccountsTokenAccounts
¶
Bases: PostUserTokenAccounts
Model used to identify the token accounts of the GET "Mint Token Accounts" endpoint.
GetMintTokenAccountsResponse
¶
Bases: BaseModel
Model used to identify the response of the GET "Mint Token Accounts" endpoint.
GetOnChainTokenDataInfoExtension
¶
Bases: PostUserTokenAccountsInfoExtension
Model used to identify the extension of the token in the GET "On-Chain Token Data" endpoint.
GetOnChainTokenDataInfo
¶
Bases: BaseModel
Model used to identify the info of the token in the GET "On-Chain Token Data" endpoint.
extensions
class-attribute
instance-attribute
¶
extensions: (
list[GetOnChainTokenDataInfoExtension] | None
) = None
freeze_authority
class-attribute
instance-attribute
¶
freeze_authority: str | None = Field(
default=None, alias="freezeAuthority"
)
is_initialized
class-attribute
instance-attribute
¶
is_initialized: bool = Field(alias='isInitialized')
mint_authority
class-attribute
instance-attribute
¶
mint_authority: str | None = Field(
default=None, alias="mintAuthority"
)
GetOnChainTokenDataResponse
¶
GetTokenSupplyResponse
¶
Bases: BaseModel
Model used to identify the response of the GET "Token Supply" endpoint.
circulating_supply
class-attribute
instance-attribute
¶
circulating_supply: float = Field(alias="circulatingSupply")
token_withheld_amount
class-attribute
instance-attribute
¶
token_withheld_amount: int | None = Field(
default=None, alias="tokenWithheldAmount"
)
user_total_withheld_amount
class-attribute
instance-attribute
¶
user_total_withheld_amount: int = Field(
alias="userTotalWithheldAmount"
)
total_withheld_amount
class-attribute
instance-attribute
¶
total_withheld_amount: int = Field(
alias="totalWithheldAmount"
)
real_circulating_supply
class-attribute
instance-attribute
¶
real_circulating_supply: float = Field(
alias="realCirculatingSupply"
)
GetTransferTransactionsResult
¶
Bases: GetAccountTransfersResults
Model used to identify the result of the GET "Transfer Transactions" endpoint.
GetTransferTransactionsResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the GET "Transfer Transactions" endpoint.
PostMultipleTransferTransactionsResult
¶
Bases: GetAccountTransfersResults
Model used to identify the result of the POST "Multiple Transfer Transactions" endpoint.
PostMultipleTransferTransactionsResponse
¶
Bases: SolanaFMBaseResponse
Model used to identify the response of the POST "Multiple Transfer Transactions" endpoint.