README
¶
Bot Financial Framework
The Bot Financial Framework is a Golang-based framework designed to enable the creation of trading bots that utilize strategies leveraging the financialmodelingprep.com API.
Features
- Easy Bot Creation: With the Bot Financial Framework, you can quickly create trading bots tailored to your specific strategies.
- Integration with financialmodelingprep.com API: Access a wide range of financial data and insights to inform your trading strategies.
- Flexible Strategy Implementation: Implement your trading strategies easily within the framework, utilizing the data provided by financialmodelingprep.com API.
- Modular and Extensible: The framework is designed to be modular and extensible, allowing you to add new features and adapt existing ones as needed.
Installation
To use the GoBot Financial Framework, follow these steps:
- Clone the repository:
git clone https://github.com/ComputerNerdES/bot.financial.framework.git - Install dependencies:
make install-deps
Getting Started
Follow these steps to create your first trading bot using the GoBot Financial Framework:
- Define your trading strategy based on the data provided by financialmodelingprep.com API.
- Implement your strategy within the framework, utilizing the provided modules and components.
- Configure your bot with necessary parameters, such as API keys and trading parameters.
- Run your bot and monitor its performance.
Contributing
We welcome contributions from the community! If you have any suggestions, bug fixes, or new features to propose, please submit a pull request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package http implements the logic to create API request It use in api module to get data from API
|
Package http implements the logic to create API request It use in api module to get data from API |
|
Package models provides data structures and types representing entities within the application or system.
|
Package models provides data structures and types representing entities within the application or system. |
|
repository
|
|
|
company
Package company provides functionality for interacting with company data.
|
Package company provides functionality for interacting with company data. |
|
indicators
Package indicators provides functionality for interacting with API indicators.
|
Package indicators provides functionality for interacting with API indicators. |
|
Package step implements different steps that could be used in a strategy
|
Package step implements different steps that could be used in a strategy |
|
Package strategy package is a versatile toolkit designed for organizing and managing trading strategies within a trading bot framework.
|
Package strategy package is a versatile toolkit designed for organizing and managing trading strategies within a trading bot framework. |
Click to show internal directories.
Click to hide internal directories.