.. SC-Py documentation master file, created by
   sphinx-quickstart on Mon May 13 19:40:47 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SC-Py's Documentation!
=================================

What is SC-Py?
~~~~~~~~~~~~~~

SC-Py is python to Sierra Chart integration solution. 


Prior Knowledge
---------------
Some Python and Sierra Chart experience is required to get the most out of SC-Py. That said, you don’t need to be an expert to get started. SC-Py is intended to be accessible by beginner Python programmers.

Feature Summary
---------------
- Realtime and historical data access
- Market data - time and sales, bid/ask quotes, market depth
- Chart data- chart bar data with the various bar timeframes supported by SC
- Chart subgraph data
- Volume by price (a.k.a., footprint and numbers bars) , tpo charts, volume profiles
- Order management - submit, modify, cancel, regular, attached
- Post data to Sierra Chart subgraphs (from python to SC)
- Access to chart drawings
- Reporting - retrieve list of executed trades, order fills, statistics
- Retrieve current position and account status

Common Usage Scenarios
----------------------
- Research - access data in shell, notebook for research purposes
- Live trading - strategy development, custom dashboard integration, monitoring and alerting
- Integration - integrate SC with other data sources and libraries for ML, dashboard creation, news, etc.
- Automation - performance reporting, end of day trade reconciliation

Documentation Organization
--------------------------
The documentation is organized into the following sections

- User Guides
- API Reference
- Example Projects
- Architecture (TBD)


Technical Requirements
----------------------
- Windows - 10/11 recommended
- Sierra Chart - version 2626 or higher
- Python - 3.10 or higher (we develop and test with 3.10)


Getting Started
---------------
The easiest way to get started is to first get everything “Setup” and then follow the “Hello World”.


.. toctree::
   :maxdepth: 4
   :hidden:
   :titlesonly:
   
   userguides/index
   reference/index