Skip to content

Commit

Permalink
added sessions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshyattridge committed May 7, 2024
1 parent 44efe71 commit b9fea47
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,25 @@ returns:<br>
PreviousHigh = the previous high<br>
PreviousLow = the previous low<br>

### Sessions

```python
smc.sessions(ohlc, session, start_time, end_time, time_zone = "UTC")
```

This method returns which candles are within the session specified

parameters:<br>
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)<br>
start_time: str - the start time of the session in the format "HH:MM" only required for custom session.<br>
end_time: str - the end time of the session in the format "HH:MM" only required for custom session.<br>
time_zone: str - the time zone of the candles can be in the format "UTC+0" or "GMT+0"<br>

returns:<br>
Active = 1 if the candle is within the session, 0 if not<br>
High = the highest point of the session<br>
Low = the lowest point of the session<br>

## 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.
Expand Down

0 comments on commit b9fea47

Please sign in to comment.