From b9fea478e1f67604634ef1d7cece1b8e271c3f68 Mon Sep 17 00:00:00 2001 From: Joshua Attridge Date: Tue, 7 May 2024 20:52:21 +0100 Subject: [PATCH] added sessions to README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 26a6bb3..0d5d38d 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,25 @@ returns:
PreviousHigh = the previous high
PreviousLow = the previous low
+### Sessions + +```python +smc.sessions(ohlc, session, start_time, end_time, time_zone = "UTC") +``` + +This method returns which candles are within the session specified + +parameters:
+session: str - the session you want to check (Sydney, Tokyo, London, New York, Asian kill zone, London open kill zone, New York kill zone, london close kill zone, Custom)
+start_time: str - the start time of the session in the format "HH:MM" only required for custom session.
+end_time: str - the end time of the session in the format "HH:MM" only required for custom session.
+time_zone: str - the time zone of the candles can be in the format "UTC+0" or "GMT+0"
+ +returns:
+Active = 1 if the candle is within the session, 0 if not
+High = the highest point of the session
+Low = the lowest point of the session
+ ## Contributing This project is still in BETA so please feel free to contribute to the project. By creating your own indicators or improving the existing ones. If you are stuggling to find something to do then please check out the issues tab for requested changes.