JSON-RPC Overview
This API is still a WIP, with more methods being added continuously.
Need a specific method? Let us know on
Github or Filecoin Slack
(#fil-forest-help) 🙏
Overview
The RPC interface is the primary mechanism for interacting with Forest.
Until June 2025, the Lotus V0 and V1 APIs served as the reference for Forest's implementation.
Since June 2025, the Common Node API has been the standard for RPC methods across Filecoin clients, replacing the Lotus-specific API as the primary reference for V1 methods.
An FIP to establish a canonical RPC API specification for general use has been proposed.
Connecting To A Node
By default, Forest exposes the RPC API on localhost:2345. See CLI docs for configuration options.
Authentication
Access control is implemented for certain methods. Levels of access include:
- Read
- Write
- Admin
Authentication is performed via JWT Tokens. When starting Forest use --save-token <FILE> to store an Admin token,
otherwise the token will be printed in the logs during startup. With this token you can call the methods AuthNew
to generate additional tokens as needed.