BTFS

Guides
API Reference
Terms of Use

{{user.name}}Log In

The BTFS Developer Hub

Welcome to the BTFS developer hub. You'll find comprehensive guides and documentation to help you start working with BTFS as quickly as possible, as well as support if you get stuck. Let's jump right in!

v1.0HomeGuidesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Introduction

What is BTFS
BTFS for Developers
- BTFS Sample DApp Guide
Install & Run BTFS
FAQ

BTFS Testnet

Introduction & Setup

Hosting

Run a BTFS Host
Change my hosting folder
Static Ports Setup

BTFS Storage Rental

Storage Rental

BTT Balance Management

Requirements
Retrieve Your BTT Balance
Deposit BTT to BTFS
Withdraw BTT from BTFS

Operations

Common Usage
Multiple File Pinning
File Removal
Encryption & Decryption

Features

AutoUpdate
TRON Protocol Integration

CLI Commands

CLI

DApp Development

Developer SDK

HTTP APIs

HTTP APIs

BTFS Gateway

BTFS Gateway User Guide

Introduction

What is BTFS
BTFS for Developers
- BTFS Sample DApp Guide
Install & Run BTFS
FAQ

BTFS Testnet

Introduction & Setup

Hosting

Run a BTFS Host
Change my hosting folder
Static Ports Setup

BTFS Storage Rental

Storage Rental

BTT Balance Management

Requirements
Retrieve Your BTT Balance
Deposit BTT to BTFS
Withdraw BTT from BTFS

Operations

Common Usage
Multiple File Pinning
File Removal
Encryption & Decryption

Features

AutoUpdate
TRON Protocol Integration

CLI Commands

CLI

DApp Development

Developer SDK

HTTP APIs

HTTP APIs

BTFS Gateway

BTFS Gateway User Guide

Renting

Apply Renter Config
Sync Storage Hosts
Storage Hosts Information
Add File Using Reed-Solomon
Renter Storage Upload
Renter Storage Upload (Offline)
Get & Remove Files
Check Upload Status

Hosting

Apply Host Config
Host Storage Announce

File Management

post
Add File
post
Get File
post
List Directory Contents
post
Mount

Node Information

post
Node ID

BitSwap

get
BitSwap Ledger
post
BitSwap Reprovide
get
BitSwap Stats
get
BitSwap Wantlist

Block Information

get
Get Block
post
Put Block
post
Remove Block
get
Block Stats

Bootstrap

post
Show Bootstrap
post
Bootstrap Add
post
Bootstrap Add Default
post
Bootstrap List
post
Bootstrap Remove

Config

post
Config
post
Config Edit
post
Config Apply Profile
post
Config Replace
get
Config Show

Content Identifier (CID)

post
Base32
get
Bases
get
Codecs
post
Format
get
Hashes

DAG

get
Get
post
Put
post
Resolve

DHT

get
Find Peer
get
Find Provs
get
Get
post
Provide
post
Put
get
Query

Diag

post
List Commands
post
Set Time
post
System Diagnostic Information

Files

post
List Directory Contents
post
Flush
post
Change CID
post
Copy Files
post
List Directories in the Local Mutable Namespace
post
Make Directories
post
Move Files
post
Read
post
Remove Files
post
File Status
post
File Write

Filestore

post
List Duplicate Blocks
post
List Objects
post
Verify

Key

post
Key Generation
post
Key List
post
Key Rename
post
Key Remove

Log

post
Logging Level
post
List Logging Subsystems
post
Tail

Name

post
Publish
post
Name Resolve

Object

post
Object Raw Data
post
Object Difference
post
Get Object
post
Output Object Links
post
Object New
post
Add Link
post
Append Data
post
Remove Link
post
Set Data
post
Put
post
Stat

Pin

post
Add
post
List
post
Remove
post
Update
post
Verify

Repo

post
Remove Lockfiles
post
Garbage Collection
post
Stats
post
Verify
post
Version

Stats

post
Bitswap
post
Bandwidth
post
Repo

Swarm

post
Addresses
post
Listen
post
Local Addresses
post
Connect
post
Disconnect
post
Filters
post
Add Address Filter
post
Remove Address Filter
post
Swarm Peers

Retrieve Your BTT Balance

Run command to find your current wallet balances:

btfs wallet balance

Updated 6 months ago

Retrieve Your BTT Balance

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.