Surfer Protocol Python SDK
A Python SDK for interacting with the Surfer Protocol desktop application. Easily access and export data from various platforms like Twitter, Gmail, iMessage, and more.
Prerequisites
The Surfer desktop application must be running in the background for the SDK to work. Download here.
Installation
pip install surfer-protocol
Quick Start
from surfer_protocol import SurferClient
# Initialize the client
client = SurferClient()
# Get data for a specific platform
data = client.get("bookmarks-001")
# Export data for a platform
export_result = client.export("bookmarks-001")
Examples
For examples of how to use the Surfer Protocol Python SDK to build applications, please see the Cookbook.
Basic Usage
The SDK provides two main methods:
get(platform_id): Retrieve the most recent data for a platformexport(platform_id): Trigger a new export for a platform
Supported Platforms
- Twitter Bookmarks (
bookmarks-001) - Gmail (
gmail-001) - iMessage (
imessage-001) - LinkedIn Connections (
connections-001) - Notion (
notion-001) - ChatGPT (
chatgpt-001)
Documentation
For complete documentation, including detailed API reference, response schemas, example applications, and best practices, visit our official documentation.
1 maintainer
Metadata
1 maintainer
Release files for surfer-protocol 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| surfer_protocol-0.1.2.tar.gz | 3.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| surfer_protocol-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.8 kB
Release files / surfer_protocol-0.1.2.tar.gz
| Download URL | surfer_protocol-0.1.2.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e4a421fc6bb6ee46a119c11b7b24a957a7d41c44531c729280381331e46676d
|
|
BLAKE2b-256 checksum How to use checksums |
fd15b6a699716719c310122c93f132953f0039557bb768ff10a53ecb761d823f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.1
|
Release files / surfer_protocol-0.1.2-py3-none-any.whl
| Download URL | surfer_protocol-0.1.2-py3-none-any.whl |
|---|---|
| Size | 4.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ae2e8fa1b8ede2a07ba497130ed9c86d294afd4481025cdc676100c5d6414708
|
|
BLAKE2b-256 checksum How to use checksums |
eb27734fc411d1b2cd29495e41c352352320aafc9bb1c5ac76bbfc752f41c80e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.13.1
|
Security for surfer-protocol 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
