A Python SDK for RSS3 Data Sub Layer (DSL)
Project description
RSS3 DSL SDK 📡
A client for interacting with the RSS3 Decentralized Service Layer (DSL) API.
Features ✨
- Fetch various types of activities for an account including collectibles, exchanges, metaverse, social, and transactions.
- Supports pagination and filtering for activity retrieval.
- Retrieve RSS activity details by path.
Installation 🚀
You can install the required dependencies using pip:
pip install rss3-dsl-sdk
Usage 📘
Initialize the Client
from rss3_dsl_sdk import RSS3Client
client = RSS3Client()
Fetch Social Post Activities
Here are some examples of fetching social post activities with different parameters:
from rss3_dsl_sdk.schemas.common import PaginationOptions, ActivityFilter
from rss3_dsl_sdk.schemas.enums import Platform
# Example 1: Basic usage with pagination
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
# Example 2: Using filters for platform
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
filters=ActivityFilter(platform=[Platform.FARCASTER, Platform.LENS]),
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
# Example 3: Using filters with time range
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
filters=ActivityFilter(since_timestamp=1625097600, until_timestamp=1627689600),
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
Fetch RSS Activity by Path
You can also fetch RSS activity details by path using the fetch_rss_activity_by_path
method:
rss_activity = client.fetch_rss_activity_by_path(path="abc")
print(rss_activity)
Other Available Methods
The RSS3Client
class provides various methods to fetch different types of activities. Below are the available methods:
fetch_collectible_approval_activities
fetch_collectible_burn_activities
fetch_collectible_mint_activities
fetch_collectible_trade_activities
fetch_collectible_transfer_activities
fetch_exchange_liquidity_activities
fetch_exchange_staking_activities
fetch_exchange_swap_activities
fetch_metaverse_burn_activities
fetch_metaverse_mint_activities
fetch_metaverse_trade_activities
fetch_metaverse_transfer_activities
fetch_social_comment_activities
fetch_social_delete_activities
fetch_social_mint_activities
fetch_social_profile_activities
fetch_social_proxy_activities
fetch_social_revise_activities
fetch_social_reward_activities
fetch_social_share_activities
fetch_transaction_approval_activities
fetch_transaction_bridge_activities
fetch_transaction_burn_activities
fetch_transaction_mint_activities
fetch_transaction_transfer_activities
Contributing 🤝
Contributions are welcome! Please open an issue or submit a pull request.
License 📄
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rss3_dsl_sdk-0.3.0.tar.gz
(15.3 kB
view hashes)
Built Distribution
Close
Hashes for rss3_dsl_sdk-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f9877f2938580de402599670830473c48d5c69f27f7d0a0b2be6dc906e07ec0 |
|
MD5 | 151eca3ae2e8bf7316904a6a69f2e2aa |
|
BLAKE2b-256 | 5c6ddb0b7563252cace6465c16e3cf8f70fe3acdc2be9129c5dff38cbe996a17 |