1  # Alchemy Source
  2  
  3  ## Usage
  4  
  5  This connector fetches historical prices from [Alchemy](https://www.alchemy.com/).
  6  
  7  ### Configuration
  8  
  9  The connector takes the following input:
 10  
 11  - `api_key` - the [Alchemy](https://www.alchemy.com/) API key.
 12  - `tokens` - there are two different `payload` implementations:
 13    - [Symbol](https://www.alchemy.com/docs/data/prices-api/prices-api-endpoints/prices-api-endpoints/get-historical-token-prices#request.body.PricesApiEndpointsGetHistoricalTokenPricesRequest0) - requires `symbol` and `interval`.
 14    - [Address](https://www.alchemy.com/docs/data/prices-api/prices-api-endpoints/prices-api-endpoints/get-historical-token-prices#request.body.PricesApiEndpointsGetHistoricalTokenPricesRequest1) - requires `network`, `address`, `symbol` and `interval`.
 15  
 16  #### Token Setup
 17  
 18  Symbol example:
 19  
 20  ```json
 21  {
 22      "symbol": "BTC",
 23      "interval": "5m"
 24  }
 25  ```
 26  
 27  Address example:
 28  
 29  ```json
 30  {
 31      "network": "opt-mainnet",
 32      "address": "0x4200000000000000000000000000000000000042",
 33      "symbol": "OP",
 34      "interval": "1d"
 35  }
 36  ```
 37  
 38  **Notes**:
 39  
 40  - `interval` - can be `5m`, `1h`, `1d`. [Range calculations](https://www.alchemy.com/docs/data/prices-api/prices-api-endpoints/prices-api-endpoints/get-historical-token-prices#request.body.PricesApiEndpointsGetHistoricalTokenPricesRequest0.interval) are automatically done in the stream slices.
 41  - `start_date` and `end_date` can be used for backfills. Once a backfill is completed, they can be left blank. The prices for the given `interval` will be fetched for the previous day automatically.
 42  
 43  ### Output
 44  
 45  The connector will return the following:
 46  
 47  * [HistoricalRates](./source_alchemy_fetcher/schemas/historical_rates.json)
 48  
 49  ## Local development
 50  
 51  ### Prerequisites
 52  
 53  #### Activate Virtual Environment and install dependencies
 54  
 55  From this connector directory, create a virtual environment:
 56  
 57  ```
 58  python -m venv .venv
 59  ```
 60  
 61  ```
 62  source .venv/bin/activate
 63  pip install -r requirements.txt
 64  ```
 65  
 66  ### Locally running the connector
 67  
 68  ```
 69  python main.py spec
 70  python main.py check --config sample_files/config-example.json
 71  python main.py discover --config sample_files/config-example.json
 72  python main.py read --config sample_files/config-example.json --catalog sample_files/configured_catalog.json
 73  ```
 74  
 75  ### Locally running the connector docker image
 76  
 77  ```bash
 78  docker build -t airbyte/source-alchemy-fetcher:dev .
 79  # Running the spec command against your patched connector
 80  docker run airbyte/source-alchemy-fetcher:dev spec
 81  ```
 82  
 83  #### Run
 84  
 85  Then run any of the connector commands as follows:
 86  
 87  #### Linux / MAC OS
 88  
 89  ```
 90  docker run --rm airbyte/source-alchemy-fetcher:dev spec
 91  docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/source-alchemy-fetcher:dev check --config /sample_files/config-example.json
 92  docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/source-alchemy-fetcher:dev discover --config /sample_files/config-example.json
 93  docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/source-alchemy-fetcher:dev read --config /sample_files/config-example.json --catalog /sample_files/configured_catalog.json  
 94  ```
 95  
 96  #### Windows
 97  
 98  ```
 99  docker run --rm airbyte/source-alchemy-fetcher:dev spec
100  docker run --rm -v "$PWD\sample_files:/sample_files" airbyte/source-alchemy-fetcher:dev check --config /sample_files/config-example.json
101  docker run --rm -v "$PWD\sample_files:/sample_files" airbyte/source-alchemy-fetcher:dev discover --config /sample_files/config-example.json
102  docker run --rm -v "$PWD\sample_files:/sample_files" airbyte/source-alchemy-fetcher:dev read --config /sample_files/config-example.json --catalog /sample_files/configured_catalog.json
103  ```