- Rugcheck¶
Rugcheck (https://rugcheck.xyz) is a Solana token security analysis platform that provides rug-pull risk assessments, insider network detection, liquidity analysis, and community voting on tokens.
No API key is required for public endpoints. Authenticated endpoints require a Bearer token passed as api_key to the Rugcheck constructor.
The API connector is Rugcheck class imported from cyhole.rugcheck path.
Quick Examples¶
Token Risk Report Summary¶
Check the risk score and identified risks for a token using get_token_report_summary in synchronous logic.
from cyhole.rugcheck import Rugcheck
rugcheck = Rugcheck()
summary = rugcheck.client.get_token_report_summary(
"DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263"
)
print(f"Score: {summary.score_normalised}/100")
for risk in summary.risks:
print(f" [{risk.level}] {risk.name}: {risk.description}")
Full Token Report (async)¶
Retrieve the complete rug-check report including market data, top holders, and locker info using get_token_report in asynchronous logic.
import asyncio
from cyhole.rugcheck import Rugcheck
async def main() -> None:
rugcheck = Rugcheck()
async with rugcheck.async_client as client:
report = await client.get_token_report(
"DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263"
)
print(f"Token: {report.token_meta.name} ({report.token_meta.symbol})")
print(f"Score: {report.score_normalised}/100")
print(f"Total liquidity: ${report.total_market_liquidity:,.2f}")
asyncio.run(main())
Content¶
The documentation follows the library's structure by providing all the technical details required to use it.
-
Connector
cyhole.rugcheck- Explore theRugcheckAPI connector and all its methods. -
API Parameters
cyhole.rugcheck.param- Ensure to use the correct parameters during the API calls. -
Response Schema
cyhole.rugcheck.schema- Extract only what is necessary by exploiting response mapping thanks topydanticschemes. -
Exceptions
cyhole.rugcheck.exception- Make sure you intercept all exceptions correctly.
Endpoints¶
| Endpoint | Type | Method | cyhole Release |
Deprecated |
|---|---|---|---|---|
| Ping | GET |
get_ping |
0.3.0 |
- |
| Maintenance | GET |
get_maintenance |
0.3.0 |
- |
| Leaderboard | GET |
get_leaderboard |
0.3.0 |
- |
| Token Report | GET |
get_token_report |
0.3.0 |
- |
| Token Report Summary | GET |
get_token_report_summary |
0.3.0 |
- |
| Token Metadata | GET |
get_token_metadata |
0.3.0 |
- |
| Token Votes | GET |
get_token_votes |
0.3.0 |
- |
| Token Insiders Graph | GET |
get_token_insiders_graph |
0.3.0 |
- |
| Token Insiders Networks | GET |
get_token_insiders_networks |
0.3.0 |
- |
| Token Lockers | GET |
get_token_lockers |
0.3.0 |
- |
| Token Lockers Flux | GET |
get_token_lockers_flux |
0.3.0 |
- |
| Token Report - Trigger | POST |
post_token_report |
0.3.0 |
- |
| Token Vote | POST |
post_token_vote |
0.3.0 |
- |
| Stats - New Tokens | GET |
get_stats_new_tokens |
0.3.0 |
- |
| Stats - Recent | GET |
get_stats_recent |
0.3.0 |
- |
| Stats - Trending | GET |
get_stats_trending |
0.3.0 |
- |
| Stats - Verified | GET |
get_stats_verified |
0.3.0 |
- |
| Stats - Analytics | GET |
get_stats_analytics |
0.3.0 |
- |
| Stats - Rugs Ticker | GET |
get_stats_rugs_ticker |
0.3.0 |
- |
| Creator | GET |
get_creator |
0.3.0 |
- |
| Domains | GET |
get_domains |
0.3.0 |
- |
| Domain Lookup | GET |
get_domain_lookup |
0.3.0 |
- |
| Bulk Tokens Report | POST |
post_bulk_tokens_report |
0.3.0 |
- |
| Bulk Tokens Summary | POST |
post_bulk_tokens_summary |
0.3.0 |
- |
| Tokens Verify Eligible | POST |
post_tokens_verify_eligible |
0.3.0 |
- |
| Tokens Verify | POST |
post_tokens_verify |
0.3.0 |
- |
| Tokens Verify Transaction | POST |
post_tokens_verify_transaction |
0.3.0 |
- |