Metadata-Version: 2.1
Name: lakeapi
Version: 0.1.3
Summary: API for accessing Lake crypto market data
Home-page: https://github.com/leftys/lakeapi
Author: Jan Skoda
Author-email: skoda@jskoda.cz
License: Apache 2 license
Keywords: lakeapi
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
License-File: LICENSE
License-File: NOTICE.rst
License-File: AUTHORS.rst
Requires-Dist: Click (>=7.0)
Requires-Dist: awswrangler (==2.16.1)
Requires-Dist: boto3 (<2,>=1.24)
Requires-Dist: botocache (<0.1.0,>=0.0.4)
Requires-Dist: cachetools-ext (<0.1.0,>=0.0.8)
Requires-Dist: joblib (>=1.0.0)
Requires-Dist: pandas (<2,>=1.0.5)
Requires-Dist: tqdm (<5,>=4)
Requires-Dist: typing-extensions (<5,>=4.0) ; python_version < "3.8"

========
Lake API
========


.. image:: https://img.shields.io/pypi/v/lakeapi.svg
        :target: https://pypi.python.org/pypi/lakeapi
        :alt: Pypi package status

.. image:: https://readthedocs.org/projects/lake-api/badge/?version=latest
        :target: https://lake-api.readthedocs.io/en/latest/?version=latest
        :alt: Documentation status

.. image:: https://github.com/crypto-lake/lake-api/actions/workflows/dev.yml/badge.svg
     :target: https://github.com/crypto-lake/lake-api/actions/workflows/dev.yml
     :alt: Build status


API for accessing Lake crypto market data.


* Web: https://crypto-lake.com/
* Documentation: https://lakeapi.readthedocs.io.
* Online example -- executable collab notebook: https://colab.research.google.com/drive/1E7MSUT8xqYTMVLiq_rMBLNcZmI_KusK3


Usage
-----

If you don't have a paid plan with AWS credentials, you can access sample data:

.. code-block:: python

    import lakeapi

    lakeapi.use_sample_data(anonymous_access = True)

    df = lakeapi.load_data(
        table="book",
        start=None,
        end=None,
        symbols=["BTC-USDT"],
        exchanges=None,
    )


With paid access, you can query any data:

.. code-block:: python

    import lakeapi

    # Downloads SOL-USDT depth snapshots for last 2 days from Kucoin exchange
    df = lakeapi.load_data(
        table="trades",
        start=datetime.datetime.now() - datetime.timedelta(days=2),
        end=None,
        symbols=["SOL-USDT"],
        exchanges=["KUCOIN"],
    )

We recommend putting .lake_cache directory into .gitignore, because Lake API stores cache into this directory in the
working directory.


=======
History
=======

0.1.0 (2022-10-08)
------------------

* First release on PyPI.


