Skip to content

Latest commit

 

History

History
214 lines (156 loc) · 4.39 KB

Library-Interface-Documentation.rst

File metadata and controls

214 lines (156 loc) · 4.39 KB
Raw

Library Interface Documentation

Here is the Entire Library Interface reference.

Base Clients

Base Client

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

Base Sync Client

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

Base Async Client

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

Stocks Clients

Stocks Sync Client

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

Stocks Async Client

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

Options Clients

Option Symbol Helper Functions & Objects

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


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


.. autofunction:: polygon.options.options.build_polygon_option_symbol


.. autofunction:: polygon.options.options.parse_polygon_option_symbol


.. autofunction:: polygon.options.options.convert_option_symbol_formats


.. autofunction:: polygon.options.options.detect_option_symbol_format


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


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

Options Sync Client

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

Options Async Client

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

References Clients

Reference Sync Client

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

Reference Async Client

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

Forex Clients

Forex Sync Client

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

Forex Async Client

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

Crypto Clients

Crypto Sync Client

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

Crypto Async Client

.. autoclass:: polygon.crypto.crypto_api.AsyncCryptoClient
   :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