Home

Pi-Developer-Handbook

Comprehensive documentation and development resources for building robust applications on the Pi Network. Enhance your understanding of Pi's APIs, SDK, and best practices to create seamless user experiences.

Now featuring Hybrid App Support! Build applications that work seamlessly in both regular browsers (Web2) and Pi Browser (Web3) environments.

Let's build great Pi Network applications together!

Quick Links

• Pi Network API Documentation: Explore API endpoints for managing pioneer data, payments, and more API Reference
• Pi App Platform SDK Guide: Learn to integrate Pi functionality directly into your app SDK Reference
• Pi Browser Detection Guide: Build hybrid apps that work in both Web2 and Web3 environments Pi Browser Detection
• Development Checklist: Follow our checklist for a smooth development process Get Started Checklist

🔄 What's New: Hybrid App Support

All examples and guides have been updated to support hybrid applications that provide:

• ✅ Smart Pi Browser Detection - Automatically detect if users are in Pi Browser
• ✅ Graceful Fallbacks - Clean UI for non-Pi Browser users with helpful messaging
• ✅ No Scary Popups - Authentication only when users are ready and in Pi Browser
• ✅ Better UX - Seamless experience across Web2 and Web3 environments
• ✅ Production Ready - Proper error handling and cleanup

Key Benefits

• Broader Reach: Your app works for both Web2 users and Pi Network pioneers
• Clean UX: No confusing authentication popups in regular browsers
• Future-Proof: Ready for Pi Network's mainstream adoption
• Easy Integration: Drop-in solutions for React and vanilla JavaScript

Example Projects

• Basic Login and Pay - Updated with Pi Browser detection and hybrid support
• Python Login Pay Subscriptions - Flask backend with hybrid frontend
• Pi Network SDK Example - Comprehensive example with all Pi features

All examples now follow the hybrid app pattern described in our Pi Browser Detection Guide.

📖 View All Examples - Complete code samples and implementation guides

Getting Started Checklist

Follow these steps to register, configure, and launch your Pi Network app.

1. Registering for an Account and Initial Setup

1. Download the Pi App:

   • Google Play Store Link
   • Apple App Store Link

2. Register for an account:

   • Use a referral code. You can find them online.

3. Download and Sign into the Pi Browser:

   • See our video tutorial Link
   • Google Play Store Link
   • Apple App Store Link

4. Verify Email Address: (Required)

   • Enter the Pi Mining App, click the ‘☰’ menu, and select "Profile".

5. Register your App and Configure Hosting:

   • Enter App Name, Description, and select the Network (See our Pi Mainnet vs Testnet Page).
   • Set up hosting on a third-party provider or Pi Network's Pi Engine.

6. Create a Wallet:

   • Create a wallet at wallet.pi. Confirm access before continuing.

7. Code and Configure Your App

   • Important: Use our updated Examples as a starting point, especially for hackathons.
   • Hybrid App Architecture: Implement Pi Browser Detection for broader reach and better UX.
   • Development URL: Enter the local host URL for sandbox testing.
   • Sandbox Mode:
     • Set the sandbox flag to "true" in your FE code.
     • Copy the sandbox code from the Pi Mining App utilities page.

8. Deploy and Validate

   • Production URL: Enter your app's live URL.
   • Validate Domain Ownership: Add the provided key to a validation-key.txt file at your domain's root.

9. Test a Pi Transaction

   • Process a User-to-App transaction to confirm everything is connected.

2. Launching on Pi Mainnet

Prerequisites:

• Pi KYC Completion
• Mainnet Wallet

1. Create a Mainnet Developer Portal Project
2. Verify Mainnet App URL (Must be unique)
3. Generate a New API Key (Testnet keys won't work)
4. Launch and Test!

3. Special Considerations

• Mainnet Payments: A migrated wallet is required on the user's end.
• Developer Terms of Service: Ensure your app stays compliant.