Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 2.58 KB

Library-Interface-Documentation.rst

File metadata and controls

120 lines (89 loc) · 2.58 KB
Raw

Library Interface Documentation

Here is the Entire Library Interface reference.

Base Client

.. autoclass:: polygon.base_client.BaseClient
   :members:
   :special-members: __init__
   :private-members:
   :undoc-members:
   :member-order: bysource

Stocks Client

.. autoclass:: polygon.stocks.stocks.StocksClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource

Options Client

.. autofunction:: polygon.options.options.build_option_symbol


.. autofunction:: polygon.options.options.parse_option_symbol


.. autofunction:: polygon.options.options.build_option_symbol_for_tda


.. autofunction:: polygon.options.options.parse_option_symbol_from_tda


.. autoclass:: polygon.options.options.OptionSymbol
   :members:
   :special-members: __init__
   :undoc-members:
   :private-members:
   :member-order: bysource


.. autoclass:: polygon.options.options.OptionsClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource


.. autofunction:: polygon.options.options.ensure_prefix

References Client

.. autoclass:: polygon.reference_apis.reference_api.ReferenceClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource

Forex Client

.. autoclass:: polygon.forex.forex_api.ForexClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource

Crypto Client

.. autoclass:: polygon.crypto.crypto_api.CryptoClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource

Callback Streamer Client (Sync)

.. autoclass:: polygon.streaming.streaming.StreamClient
   :members:
   :special-members: __init__
   :private-members:
   :undoc-members:
   :member-order: bysource

Async Streamer Client

.. autoclass:: polygon.streaming.async_streaming.AsyncStreamClient
   :members:
   :special-members: __init__
   :private-members:
   :member-order: bysource

Enums Interface

.. automodule:: polygon.enums
   :members:
   :undoc-members:
   :member-order: bysource