Skip to content
 
 

Repository files navigation

myco API 🌟

myco API is a powerful tool designed to help developers and creators leverage the Zora ecosystem more effectively. It provides a suite of endpoints that simplify interaction with Zora's blockchain data and offer valuable insights. 🚀

Tech Stack 🛠️

  • Frontend: Next.js 14, React 18, TypeScript
  • Styling: Tailwind CSS, shadcn/ui
  • Backend: Next.js API Routes
  • Blockchain Interaction: viem
  • Authentication: Privy
  • Analytics: Stack
  • Deployment: Vercel

Getting Started 🏁

  1. Clone the repository:

    git clone https://github.com/sweetmantech/myco-api.git
    cd myco-api
    
  2. Install dependencies:

    yarn install
    
  3. Set up environment variables: Create a .env.local file in the root directory and add the following variables:

    STACK_API_KEY=your_stack_api_key
    PRIVY_APP_ID=your_privy_app_id
    PRIVY_APP_SECRET=your_privy_app_secret
    
  4. Run the development server:

    yarn dev
    
  5. Open http://localhost:3000 in your browser to see the application.

How myco API Helps Developers 👨‍💻

  1. Simplified Zora Integration: Access Zora protocol data through easy-to-use REST API endpoints. 🔗
  2. Profile Information: Retrieve comprehensive Zora profile data for any address. 👤
  3. Token and Collection Data: Easily fetch information about Zora tokens and collections. 🖼️
  4. Rewards System: Access and track Zora rewards for different activities. 🏆
  5. Leaderboard: Implement gamification features using the built-in leaderboard system. 🏅
  6. Scoring System: Utilize the Zora score calculation for user engagement metrics. 📊

How myco API Helps Creators 🎨

  1. Profile Insights: Gain valuable insights into your Zora profile, including completeness score and follower metrics. 📈
  2. Reward Tracking: Easily monitor your earnings from creator rewards, referrals, and first minter bonuses. 💰
  3. Collection Management: Access detailed information about your created collections and their performance. 🗂️
  4. Engagement Metrics: Understand your audience better with follower and following scores. 🤝
  5. Leaderboard Participation: Increase visibility and engagement by participating in the platform's leaderboard. 🌟

API Endpoints 🔌

For a complete list of available API endpoints and their usage, please refer to our API documentation.

Contributing 🤝

We welcome contributions! Please open a pull request to contribute.

License 📄

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

Authors ✍️

Releases

Packages

Contributors

Languages