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.rugcheck.schema

RugcheckRisk

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckRisk[RugcheckRisk]

              

              click cyhole.rugcheck.schema.RugcheckRisk href "" "cyhole.rugcheck.schema.RugcheckRisk"
            

A single risk factor identified during a token report.

name instance-attribute

name: str

value instance-attribute

value: str

description instance-attribute

description: str

score instance-attribute

score: int

level instance-attribute

level: str

RugcheckTokenInfo

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTokenInfo[RugcheckTokenInfo]

              

              click cyhole.rugcheck.schema.RugcheckTokenInfo href "" "cyhole.rugcheck.schema.RugcheckTokenInfo"
            

On-chain token mint account data.

mint_authority class-attribute instance-attribute

mint_authority: str | None = Field(
    default=None, alias="mintAuthority"
)

supply instance-attribute

supply: int

decimals instance-attribute

decimals: int

is_initialized class-attribute instance-attribute

is_initialized: bool = Field(alias='isInitialized')

freeze_authority class-attribute instance-attribute

freeze_authority: str | None = Field(
    default=None, alias="freezeAuthority"
)

RugcheckTokenMeta

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTokenMeta[RugcheckTokenMeta]

              

              click cyhole.rugcheck.schema.RugcheckTokenMeta href "" "cyhole.rugcheck.schema.RugcheckTokenMeta"
            

Token metadata stored on-chain (Metaplex standard).

name instance-attribute

name: str

symbol instance-attribute

symbol: str

uri instance-attribute

uri: str

mutable instance-attribute

mutable: bool

update_authority class-attribute instance-attribute

update_authority: str = Field(alias='updateAuthority')

RugcheckHolder

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckHolder[RugcheckHolder]

              

              click cyhole.rugcheck.schema.RugcheckHolder href "" "cyhole.rugcheck.schema.RugcheckHolder"
            

A single top-holder entry for a token.

address instance-attribute

address: str

amount instance-attribute

amount: int

decimals instance-attribute

decimals: int

pct instance-attribute

pct: float

ui_amount class-attribute instance-attribute

ui_amount: float = Field(alias='uiAmount')

ui_amount_string class-attribute instance-attribute

ui_amount_string: str = Field(alias='uiAmountString')

owner instance-attribute

owner: str

insider instance-attribute

insider: bool

RugcheckFileMeta

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckFileMeta[RugcheckFileMeta]

              

              click cyhole.rugcheck.schema.RugcheckFileMeta href "" "cyhole.rugcheck.schema.RugcheckFileMeta"
            

Off-chain file metadata for a token (e.g. from Arweave/IPFS).

description instance-attribute

description: str

name instance-attribute

name: str

symbol instance-attribute

symbol: str

image instance-attribute

image: str

RugcheckLocker

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckLocker[RugcheckLocker]

              

              click cyhole.rugcheck.schema.RugcheckLocker href "" "cyhole.rugcheck.schema.RugcheckLocker"
            

A single liquidity locker entry.

program_id class-attribute instance-attribute

program_id: str = Field(alias='programID')

token_account class-attribute instance-attribute

token_account: str = Field(alias='tokenAccount')

owner instance-attribute

owner: str

uri instance-attribute

uri: str

unlock_date class-attribute instance-attribute

unlock_date: int = Field(alias='unlockDate')

usdc_locked class-attribute instance-attribute

usdc_locked: float = Field(alias='usdcLocked')

type instance-attribute

type: str

RugcheckVaultSummary

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckVaultSummary[RugcheckVaultSummary]

              

              click cyhole.rugcheck.schema.RugcheckVaultSummary href "" "cyhole.rugcheck.schema.RugcheckVaultSummary"
            

Aggregated totals for a vault response.

total_usdc class-attribute instance-attribute

total_usdc: float = Field(alias='totalUSDC')

pct instance-attribute

pct: float

RugcheckTokenAccount

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTokenAccount[RugcheckTokenAccount]

              

              click cyhole.rugcheck.schema.RugcheckTokenAccount href "" "cyhole.rugcheck.schema.RugcheckTokenAccount"
            

SPL token mint account info (embedded in market data).

mint_authority class-attribute instance-attribute

mint_authority: str | None = Field(
    default=None, alias="mintAuthority"
)

supply instance-attribute

