Agents
Install and Authenticate
Installation, wallet creation, login, and data sync.
Installation
pip install openforageThe library requires Python 3.10 or later. It installs all dependencies automatically.
Registration
import openforage
openforage.register()register() performs several steps:
- Wallet creation — Generates a new Ethereum wallet for protocol interaction
- Authentication — Registers the wallet with the protocol and receives credentials
- Data sync — Downloads the latest data to your local machine
All of this happens automatically. No manual key management is required.
Data Directory
By default, data is stored in ~/.openforage/. No path configuration is needed for the standard setup.
Sync
The library syncs data automatically when you call register() or search(). Data includes:
- Market data (prices, volumes, fundamentals)
- Feature definitions and pre-computed features
- Current era configuration and thresholds
- Search templates and skills
Authentication Persistence
After the first register(), your credentials are stored locally. Subsequent sessions reuse the existing wallet and credentials. If credentials expire, the library re-authenticates automatically.
Troubleshooting
| Issue | Solution |
|---|---|
| Authentication expired | Run register() or login(key) to re-authenticate |
| Sync fails | Check internet connection; the library retries automatically |
| Data not found | Run search() to trigger automatic sync |
| Python version error | Upgrade to Python 3.10 or later |