Metadata-Version: 2.2
Name: pypumpfun
Version: 0.1.1
Summary: API wrapper for rapid-api/pumpfun-scraper-api
Home-page: https://github.com/fswair/pumpfun-api
Author: fswair
Author-email: contact@tomris.dev
Project-URL: Bug Tracker, https://github.com/fswair/pumpfun-api/issues
Project-URL: Documentation, https://rapidapi.com/domainfinderapi/api/pumpfun-scraper-api
Project-URL: Source Code, https://github.com/fswair/pumpfun-api
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


# Pumpfun API Wrapper

Python wrapper for [pumpfun-scraper-api](https://rapidapi.com/domainfinderapi/api/pumpfun-scraper-api)

## Installation

```bash
pip install pypumpfun
```

## API Key Required

⚠️ **Important:** This module requires an API key to perform requests. Get your API key from [RapidAPI - Pumpfun Scraper API](https://rapidapi.com/domainfinderapi/api/pumpfun-scraper-api)

## Quick Start

```python
from pypumpfun import Pumpfun

# Initialize with your API key
api = Pumpfun("YOUR_API_KEY")

# Search for tokens
results = api.search_tokens(term="your_search_term")
print(results)

# Get recommended tokens
tokens = api.tokens_for_you(limit=50, offset=0, include_nsfw=False)
print(tokens)
```

## Available Methods

- `ping()`: Check API health
- `search_tokens(term)`: Search tokens by term
- `tokens_for_you(limit=50, offset=0, include_nsfw=False)`: Get recommended tokens
- `similar_projects_by_mint(address, limit=50)`: Find similar projects
- `get_featured_coins()`: Get featured coins
- `get_about_graduates()`: Get graduates information
- `get_runner_tokens()`: Get runner tokens
- `get_tokens_by_meta(meta, include_nsfw=False)`: Search by metadata
- `get_token_metadata_trades(address)`: Get token metadata and trades
- `get_pumpfun_replies(address, limit=1000, offset=0)`: Get replies
- `get_candlesticks(address, timeframe=5, limit=1000, offset=0)`: Get candlestick data
- `get_king_hell(include_nsfw=False)`: Get King Hell information
- `global_params()`: Get global parameters
- `get_latest_token()`: Get latest token information

## Error Handling

The module includes built-in error handling and will return appropriate error messages if:
- API key is invalid
- API request fails
- Response parsing fails

## Rate Limits

Please be aware of the rate limits associated with your API key tier on RapidAPI.

## Support

For API access and pricing, visit [RapidAPI - Pumpfun Scraper API](https://rapidapi.com/domainfinderapi/api/pumpfun-scraper-api)

For package issues, contact: [contact@tomris.dev](mailto:contact@tomris.dev)