supply: int

decimals instance-attribute

decimals: int

is_initialized class-attribute instance-attribute

is_initialized: bool = Field(alias='isInitialized')

freeze_authority class-attribute instance-attribute

freeze_authority: str | None = Field(
    default=None, alias="freezeAuthority"
)

RugcheckLiquidityAccount

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckLiquidityAccount[RugcheckLiquidityAccount]

              

              click cyhole.rugcheck.schema.RugcheckLiquidityAccount href "" "cyhole.rugcheck.schema.RugcheckLiquidityAccount"
            

SPL token account holding liquidity for a market.

mint instance-attribute

mint: str

owner instance-attribute

owner: str

amount instance-attribute

amount: int

delegate class-attribute instance-attribute

delegate: str | None = None

state instance-attribute

state: int

delegated_amount class-attribute instance-attribute

delegated_amount: int = Field(alias='delegatedAmount')

close_authority class-attribute instance-attribute

close_authority: str | None = Field(
    default=None, alias="closeAuthority"
)

RugcheckLPInfo

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckLPInfo[RugcheckLPInfo]

              

              click cyhole.rugcheck.schema.RugcheckLPInfo href "" "cyhole.rugcheck.schema.RugcheckLPInfo"
            

Liquidity pool breakdown for a market.

base_mint class-attribute instance-attribute

base_mint: str = Field(alias='baseMint')

quote_mint class-attribute instance-attribute

quote_mint: str = Field(alias='quoteMint')

lp_mint class-attribute instance-attribute

lp_mint: str = Field(alias='lpMint')

quote_price class-attribute instance-attribute

quote_price: float = Field(alias='quotePrice')

base_price class-attribute instance-attribute

base_price: float = Field(alias='basePrice')

base instance-attribute

base: float

quote instance-attribute

quote: float

reserve_supply class-attribute instance-attribute

reserve_supply: int = Field(alias='reserveSupply')

current_supply class-attribute instance-attribute

current_supply: int = Field(alias='currentSupply')

quote_usd class-attribute instance-attribute

quote_usd: float = Field(alias='quoteUSD')

base_usd class-attribute instance-attribute

base_usd: float = Field(alias='baseUSD')

pct_reserve class-attribute instance-attribute

pct_reserve: int = Field(alias='pctReserve')

pct_supply class-attribute instance-attribute

pct_supply: int = Field(alias='pctSupply')

holders class-attribute instance-attribute

holders: Any | None = None

total_tokens_unlocked class-attribute instance-attribute

total_tokens_unlocked: int = Field(
    alias="totalTokensUnlocked"
)

token_supply class-attribute instance-attribute

token_supply: int = Field(alias='tokenSupply')

lp_locked class-attribute instance-attribute

lp_locked: int = Field(alias='lpLocked')

lp_unlocked class-attribute instance-attribute

lp_unlocked: int = Field(alias='lpUnlocked')

lp_locked_pct class-attribute instance-attribute

lp_locked_pct: int = Field(alias='lpLockedPct')

lp_locked_usd class-attribute instance-attribute

lp_locked_usd: int = Field(alias='lpLockedUSD')

lp_max_supply class-attribute instance-attribute

lp_max_supply: int = Field(alias='lpMaxSupply')

lp_current_supply class-attribute instance-attribute

lp_current_supply: int = Field(alias='lpCurrentSupply')

lp_total_supply class-attribute instance-attribute

lp_total_supply: int = Field(alias='lpTotalSupply')

RugcheckMarket

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckMarket[RugcheckMarket]

              

              click cyhole.rugcheck.schema.RugcheckMarket href "" "cyhole.rugcheck.schema.RugcheckMarket"
            

A single DEX market/pool for a token.

pubkey instance-attribute

pubkey: str

market_type class-attribute instance-attribute

market_type: str = Field(alias='marketType')

mint_a class-attribute instance-attribute

mint_a: str = Field(alias='mintA')

mint_b class-attribute instance-attribute

mint_b: str = Field(alias='mintB')

mint_lp class-attribute instance-attribute

mint_lp: str = Field(alias='mintLP')

liquidity_a class-attribute instance-attribute

liquidity_a: str = Field(alias='liquidityA')

liquidity_b class-attribute instance-attribute

liquidity_b: str = Field(alias='liquidityB')

