optionchain_simulator 0.0.0

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.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# optionchain_simulator

## OptionChain-Simulator

<div style="text-align: center;">
<img src="https://raw.githubusercontent.com/joaquinbejar/OptionChain-Simulator/main/doc/images/logo.png" alt="OptionChain-Simulator" style="width: 100%; height: 200px;">
</div>

[![License](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
[![Build](https://img.shields.io/github/actions/workflow/status/joaquinbejar/OptionChain-Simulator/ci.yml)](https://github.com/joaquinbejar/OptionChain-Simulator/actions)
[![Crates.io](https://img.shields.io/crates/v/optionchain-simulator.svg)](https://crates.io/crates/optionchain-simulator)
[![Downloads](https://img.shields.io/crates/d/optionchain-simulator.svg)](https://crates.io/crates/optionchain-simulator)
[![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionChain-Simulator.svg)](https://github.com/joaquinbejar/OptionChain-Simulator/stargazers)
[![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionChain-Simulator.svg)](https://github.com/joaquinbejar/OptionChain-Simulator/issues)

### OptionChain-Simulator: RESTful Option Chain Time Simulator

#### Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Project Structure](#project-structure)
4. [Setup Instructions](#setup-instructions)
5. [API Usage](#api-usage)
6. [Development](#development)
7. [Contribution and Contact](#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

1. Clone the repository:
```bash
git clone https://github.com/joaquinbejar/OptionChain-Simulator.git
cd OptionChain-Simulator
```

2. Build the project:
```bash
cargo build --release
```

3. Run the API server:
```bash
cargo run
```

4. Access the API:
```http
GET http://localhost:8080/chain
```

### API Usage

#### `GET /chain`

Returns the current option chain and advances the simulation.

##### Response Example:
```json
{
  "underlying_price": 102.5,
  "options": [
    {
      "strike": 100,
      "type": "Call",
      "expiration_days": 30,
      "implied_volatility": 0.2,
      "price": 4.32
    }
  ]
}
```

### Development

Run the server with:
```bash
cargo run
```

Run tests:
```bash
cargo test
```

Run formatting and linting:
```bash
cargo fmt
cargo clippy
```

### 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](https://github.com/joaquinbejar)

---

License: MIT