Skip to main content

Python wrapper for RugCheck API

Project description

RugCheck

This is an unofficial but simple and super easy-to-use Python wrapper for rugcheck.xyz.

If you’ve been around DEXs, you know the scams, rug pulls, and sudden liquidity losses. This wrapper lets you automate token risk checks, potentially saving your wallet before it’s too late.

RugCheck doesn’t promise you Lambos or moonshots, but it can help you avoid disasters. Use it as one part of your research arsenal.

Stay safe and happy trading!

⚠️ Disclaimer

I'm just the messenger here. This project only gives you what RugCheck reports so what they report is what you get. If they mess up or miss a rug, I'm not responsible! So please DYOR and stay cautious :)

📚 Helpful Links

📥 Installation

Get started by installing via pip:

pip install rugcheck

🚀 How to Use It

Using the Command-Line Interface (CLI)

After installation, you can use the rugcheck command directly in your terminal to get quick summary.

rugcheck <token_address>

Example:

rugcheck 6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN

Output:

Name: OFFICIAL TRUMP (TRUMP)
Rugged: No
Result: Danger
Risk Score: 18715
Mint Address: 6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN
Total Market Liquidity: $458,448,342.48

Risks:
  - Top 10 holders high ownership (Level: danger, Score: 9296)
    Description: The top 10 users hold more than 70% token supply
  - Single holder ownership (Level: danger, Score: 8000)
    Description: One user holds a large amount of the token supply
    Value: 80.00%
  - High ownership (Level: danger, Score: 1419)
    Description: The top users hold more than 80% token supply

Links:
  No links provided.

Detected At: 2025-01-17T14:27:21.13275916Z

Using It as a Python Module

Check any token with ease:

from rugcheck import rugcheck

token = '6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN'
rc = rugcheck(token)

🔑 What’s Inside?

You get all the token details found on the RugCheck website and more. Access them using JavaScript-style dot notation or Python’s classic get() method:

rc.creator                rc.get(                   rc.lockers                rc.result                 rc.to_dict()              rc.tokenType              rc.totalMarketLiquidity   
rc.detectedAt             rc.graphInsiderReport     rc.markets                rc.risks                  rc.to_json()              rc.token_address          rc.transferFee            
rc.events                 rc.graphInsidersDetected  rc.mint                   rc.rugged                 rc.token                  rc.token_extensions       rc.verification           
rc.fileMeta               rc.knownAccounts          rc.mintAuthority          rc.score                  rc.tokenMeta              rc.topHolders             
rc.freezeAuthority        rc.lockerOwners           rc.print_summary(         rc.summary                rc.tokenProgram           rc.totalLPProviders 

📦 Want to See Everything?

Export the entire token data easily:

  • As a python dictionary: rc.to_dict()
  • As a JSON string: rc.to_json()

You can check samples/response.json for the full response to see what data you can expect.

📬 Contact

dev.ccanb@protonmail.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rugcheck-1.0.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rugcheck-1.0.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file rugcheck-1.0.0.tar.gz.

File metadata

  • Download URL: rugcheck-1.0.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for rugcheck-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e84056ddbadc17678ae39e6329aad33ab422bfb0e238a86e66fd4d3f63349c9a
MD5 cec3e2516664fd65b7a7893a99f9b2ce
BLAKE2b-256 9d05eb9ace46790a68573c08148022f23861187dabd39634325f29699f9c6a79

See more details on using hashes here.

File details

Details for the file rugcheck-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: rugcheck-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for rugcheck-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9e4e7f1e38c3e304e4ab7a349474e7d22f34f127affd4d04816c044736cc338
MD5 1369ee5732f8523d8b66d0f8fa1627c7
BLAKE2b-256 460cc137a1884a908ae0bfff7acde62f4f6989d104ad155d64ddc720a84e2177

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page