From 609034b5c8255ea58c3859f8fefecbad3d34a694 Mon Sep 17 00:00:00 2001 From: Kerry Jones Date: Sat, 27 Jul 2024 19:16:02 -0700 Subject: [PATCH] Add documentation --- CHANGELOG.md | 4 ++++ README.md | 15 +++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b83cb4a..27bc260 100644 --- 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 index e335bbb..479bc90 100644 --- 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