Add documentation

MarketDataApp · Jul 28, 2024 · 609034b · 609034b
1 parent c8a45f2
commit 609034b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.6.0-beta
+
+Added universal parameters to all endpoints with the ability to change format to CSV and HTML (beta).
+
 ## v0.5.0-beta
 
 Added indices->quotes to parallelize and speed up multiple index quotes.

diff --git a/README.md b/README.md
@@ -72,6 +72,21 @@ $status = $client->utilities->api_status();
 $headers = $client->utilities->headers();
 ```
 
+### Universal Parameters
+
+All endpoints (other than utilities) supports universal parameters. 
+
+For instance, you can change the format to CSV
+
+```
+$option_chain = $client->options->option_chain(
+    symbol: 'AAPL',
+    expiration: '2025-01-17',
+    side: Side::CALL,
+    parameters: new Parameters(format: Format::CSV),
+);
+```
+
 ## Testing
 
 ```bash