mint_a_account class-attribute instance-attribute

mint_a_account: RugcheckTokenAccount = Field(
    alias="mintAAccount"
)

mint_b_account class-attribute instance-attribute

mint_b_account: RugcheckTokenAccount = Field(
    alias="mintBAccount"
)

mint_lp_account class-attribute instance-attribute

mint_lp_account: RugcheckTokenAccount = Field(
    alias="mintLPAccount"
)

liquidity_a_account class-attribute instance-attribute

liquidity_a_account: RugcheckLiquidityAccount = Field(
    alias="liquidityAAccount"
)

liquidity_b_account class-attribute instance-attribute

liquidity_b_account: RugcheckLiquidityAccount = Field(
    alias="liquidityBAccount"
)

lp instance-attribute

lp: RugcheckLPInfo

RugcheckKnownAccount

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckKnownAccount[RugcheckKnownAccount]

              

              click cyhole.rugcheck.schema.RugcheckKnownAccount href "" "cyhole.rugcheck.schema.RugcheckKnownAccount"
            

A labelled on-chain account (e.g. DEX program or AMM pool).

name instance-attribute

name: str

type instance-attribute

type: str

RugcheckTransferFee

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTransferFee[RugcheckTransferFee]

              

              click cyhole.rugcheck.schema.RugcheckTransferFee href "" "cyhole.rugcheck.schema.RugcheckTransferFee"
            

Transfer fee configuration for Token-2022 tokens.

pct instance-attribute

pct: int

max_amount class-attribute instance-attribute

max_amount: int = Field(alias='maxAmount')

authority instance-attribute

authority: str

RugcheckTokenEvent

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTokenEvent[RugcheckTokenEvent]

              

              click cyhole.rugcheck.schema.RugcheckTokenEvent href "" "cyhole.rugcheck.schema.RugcheckTokenEvent"
            

A historical event recorded for a token (e.g. authority changes).

created_at class-attribute instance-attribute

created_at: str = Field(alias='createdAt')

event instance-attribute

event: str

new_value class-attribute instance-attribute

new_value: str | None = Field(
    default=None, alias="newValue"
)

old_value class-attribute instance-attribute

old_value: str | None = Field(
    default=None, alias="oldValue"
)

RugcheckInsiderNode

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckInsiderNode[RugcheckInsiderNode]

              

              click cyhole.rugcheck.schema.RugcheckInsiderNode href "" "cyhole.rugcheck.schema.RugcheckInsiderNode"
            

A single wallet node in an insider network graph.

id instance-attribute

id: str

participant instance-attribute

participant: bool

holdings instance-attribute

holdings: int

RugcheckInsiderNetwork

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckInsiderNetwork[RugcheckInsiderNetwork]

              

              click cyhole.rugcheck.schema.RugcheckInsiderNetwork href "" "cyhole.rugcheck.schema.RugcheckInsiderNetwork"
            

A detected insider network with its member wallet nodes.

net_id instance-attribute

net_id: str

network_type instance-attribute

network_type: str

nodes instance-attribute

nodes: list[RugcheckInsiderNode]

RugcheckInsiderNetworkSummary

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckInsiderNetworkSummary[RugcheckInsiderNetworkSummary]

              

              click cyhole.rugcheck.schema.RugcheckInsiderNetworkSummary href "" "cyhole.rugcheck.schema.RugcheckInsiderNetworkSummary"
            

Summarised metadata for a detected insider network.

id instance-attribute

id: str

size instance-attribute

size: int

activity_type class-attribute instance-attribute

activity_type: str = Field(alias='activityType')

total_amount class-attribute instance-attribute

total_amount: int = Field(alias='totalAmount')

num_active_accounts class-attribute instance-attribute

num_active_accounts: int = Field(alias='numActiveAccounts')

simple instance-attribute

simple: bool

RugcheckLeaderboardEntry

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckLeaderboardEntry[RugcheckLeaderboardEntry]

              

              click cyhole.rugcheck.schema.RugcheckLeaderboardEntry href "" "cyhole.rugcheck.schema.RugcheckLeaderboardEntry"
            

A single entry in the vote leaderboard.

username instance-attribute

username: str

votes instance-attribute

votes: int

wins instance-attribute

wins: int

weight instance-attribute

weight: int

