Module types

Source

Expand description

Types used as operation parameters and responses.

Modules§

builder: Types for composing complex structures.
error: Error types.

Structs§

BalanceUpdate: Balance update record
Blockchain: Blockchain information
BlockchainLatestBlock: BlockchainLatestBlock
BooleanResult: Boolean result response
CalculatePnlInput: CalculatePnlInput
ClaimRedPacketRequest: DTO.RED_PACKET.CLAIMER
ClaimRedPacketResponse: Claim red packet response
CreateRedPacketRequest: DTO.RED_PACKET.CREATOR
CreateRedPacketResponse: Create red packet response
CreateTokenInput: CreateTokenInput
CreateTokenInputName: DTO.DEX.MINT.NAME
CreateTokenInputSymbol: DTO.DEX.MINT.SYMBOL
CreateTokenInputUserAddress: DTO.DEX.WALLET
CreateTokenReply: CreateTokenReply
CreateWebhookRequest: Request to create a webhook endpoint
DevToken: Token info returned by get_dev_tokens — mirrors TS DevTokenDTO.
Dex: DEX information
DexPool: DEX pool
DexPoolDetail: DEX pool detail
DexPoolSnapshot: DEX pool liquidity snapshot
DexPoolTokenLiquidity: DEX pool token liquidity
DexPoolTokenSnapshot: DEX pool token snapshot
DexQuoteResponse: DexQuoteResponse
EndpointListResponse: Paginated list of webhook endpoints
EndpointOperationResponse: Boolean result for endpoint operations (delete, rotate secret)
EndpointSecretResponse: Secret response for a webhook endpoint
ErrorDetail: ErrorDetail
ErrorField: ErrorField
ErrorResponse: ErrorResponse
EstimateGasLimitInput: EstimateGasLimitInput
EstimateGasLimitResponse: EstimateGasLimitResponse
FilterCondition: Filter condition for token queries
GasPriceResponse: GasPriceResponse
GetMarketDataMultiResponseValue: Token market data
GetMetadataMultiResponseValue: Token metadata
GetStatsMultiResponseValue: Token statistics with nested time period data
IpfsUploadResponse: Response from IPFS JSON upload — mirrors TS uploadJson return type.
JobDto: JobDto
JobStreamingDto: JobStreamingDto
KytAddressExposure: KytAddressExposure
KytAddressIdentification: KytAddressIdentification
KytAddressRiskResponse: KytAddressRiskResponse
KytAlertDetail: KytAlertDetail
KytAlertsResponse: KytAlertsResponse
KytAlteryaIdentification: KytAlteryaIdentification
KytDirectExposureDetail: KytDirectExposureDetail
KytDirectExposureResponse: KytDirectExposureResponse
KytFraudAssessmentResponse: KytFraudAssessmentResponse
KytNetworkIdentificationOrg: KytNetworkIdentificationOrg
KytNetworkIdentificationsResponse: KytNetworkIdentificationsResponse
KytOnChainActivity: KytOnChainActivity
KytRegisterAddressInput: KytRegisterAddressInput
KytRegisterAddressResponse: KytRegisterAddressResponse
KytRegisterTransferInput: KytRegisterTransferInput
KytRegisterWithdrawalInput: KytRegisterWithdrawalInput
KytTransferBaseResponse: KytTransferBaseResponse
KytWithdrawalAddressIdentificationsResponse: KytWithdrawalAddressIdentificationsResponse
KytWithdrawalBaseResponse: KytWithdrawalBaseResponse
NetWorthByTokensItem: Single token net-worth item (mirrors TS WalletNetWorthItemDTO).
NetWorthByTokensResult: Wallet net-worth by tokens result (mirrors TS WalletNetWorthByTokensResult).
NetWorthHistoryItem: Single data point in a net-worth chart time series.
NetWorthSummaryValue: NetWorthSummaryValue
PageResponseBalanceUpdate: Generic pagination response
PageResponseBalanceUpdateDataItem: Balance update record
PageResponseDevToken: Generic pagination response
PageResponseDevTokenDataItem: Token info returned by get_dev_tokens — mirrors TS DevTokenDTO.
PageResponseDex: Generic pagination response
PageResponseDexDataItem: DEX information
PageResponseDexPool: Generic pagination response
PageResponseDexPoolDataItem: DEX pool
PageResponseDexPoolSnapshot: Generic pagination response
PageResponseDexPoolSnapshotDataItem: DEX pool liquidity snapshot
PageResponseNetWorthByTokensItem: Generic pagination response
PageResponseNetWorthByTokensItemDataItem: Single token net-worth item (mirrors TS WalletNetWorthItemDTO).
PageResponseToken: Generic pagination response
PageResponseTokenDataItem: Token entity — mirrors TS TokenDTO extends TokenMetadataDTO.
PageResponseTokenHolder: Generic pagination response
PageResponseTokenHolderDataItem: Token holder
PageResponseTokenLiquiditySnapshot: Generic pagination response
PageResponseTokenLiquiditySnapshotDataItem: Token liquidity snapshot
PageResponseTokenMintBurn: Generic pagination response
PageResponseTokenMintBurnDataItem: Token mint/burn event
PageResponseTokenPrice: Generic pagination response
PageResponseTokenPriceDataItem: Token price
PageResponseTokenTrader: Generic pagination response
PageResponseTokenTraderDataItem: Token trader info — mirrors TS TokenTraderDTO
PageResponseTokenTransfer: Generic pagination response
PageResponseTokenTransferDataItem: Token transfer
PageResponseTopTrader: Generic pagination response
PageResponseTopTraderDataItem: Top trader statistics
PageResponseTradeDetail: Generic pagination response
PageResponseTradeDetailDataItem: Trade detail
PageResponseTraderGainersLosersItem: Generic pagination response
PageResponseTraderGainersLosersItemDataItem: Trader gainers/losers item — PnL-based ranking
PageResponseWalletTransfer: Generic pagination response
PageResponseWalletTransferDataItem: Wallet transfer
PnlDetailItem: PnL detail for a single wallet-token pair (mirrors TS PnlDetailItemDTO).
PnlDetailSummary: Aggregated PnL summary across all items (mirrors TS PnlDetailSummaryDTO).
PnlDetailsResult: Full PnL details result with cursor pagination.
PresignResponseModel: PresignResponseModel
RangeFilterCondition: Range filter condition – mirrors TS FilterCondition used with min/max.
RedPacket: Red packet detail
RedPacketClaim: Red packet claim record
RedPacketClaimsPage: Paginated red packet claims response
RedPacketSendTxRequest: Send red packet transaction request
RedPacketSendTxResponse: Send red packet transaction response
RedPacketsPage: Paginated red packets response
SendTxInput: SendTxInput
SendTxResponse: SendTxResponse
SuccessResponse: SuccessResponse
SwapInput: SwapInput
SwapInputUserAddress: DTO.DEX.WALLET
SwapReply: SwapReply
SwapRouteInput: SwapRouteInput
SwapRouteInputUserAddress: DTO.DEX.WALLET
SwapRouteResponse: SwapRouteResponse
Token: Token entity — mirrors TS TokenDTO extends TokenMetadataDTO.
TokenBalance: Token balance
TokenCandle: Token candle (OHLCV)
TokenCreation: Token creation info — mirrors TS TokenCreationDTO
TokenCreator: Token creator info
TokenExtra: Token extra metadata
TokenHolder: Token holder
TokenLiquiditySnapshot: Token liquidity snapshot
TokenMarketData: Token market data
TokenMetadata: Token metadata
TokenMintBurn: Token mint/burn event
TokenPage: Token search result page — mirrors TS TokenPage.
TokenPrice: Token price
TokenSocialMedias: Token social media links
TokenStats: Token statistics with nested time period data
TokenTradeStatPeriod: Single time window trade statistics period
TokenTrader: Token trader info — mirrors TS TokenTraderDTO
TokenTransfer: Token transfer
TokenTransferTotal: Token transfer total count
TopTrader: Top trader statistics
TradeDetail: Trade detail
TraderGainersLosersItem: Trader gainers/losers item — PnL-based ranking
TransferTotalResponse: TransferTotalResponse
UpdateWebhookRequest: Request to update a webhook endpoint
WalletBalances: Wallet balances
WalletFirstTx: Wallet first transaction summary
WalletNetWorth: Wallet net worth summary
WalletNetWorthChartResponse: Wallet net-worth chart response with pagination.
WalletNetWorthDetailsPage: Paginated wallet net-worth details (mirrors TS WalletNetWorthDetailsPage).
WalletNetWorthPage: Paginated wallet net-worth page (mirrors TS WalletNetWorthPage).
WalletNetWorthSummaryResponse: WalletNetWorthSummaryResponse
WalletPnlSummary: Wallet PnL Summary (aggregated across all tokens for a given resolution)
WalletTransfer: Wallet transfer
WalletsMapResponse: WalletsMapResponse
Watchlist: Watchlist entity
WatchlistAddResponseModel: WatchlistAddResponseModel
WatchlistItem: Watchlist item
WebhookEndpoint: Webhook endpoint response

