|
1 | | -# Chainlink External Adapter for lo-tech |
| 1 | +# LO_TECH |
2 | 2 |
|
3 | | -This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme lo-tech`. |
| 3 | +  |
| 4 | + |
| 5 | +This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. |
| 6 | + |
| 7 | +## Environment Variables |
| 8 | + |
| 9 | +| Required? | Name | Description | Type | Options | Default | |
| 10 | +| :-------: | :------------------------: | :------------------------------------------------------------------------------: | :----: | :-----: | :-----: | |
| 11 | +| ✅ | ${REGION}\_API_KEY | Lo-Tech API key for the given ${REGION}. Region can be "US" or "ASIA" | string | | | |
| 12 | +| ✅ | ${REGION}\_WS_API_ENDPOINT | Lo-Tech websocket endpoint for the given ${REGION}. Region can be "US" or "ASIA" | string | | | |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## Data Provider Rate Limits |
| 17 | + |
| 18 | +There are no rate limits for this adapter. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## Input Parameters |
| 23 | + |
| 24 | +| Required? | Name | Description | Type | Options | Default | |
| 25 | +| :-------: | :------: | :-----------------: | :----: | :------------------------------------: | :------------: | |
| 26 | +| | endpoint | The endpoint to use | string | [stock_quotes](#stock_quotes-endpoint) | `stock_quotes` | |
| 27 | + |
| 28 | +## Stock_quotes Endpoint |
| 29 | + |
| 30 | +`stock_quotes` is the only supported name for this endpoint. |
| 31 | + |
| 32 | +### Input Params |
| 33 | + |
| 34 | +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | |
| 35 | +| :-------: | :--: | :-----------------------------------------: | :-----------------------: | :----: | :-----: | :-----: | :--------: | :------------: | |
| 36 | +| ✅ | base | `asset`, `coin`, `from`, `symbol`, `ticker` | The stock ticker to query | string | | | | | |
| 37 | + |
| 38 | +### Example |
| 39 | + |
| 40 | +Request: |
| 41 | + |
| 42 | +```json |
| 43 | +{ |
| 44 | + "data": { |
| 45 | + "endpoint": "stock_quotes", |
| 46 | + "base": "9988-HKD:SPOT" |
| 47 | + } |
| 48 | +} |
| 49 | +``` |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +MIT License |
0 commit comments