RugcheckNewToken

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckNewToken[RugcheckNewToken]

              

              click cyhole.rugcheck.schema.RugcheckNewToken href "" "cyhole.rugcheck.schema.RugcheckNewToken"
            

A recently created token as returned by the new-tokens stats endpoint.

mint instance-attribute

mint: str

decimals instance-attribute

decimals: int

symbol instance-attribute

symbol: str

creator instance-attribute

creator: str

mint_authority class-attribute instance-attribute

mint_authority: str = Field(alias='mintAuthority')

freeze_authority class-attribute instance-attribute

freeze_authority: str = Field(alias='freezeAuthority')

program instance-attribute

program: str

create_at class-attribute instance-attribute

create_at: str = Field(alias='createAt')

updated_at class-attribute instance-attribute

updated_at: str = Field(alias='updatedAt')

events class-attribute instance-attribute

events: list[RugcheckTokenEvent] | None = None

RugcheckRecentToken

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckRecentToken[RugcheckRecentToken]

              

              click cyhole.rugcheck.schema.RugcheckRecentToken href "" "cyhole.rugcheck.schema.RugcheckRecentToken"
            

A recently visited token as returned by the recent stats endpoint.

mint instance-attribute

mint: str

metadata instance-attribute

metadata: RugcheckTokenMeta

user_visits instance-attribute

user_visits: int

visits instance-attribute

visits: int

score instance-attribute

score: int

RugcheckTrendingToken

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckTrendingToken[RugcheckTrendingToken]

              

              click cyhole.rugcheck.schema.RugcheckTrendingToken href "" "cyhole.rugcheck.schema.RugcheckTrendingToken"
            

A trending token with vote counts.

mint instance-attribute

mint: str

up_count instance-attribute

up_count: int

vote_count instance-attribute

vote_count: int

RugcheckVerifiedToken

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckVerifiedToken[RugcheckVerifiedToken]

              

              click cyhole.rugcheck.schema.RugcheckVerifiedToken href "" "cyhole.rugcheck.schema.RugcheckVerifiedToken"
            

A verified token with project metadata.

mint instance-attribute

mint: str

payer instance-attribute

payer: str

name instance-attribute

name: str

symbol instance-attribute

symbol: str

description instance-attribute

description: str

jup_verified instance-attribute

jup_verified: bool

jup_strict instance-attribute

jup_strict: bool

links class-attribute instance-attribute

links: list[Any] | None = None

RugcheckDomain

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckDomain[RugcheckDomain]

              

              click cyhole.rugcheck.schema.RugcheckDomain href "" "cyhole.rugcheck.schema.RugcheckDomain"
            

A domain-mapped token entry.

mint instance-attribute

mint: str

name instance-attribute

name: str

symbol instance-attribute

symbol: str

domain instance-attribute

domain: str

created_at class-attribute instance-attribute

created_at: str = Field(alias='createdAt')

RugcheckEligibilityCriteria

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckEligibilityCriteria[RugcheckEligibilityCriteria]

              

              click cyhole.rugcheck.schema.RugcheckEligibilityCriteria href "" "cyhole.rugcheck.schema.RugcheckEligibilityCriteria"
            

Eligibility criteria evaluated for a token verification request.

exists instance-attribute

exists: bool

duplicate instance-attribute

duplicate: bool

created_recently instance-attribute

created_recently: bool

mint_authority_set instance-attribute

mint_authority_set: bool

freeze_authority_set instance-attribute

freeze_authority_set: bool

metadata_missing instance-attribute

metadata_missing: bool

liquidity_unlocked instance-attribute

liquidity_unlocked: bool

risk_score instance-attribute

risk_score: int

RugcheckVerifyData

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.RugcheckVerifyData[RugcheckVerifyData]

              

              click cyhole.rugcheck.schema.RugcheckVerifyData href "" "cyhole.rugcheck.schema.RugcheckVerifyData"
            

Metadata payload for a token verification submission.

sol_domain class-attribute instance-attribute

sol_domain: str = Field(alias='solDomain')

description instance-attribute

description: str

terms_accepted class-attribute instance-attribute

terms_accepted: bool = Field(alias='termsAccepted')

data_integrity_accepted class-attribute instance-attribute

data_integrity_accepted: bool = Field(
    alias="dataIntegrityAccepted"
)

