Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.34 KB

Crypto.rst

File metadata and controls

109 lines (68 loc) · 3.34 KB
Raw

Crypto

Read this page to know everything you need to know about using the various Crypto HTTP endpoints.

See :ref:`async_support_header` for asynchronous use cases.

Docs below assume you have already read getting started page and know how to create the client. If you do not know how to create the client, first see :ref:`create_and_use_header` and create client as below. As always you can have all 5 different clients together.

import polygon

crypto_client = polygon.CryptoClient('KEY')  # for usual sync client
async_crypto_client = polygon.CryptoClient('KEY', True)  # for an async client

Note that most endpoints require you to specify the currency pairs as separate symbols (a from_symbol and a to_symbol).

however a few endpoints require you to supply them as one combined symbol. An example would be the get_aggregates_bars method. In those methods, the symbol is expected to have a prefix X: before the currency symbol names. but the library allows you to specify the symbol with or without the prefix. See the relevant method's docs for more information on what the parameters expect.

here is how the client initializer looks like:

.. autofunction:: polygon.crypto.crypto_api.CryptoClient

Endpoints

To use any of the below method, simply call it on the client you created above. so if you named your client client, you'd call the methods as client.get_historic_trades and so on. Async methods will need to be awaited, see :ref:`async_support_header`.

Get Historic Trades

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_historic_trades
   :noindex:

Get Trades

This endpoint supports pagination. Passing all_pages=True enables it. See :ref:`pagination_header` for better info

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_trades
   :noindex:

Get Last Trade

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_last_trade
   :noindex:

Get Daily Open Close

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_daily_open_close
   :noindex:

Get Aggregate Bars (Candles)

The library added a better aggregate function if you're looking to get data for large time frames at minute/hour granularity.

(for example 15 years historical data , 1 minute candles)

See :ref:`better_aggs_header` for complete details on how to use it well and control how it behaves.

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_aggregate_bars
   :noindex:

Get Grouped Daily Bars (Candles)

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_grouped_daily_bars
   :noindex:

Get Previous Close

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_previous_close
   :noindex:

Get Snapshot All

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_snapshot_all
   :noindex:

Get Snapshot

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_snapshot
   :noindex:

Get Gainers and Losers

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_gainers_and_losers
   :noindex:

Get Level 2 Book

.. automethod:: polygon.crypto.crypto_api.SyncCryptoClient.get_level2_book
   :noindex: