Metadata-Version: 2.1
Name: erc721
Version: 0.0.2
Summary: A Python library for interacting with the public google BigQuery datasets to extract ERC721 token data.
Author: Jeremy Savage
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Setup and Installation

Firstly you must have set up a GCP project to interact with the public google BigQuery datasets using Python. To do this follow the instructions located under quick setup [here](https://pypi.org/project/google-cloud-bigquery/).


Next, install this module from PyPi.

```
pip install erc721
```

That's it, once this is setup you should be able to interact with the provided functions.

# Interactions

There are a few simple interactions provided:

```python
get_all_collection_transfers_sql(nft_token_address)
```

This fetches all of the transfers and sales for a single ERC721 token. For example to get all transfers for BAYC, pass the token address "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d" as a string to the function.

This will extract all of the sales and transfer data for that desired collection and return it as a pandas dataframe.

```python
get_all_sales(all_data=None, collection_address=None)
```

This fetches all of the sales data and returns it as a pandas dataframe. This can either be called alone by being passed a collection address (for BAYC: collection_address="0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d") or if you have already extracted data using get_all_collection_transfers, the result of this can be passed.

```python
get_all_transfers(all_data=None, collection_address=None)
```

Working in the same way as the above function, this function returns all of the transfers (without any payment).

```python
get_all_sales_and_transfers(all_data=None, collection_address=None)
```

Working in the same way as the two above functions, this function returns two arguments all sales and all transfers respectively as two separate pandas dataframes.