links instance-attribute

links: dict[str, Any]

PostTokenVoteBody

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokenVoteBody[PostTokenVoteBody]

              

              click cyhole.rugcheck.schema.PostTokenVoteBody href "" "cyhole.rugcheck.schema.PostTokenVoteBody"
            

Request body for submitting a vote on a token.

mint instance-attribute

mint: str

side instance-attribute

side: bool

PostBulkTokensBody

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostBulkTokensBody[PostBulkTokensBody]

              

              click cyhole.rugcheck.schema.PostBulkTokensBody href "" "cyhole.rugcheck.schema.PostBulkTokensBody"
            

Request body for bulk token report/summary endpoints.

tokens instance-attribute

tokens: list[str]

cache_only class-attribute instance-attribute

cache_only: bool = Field(alias='cacheOnly')

PostTokensVerifyEligibleBody

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyEligibleBody[PostTokensVerifyEligibleBody]

              

              click cyhole.rugcheck.schema.PostTokensVerifyEligibleBody href "" "cyhole.rugcheck.schema.PostTokensVerifyEligibleBody"
            

Request body for checking token verification eligibility.

mint instance-attribute

mint: str

PostTokensVerifyBody

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyBody[PostTokensVerifyBody]

              

              click cyhole.rugcheck.schema.PostTokensVerifyBody href "" "cyhole.rugcheck.schema.PostTokensVerifyBody"
            

Request body for submitting a full token verification.

mint instance-attribute

mint: str

payer instance-attribute

payer: str

signature instance-attribute

signature: str

data instance-attribute

data: RugcheckVerifyData

PostTokensVerifyTransactionBody

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyTransactionBody[PostTokensVerifyTransactionBody]

              

              click cyhole.rugcheck.schema.PostTokensVerifyTransactionBody href "" "cyhole.rugcheck.schema.PostTokensVerifyTransactionBody"
            

Request body for generating a verification transaction.

mint instance-attribute

mint: str

payer instance-attribute

payer: str

data instance-attribute

data: dict[str, Any]

priority_fee instance-attribute

priority_fee: int

GetPingResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetPingResponse[GetPingResponse]

              

              click cyhole.rugcheck.schema.GetPingResponse href "" "cyhole.rugcheck.schema.GetPingResponse"
            

Response for the ping health-check endpoint.

message instance-attribute

message: str

GetMaintenanceResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetMaintenanceResponse[GetMaintenanceResponse]

              

              click cyhole.rugcheck.schema.GetMaintenanceResponse href "" "cyhole.rugcheck.schema.GetMaintenanceResponse"
            

Response for the maintenance status endpoint.

message instance-attribute

message: str

GetLeaderboardResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetLeaderboardResponse[GetLeaderboardResponse]

              

              click cyhole.rugcheck.schema.GetLeaderboardResponse href "" "cyhole.rugcheck.schema.GetLeaderboardResponse"
            

Response for the leaderboard endpoint — ordered list of top voters.

root instance-attribute

root: list[RugcheckLeaderboardEntry]

GetTokenReportResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenReportResponse[GetTokenReportResponse]

              

              click cyhole.rugcheck.schema.GetTokenReportResponse href "" "cyhole.rugcheck.schema.GetTokenReportResponse"
            

Full rug-check report for a given token mint address.

mint instance-attribute

mint: str

token_program class-attribute instance-attribute

token_program: str = Field(alias='tokenProgram')

creator instance-attribute

creator: str

creator_balance class-attribute instance-attribute

creator_balance: int = Field(alias='creatorBalance')

token instance-attribute

token: RugcheckTokenInfo

token_extensions class-attribute instance-attribute

token_extensions: Any | None = Field(
    default=None, alias="token_extensions"
)

token_meta class-attribute instance-attribute

token_meta: RugcheckTokenMeta = Field(alias='tokenMeta')

top_holders class-attribute instance-attribute

top_holders: list[RugcheckHolder] = Field(
    alias="topHolders"
)

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"
)

risks instance-attribute

risks: list[RugcheckRisk]

score instance-attribute

score: int

score_normalised instance-attribute

score_normalised: int

file_meta class-attribute instance-attribute

file_meta: RugcheckFileMeta = Field(alias='fileMeta')

locker_owners class-attribute instance-attribute

