Using Data Sharing vs the API
Before You Get Started
Pennylane offers two main ways to connect and retrieve your data: Data Sharing and the Pennylane API.
This guide explains when and why to use each option, what it’s best for, and how to decide between them - or combine both.
Related documentation:
| Data Sharing | API | |
|---|---|---|
| Mode | Read-only | Read/Write |
| Freshness | Few hours delay | Real-time |
| Volume | Very large datasets | Small-to-medium datasets |
| Setup | Easy with BI tools | Requires developer integration |
| Best for | Analyzing data | Building custom integrations |
At a Glance
- Use the API for real-time, two-way integration (read + write) with your own tools.
- Some teams use a hybrid approach: Data Sharing for bulk scheduled retrieval, and the API for live actions (e.g. creating invoices or updating customer records).
Data Sharing
For data practitioners (analysts, BI teams) who want to integrate Pennylane data into a data warehouse or BI environment.
Key Characteristics:
- Read-only connection
- Few hours delay
- Optimized for very large datasets
- Flexible querying
- Easy setup with BI tools (Power BI, Tableau, Snowflake, …)
Examples
- Build a business activity dashboard in Power BI
- Import Pennylane data into a data lake for predictive analytics
API
For software professionals (developers, integration partners) building workflows with Pennylane.
Key Characteristics
- Read/write connection
- Data as fresh as you query it
- Efficient for small-to-medium datasets
- Parameterized endpoints for precise queries
- Requires developer setup
Examples
- Upload invoices from your invoicing tool
- Send custom email notifications when invoices are overdue
Still unsure? Start with your primary need:
- Analytics at scale → Data Sharing
- Automation & integration → API
- Both → Combine the two
Updated 12 days ago