Skip to content

Client Reference

The filebin package exposes two primary clients: 1. AsyncFilebinClient — The native asynchronous client (recommended). 2. FilebinClient — A synchronous wrapper.

Both clients expose identical public methods.

Async SDK client for the Filebin.net REST API.

Must be used as an async context manager or closed explicitly

async with AsyncFilebinClient() as client: await client.list_bin("my-bin")

upload_file(bin_id, path) async

Upload a local file to a bin.

download_file(bin_id, filename, dest_dir) async

Download a file from a bin to a local directory.

delete_file(bin_id, filename) async

Delete a single file from a bin.

list_bin(bin_id) async

Retrieve metadata and files for a bin.

lock_bin(bin_id) async

Lock a bin (mark as read-only).

delete_bin(bin_id) async

Delete an entire bin and all its files.

download_archive(bin_id, fmt, dest_dir) async

Download all files in a bin as a single archive.