locker_owners: dict[str, Any] = Field(alias='lockerOwners')

lockers instance-attribute

lockers: dict[str, RugcheckLocker]

locker_scan_status class-attribute instance-attribute

locker_scan_status: str = Field(alias='lockerScanStatus')

markets instance-attribute

markets: list[RugcheckMarket]

total_market_liquidity class-attribute instance-attribute

total_market_liquidity: float = Field(
    alias="totalMarketLiquidity"
)

total_stable_liquidity class-attribute instance-attribute

total_stable_liquidity: float = Field(
    alias="totalStableLiquidity"
)

total_lp_providers class-attribute instance-attribute

total_lp_providers: int = Field(alias='totalLPProviders')

total_holders class-attribute instance-attribute

total_holders: int = Field(alias='totalHolders')

price instance-attribute

price: float

rugged instance-attribute

rugged: bool

token_type class-attribute instance-attribute

token_type: str = Field(alias='tokenType')

transfer_fee class-attribute instance-attribute

transfer_fee: RugcheckTransferFee = Field(
    alias="transferFee"
)

known_accounts class-attribute instance-attribute

known_accounts: dict[str, RugcheckKnownAccount] = Field(
    alias="knownAccounts"
)

GetTokenReportSummaryResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenReportSummaryResponse[GetTokenReportSummaryResponse]

              

              click cyhole.rugcheck.schema.GetTokenReportSummaryResponse href "" "cyhole.rugcheck.schema.GetTokenReportSummaryResponse"
            

Lightweight summary of a token report.

token_program class-attribute instance-attribute

token_program: str = Field(alias='tokenProgram')

token_type class-attribute instance-attribute

token_type: str = Field(alias='tokenType')

risks instance-attribute

risks: list[RugcheckRisk]

score instance-attribute

score: int

score_normalised instance-attribute

score_normalised: int

lp_locked_pct class-attribute instance-attribute

lp_locked_pct: float = Field(alias='lpLockedPct')

mint class-attribute instance-attribute

mint: str | None = None

error class-attribute instance-attribute

error: str | None = None

GetTokenMetadataResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenMetadataResponse[GetTokenMetadataResponse]

              

              click cyhole.rugcheck.schema.GetTokenMetadataResponse href "" "cyhole.rugcheck.schema.GetTokenMetadataResponse"
            

Token metadata including image URI.

mint instance-attribute

mint: str

decimals instance-attribute

decimals: int

image_uri class-attribute instance-attribute

image_uri: str = Field(alias='imageUri')

image_type class-attribute instance-attribute

image_type: str = Field(alias='imageType')

name instance-attribute

name: str

symbol instance-attribute

symbol: str

update_authority class-attribute instance-attribute

update_authority: str = Field(alias='updateAuthority')

GetTokenVotesResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenVotesResponse[GetTokenVotesResponse]

              

              click cyhole.rugcheck.schema.GetTokenVotesResponse href "" "cyhole.rugcheck.schema.GetTokenVotesResponse"
            

Community vote counts for a token.

up instance-attribute

up: int

down instance-attribute

down: int

user_voted class-attribute instance-attribute

user_voted: bool = Field(alias='userVoted')

GetTokenInsidersGraphResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenInsidersGraphResponse[GetTokenInsidersGraphResponse]

              

              click cyhole.rugcheck.schema.GetTokenInsidersGraphResponse href "" "cyhole.rugcheck.schema.GetTokenInsidersGraphResponse"
            

List of insider networks with full node graph for a token.

root instance-attribute

root: list[RugcheckInsiderNetwork]

GetTokenInsidersNetworksResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenInsidersNetworksResponse[GetTokenInsidersNetworksResponse]

              

              click cyhole.rugcheck.schema.GetTokenInsidersNetworksResponse href "" "cyhole.rugcheck.schema.GetTokenInsidersNetworksResponse"
            

Summarised list of insider network metadata for a token.

root instance-attribute

root: list[RugcheckInsiderNetworkSummary]

GetStatsNewTokensResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsNewTokensResponse[GetStatsNewTokensResponse]

              

              click cyhole.rugcheck.schema.GetStatsNewTokensResponse href "" "cyhole.rugcheck.schema.GetStatsNewTokensResponse"
            

List of recently created tokens.

