optionchain_simulator
OptionChain-Simulator
OptionChain-Simulator: RESTful Option Chain Time Simulator
Table of Contents
- Introduction
- Features
- Project Structure
- Setup Instructions
- API Usage
- Development
- Contribution and Contact
Introduction
OptionChain-Simulator is a lightweight REST API service that simulates an evolving option chain with every request. It is designed for developers building or testing trading systems, backtesters, and visual tools that depend on option data streams but want to avoid relying on live data feeds.
Features
- 📡 REST API to fetch a simulated option chain.
- ⏱ Each API request advances the simulation one time step.
- 🧮 Option pricing using Black-Scholes or configurable models.
- 🔄 Internal state memory with market evolution.
- ⚙️ Easily configurable initial parameters (IV, strikes, steps).
- 📦 JSON output for easy integration with other tools.
- 📁 Static data support (CSV/JSON-based initial chains).
Setup Instructions
- Clone the repository:
- Build the project:
- Run the API server:
- Access the API:
GET http://localhost:8080/chain
API Usage
GET /chain
Returns the current option chain and advances the simulation.
Response Example:
Development
Run the server with:
Run tests:
Run formatting and linting:
Contribution and Contact
Contributions are welcome! Please submit pull requests, issues, or suggestions.
Maintainer: Joaquín Béjar García 📧 jb@taunais.com 🔗 GitHub Profile
License: MIT