README.md

Hello Moon Python SDK

Python SDK for interacting with the Official HelloMoon APIs - https://hellomoon.readme.io/.

Installation

Installing Using PIP (Recommended)

pip install hellomoon

Installing from Source

1. Clone the repository: git clone https://github.com/vmpyre/hellomoon_sdk.git

2. Change into the project directory: cd hellomoon_sdk

3. Install the dependencies: pip install -r requirements.txt

Usage

First, import the SDK's classes for the APIs you'd like to use.

>> from hellomoon import NFTSummary

Then, create instances of the classes to interact with the corresponding API endpoints (in this case the NFT class):

>> nft_api = NFT("<API_KEY_HERE>")

Generate your API Key from here: https://hellomoon.readme.io/reference/get-your-api-key

For example, you can use the collection_stats() method of the NFTSummary class to retrieve descriptive statistics of NFT collections:

>> solana_monkey_business = "d515305e2b1de0026b5bf49fbb12e107
>> nft_api.collection_stats(helloMoonCollectionId=solana_monkey_business)

That's it!

Response:

{
  "data": [
    {
      "name": "Solana Monkey Business",
      "helloMoonCollectionId": "d515305e2b1de0026b5bf49fbb12e107",
      "slug": "solana-monkey-business",
      "supply": "5000",
      "currentOwnerCount": "2790",
      "avgPriceSol": "232.073169",
      "volume24Hr": "1856.585355",
      "volumeChange24Hr": "0.511200",
      "marketCapSol": "1158741.332817",
      "averageWashScore": "7.0574",
      "listingCount": "366",
      "mintPriceMode": null,
      "narrative": null
    }
  ],
  "paginationToken": "eyJuYW1lIjoiU29sYW5hIE1vbmtleSBCdXNpbmVzcyIsImhlbGxvTW9vbkNvbGxlY3Rpb25JZCI6ImQ1MTUzMDVlMmIxZGUwMDI2YjViZjQ5ZmJiMTJlMTA3In0="
}

The SDK provides functionality for interacting with all endpoints mentioned here: https://hellomoon.readme.io/

Documentation

You can view the class methods below:

NFT

• collection_candlesticks()
• collection_mint_mapping()
• collection_name_mapping()
• collection_volatility()
• listing_status()
• nft_listings()
• metaplex_metadata()
• mints_by_owner()
• primary_sales()
• secondary_sales()

NFTSummary

• collection_daily_sales_stats()
• collection_listing_stats()
• collection_overlap()
• cumulative_nft_owners_over_time()
• collection_current_owners()
• collection_distinct_owners_over_time()
• collection_holding_period()
• collection_top_holders()
• collection_program_usage()
• collection_stats_with_floor_price()
• collection_mint_stats()
• collection_washtrading_index()
• marketplace_stats()
• market_sales_over_time()

See the Official Hello Moon documentation for additional information: https://hellomoon.readme.io/

Contribution

Feel free to open issues, pull requests and submit feedback. We appreciate your help!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Thanks to the Hello Moon team for providing an amazing product.

Disclaimer

The developer is not responsible for any errors or issues that may occur when using this SDK. Use at your own risk and feel free to report issues.