root instance-attribute

root: list[RugcheckNewToken]

GetStatsRecentResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsRecentResponse[GetStatsRecentResponse]

              

              click cyhole.rugcheck.schema.GetStatsRecentResponse href "" "cyhole.rugcheck.schema.GetStatsRecentResponse"
            

List of recently visited/checked tokens.

root instance-attribute

root: list[RugcheckRecentToken]

GetStatsTrendingResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsTrendingResponse[GetStatsTrendingResponse]

              

              click cyhole.rugcheck.schema.GetStatsTrendingResponse href "" "cyhole.rugcheck.schema.GetStatsTrendingResponse"
            

List of trending tokens by vote activity (may be empty/null).

root instance-attribute

root: list[RugcheckTrendingToken] | None

GetStatsVerifiedResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsVerifiedResponse[GetStatsVerifiedResponse]

              

              click cyhole.rugcheck.schema.GetStatsVerifiedResponse href "" "cyhole.rugcheck.schema.GetStatsVerifiedResponse"
            

List of verified tokens with project metadata.

root instance-attribute

root: list[RugcheckVerifiedToken]

GetStatsAnalyticsResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsAnalyticsResponse[GetStatsAnalyticsResponse]

              

              click cyhole.rugcheck.schema.GetStatsAnalyticsResponse href "" "cyhole.rugcheck.schema.GetStatsAnalyticsResponse"
            

Aggregate analytics statistics for a given time window.

avg_launch_score class-attribute instance-attribute

avg_launch_score: float = Field(alias='avgLaunchScore')

avg_time_to_rug_minutes class-attribute instance-attribute

avg_time_to_rug_minutes: dict[str, Any] = Field(
    alias="avgTimeToRugMinutes"
)

avg_rug_score class-attribute instance-attribute

avg_rug_score: float = Field(alias='avgRugScore')

window instance-attribute

window: str

avg_token_score class-attribute instance-attribute

avg_token_score: float = Field(alias='avgTokenScore')

tokens_launched class-attribute instance-attribute

tokens_launched: dict[str, Any] = Field(
    alias="tokensLaunched"
)

rug_pull_count class-attribute instance-attribute

rug_pull_count: dict[str, Any] = Field(alias="rugPullCount")

insider_stats class-attribute instance-attribute

insider_stats: dict[str, Any] = Field(alias='insiderStats')

avg_insider_network_size class-attribute instance-attribute

avg_insider_network_size: float = Field(
    alias="avgInsiderNetworkSize"
)

rug_market_cap_usd class-attribute instance-attribute

rug_market_cap_usd: float = Field(alias='rugMarketCapUSD')

GetStatsRugsTickerResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetStatsRugsTickerResponse[GetStatsRugsTickerResponse]

              

              click cyhole.rugcheck.schema.GetStatsRugsTickerResponse href "" "cyhole.rugcheck.schema.GetStatsRugsTickerResponse"
            

Recent rug-pull ticker items.

items instance-attribute

items: list[Any]

GetCreatorResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetCreatorResponse[GetCreatorResponse]

              

              click cyhole.rugcheck.schema.GetCreatorResponse href "" "cyhole.rugcheck.schema.GetCreatorResponse"
            

Creator wallet statistics including rug history.

wallet instance-attribute

wallet: str

total_tokens class-attribute instance-attribute

total_tokens: int = Field(alias='totalTokens')

rugged_tokens class-attribute instance-attribute

rugged_tokens: int = Field(alias='ruggedTokens')

avg_launch_score class-attribute instance-attribute

avg_launch_score: float = Field(alias='avgLaunchScore')

last_token_at class-attribute instance-attribute

last_token_at: str | None = Field(
    default=None, alias="lastTokenAt"
)

last_rug_at class-attribute instance-attribute

last_rug_at: str | None = Field(
    default=None, alias="lastRugAt"
)

auto_blacklisted class-attribute instance-attribute

auto_blacklisted: bool = Field(alias='autoBlacklisted')

manual_blacklisted class-attribute instance-attribute

manual_blacklisted: bool = Field(alias='manualBlacklisted')

updated_at class-attribute instance-attribute

updated_at: str = Field(alias='updatedAt')

GetDomainsResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetDomainsResponse[GetDomainsResponse]

              

              click cyhole.rugcheck.schema.GetDomainsResponse href "" "cyhole.rugcheck.schema.GetDomainsResponse"
            

List of domain-mapped tokens.

root instance-attribute

root: list[RugcheckDomain]

GetDomainLookupResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.GetDomainLookupResponse[GetDomainLookupResponse]

              

              click cyhole.rugcheck.schema.GetDomainLookupResponse href "" "cyhole.rugcheck.schema.GetDomainLookupResponse"
            

Resolved mint address for a given domain.

root instance-attribute

root: str

PostTokenReportResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokenReportResponse[PostTokenReportResponse]

              

              click cyhole.rugcheck.schema.PostTokenReportResponse href "" "cyhole.rugcheck.schema.PostTokenReportResponse"
            

Response confirming a token report generation was queued.

ok instance-attribute

ok: bool

PostTokenVoteResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokenVoteResponse[PostTokenVoteResponse]

              

              click cyhole.rugcheck.schema.PostTokenVoteResponse href "" "cyhole.rugcheck.schema.PostTokenVoteResponse"
            

Updated vote counts after casting a vote.

up instance-attribute

up: int

down instance-attribute

down: int

user_voted class-attribute instance-attribute

user_voted: bool = Field(alias='userVoted')

GetTokenLockersResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenLockersResponse[GetTokenLockersResponse]

              

              click cyhole.rugcheck.schema.GetTokenLockersResponse href "" "cyhole.rugcheck.schema.GetTokenLockersResponse"
            

Vault response containing locker details and aggregate totals.

lockers instance-attribute

lockers: dict[str, RugcheckLocker]

total instance-attribute

total: RugcheckVaultSummary

GetTokenLockersFluxResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.GetTokenLockersFluxResponse[GetTokenLockersFluxResponse]

              

              click cyhole.rugcheck.schema.GetTokenLockersFluxResponse href "" "cyhole.rugcheck.schema.GetTokenLockersFluxResponse"
            

Flux vault response containing locker details and aggregate totals.

lockers instance-attribute

lockers: dict[str, RugcheckLocker]

total instance-attribute

total: RugcheckVaultSummary

PostBulkTokensReportResponse

Bases: RootModel

              flowchart TD
              cyhole.rugcheck.schema.PostBulkTokensReportResponse[PostBulkTokensReportResponse]

              

              click cyhole.rugcheck.schema.PostBulkTokensReportResponse href "" "cyhole.rugcheck.schema.PostBulkTokensReportResponse"
            

Detailed reports for multiple tokens requested in bulk.

root instance-attribute

root: list[GetTokenReportResponse]

PostBulkTokensSummaryResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostBulkTokensSummaryResponse[PostBulkTokensSummaryResponse]

              

              click cyhole.rugcheck.schema.PostBulkTokensSummaryResponse href "" "cyhole.rugcheck.schema.PostBulkTokensSummaryResponse"
            

Summary reports for multiple tokens requested in bulk.

reports instance-attribute

reports: list[GetTokenReportSummaryResponse]

PostTokensVerifyEligibleResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyEligibleResponse[PostTokensVerifyEligibleResponse]

              

              click cyhole.rugcheck.schema.PostTokensVerifyEligibleResponse href "" "cyhole.rugcheck.schema.PostTokensVerifyEligibleResponse"
            

Eligibility check result for a token verification request.

mint instance-attribute

mint: str

eligible instance-attribute

eligible: bool

criteria instance-attribute

criteria: RugcheckEligibilityCriteria

PostTokensVerifyResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyResponse[PostTokensVerifyResponse]

              

              click cyhole.rugcheck.schema.PostTokensVerifyResponse href "" "cyhole.rugcheck.schema.PostTokensVerifyResponse"
            

Response confirming a token verification was submitted.

ok instance-attribute

ok: bool

PostTokensVerifyTransactionResponse

Bases: BaseModel

              flowchart TD
              cyhole.rugcheck.schema.PostTokensVerifyTransactionResponse[PostTokensVerifyTransactionResponse]

              

              click cyhole.rugcheck.schema.PostTokensVerifyTransactionResponse href "" "cyhole.rugcheck.schema.PostTokensVerifyTransactionResponse"
            

Serialised transaction for on-chain token verification.

transaction instance-attribute

transaction: str