Enums§

ActivityType: Activity type (extends TradeType)
BalanceChangeType: Balance change type
BalanceTokenType: Balance token type
ChainSymbol: Supported blockchain chains
CreateTokenInputDex: DTO.DEX.IDENTIFIER
DexPoolLiquidityModel: DEX pool liquidity model (0=Unknown, 1=ReserveBased, 2=PositionBased, 3=Virtual, 4=Shared)
DexPoolType: DEX pool type (0=Unknown, 1=Standard, 2=Concentrated, 3=Weighted, 4=Stable)
DexPoolVersion: DEX pool version (0=Unknown, 1=V1, 2=V2, 3=V3)
DexProtocolFamily: DEX protocol family identifier
EndpointOrder: Ordering direction for paginated endpoint listing
GetGasLimitChain: GetGasLimitChain
GetGasPriceChain: GetGasPriceChain
HotTokenDuration: Hot token ranking duration
KytNetwork: KytNetwork
LaunchpadTag: Launchpad tag for token filtering
MintBurnType: Mint/burn type filter
PageDirection: Pagination direction
PnlResolution: PnL resolution period
PoolSortField: Pool sort field
PriceType: Price type for candle data
QuoteDex: QuoteDex
RankingDuration: RankingDuration
RankingTag: RankingTag
Resolution: Candle resolution
SearchMode: Search mode: fast returns only OpenSearch fields (default), normal enriches with full data.
SearchSortBy: SearchSortBy
SendChain: SendChain
SendTxInputSubmitType: DTO.TRANSACTION.SEND.SUBMIT_TYPE
SortDirection: Sort direction (case-insensitive: accepts “asc”/“ASC”/“Asc” etc.)
SwapInputDex: DTO.DEX.IDENTIFIER
SwapInputSwapMode: DTO.DEX.SWAP.MODE
SwapRouteInputDex: DTO.DEX.IDENTIFIER
SwapRouteInputSwapMode: DTO.DEX.SWAP.MODE
TimeFrame: Time frame for statistics
TokenField: TokenField
TokenFilter: TokenFilter
TokenListSortField: TokenListSortField
TokenTraderTag: Token trader tag
TopTraderSortBy: Sort field for top traders query
TradeType: Trade type
TraderPnlResolution: Trader PnL resolution period
TransactionStatus: Transaction status
TransferDirection: TransferDirection
WebhookChannel: Webhook event channel

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types