Hint

Use Quick Start Guide to quickly jump to examples

API Reference

Interface types

b2sdk API is divided into two parts, public and internal. Please pay attention to which interface type you use.

Tip

Pinning versions properly ensures the stability of your application.

Public API

• B2 Application key
• AccountInfo
  • AccountInfo implementations
    • InMemoryAccountInfo
    • SqliteAccountInfo
  • Implementing your own
    • AccountInfo interface
    • AccountInfo helper classes
• Cache
• B2 Api client
• Exceptions
• B2 Bucket
• File locks
• Data classes
• Enums
• Progress reporters
• Synchronizer
  • Sync Options
    • Handling encryption
  • Public API classes
  • Sync Encryption Settings Providers
• B2 Utility functions
• Write intent
• Outbound Transfer Source
• Download destination
• Encryption Settings
• Encryption Types

Internal API

Note

See Internal interface chapter to learn when and how to safely use the Internal API

• b2sdk.session – B2 Session
• b2sdk.raw_api – B2 raw api wrapper
• b2sdk.b2http – thin http client wrapper
• b2sdk.utils
• b2sdk.cache
• b2sdk.stream.chained ChainedStream
• b2sdk.stream.hashing StreamWithHash
• b2sdk.stream.progress Streams with progress reporting
• b2sdk.stream.range RangeOfInputStream
• b2sdk.stream.wrapper StreamWrapper
• b2sdk.sync.action
• b2sdk.sync.exception
• b2sdk.sync.folder
• b2sdk.sync.folder_parser
• b2sdk.sync.path
• b2sdk.sync.policy
• b2sdk.sync.policy_manager
• b2sdk.sync.scan_policies
• b2sdk.sync.sync
• b2sdk.transfer.inbound.downloader.abstract – Downloader base class
• b2sdk.transfer.inbound.downloader.parallel – ParallelTransferer
• b2sdk.transfer.inbound.downloader.simple – SimpleDownloader
• b2sdk.transfer.inbound.download_manager – Manager of downloaders
• b2sdk.v1.file_metadata
• b2sdk.transfer.outbound.upload_source
• b2sdk.raw_simulator – B2 raw api simulator