Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix-format-readme-link #393

Merged
merged 1 commit into from
Mar 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion 1forge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| ✅ | `base`, `from` | The symbol of the currency to query | [List](https://1forge.com/currency-list) | |
| ✅ | `quote`, `to` | The symbol of the currency to convert to | [List](https://1forge.com/currency-list) | |
| 🟡 | `quantity` | An additional amount of the original currency | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |


### Output
Expand Down
2 changes: 1 addition & 1 deletion alphavantage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Returns the exchange rate from a currency's current price to a given currency
| :-------: | :------------------------: | :--------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------: |
| ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | [Physical Currency list](https://www.alphavantage.co/physical_currency_list/) or [Cryptocurrency list](https://www.alphavantage.co/digital_currency_list/) | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | [Physical Currency list](https://www.alphavantage.co/physical_currency_list/) or [Cryptocurrency list](https://www.alphavantage.co/digital_currency_list/) | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion amberdata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Gets the [latest spot VWAP price](https://docs.amberdata.io/reference#spot-price

- `base`, `from`, or `coin`: The asset to query
- `quote`, `to`, or `market`: The currency to convert to
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../presetSymbols.json)
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../external-adapter/src/overrides/presetSymbols.json)

### Output

Expand Down
2 changes: 1 addition & 1 deletion coinapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| :-------: | :------------------------: | :--------------------------------------: | :----------------------------------------------: | :---------: |
| ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | [List](https://docs.coinapi.io/#list-all-assets) | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | [List](https://docs.coinapi.io/#list-all-assets) | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion coingecko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Query the price from [Coingecko](https://api.coingecko.com/api/v3/simple/price)
| 🟡 (if not using `base`) | `coinid` | The CoinGecko id of the coin to query | [See list here](https://www.coingecko.com/api/documentations/v3#/coins/get_coins_list) | |
| 🟡 (if not using `coinid`) | `base`, `from`, or `coin` | The symbol of the currency to query | ↑ | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | ↑ | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion coinmarketcap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ https://pro-api.coinmarketcap.com/v1/cryptocurrency/quotes/latest
| ✅ | `quote`, `to`, `market`, `convert` | The symbol of the currency to convert to | | |
| 🟡 | `cid` | The CMC coin ID (optional to use in place of `base`) | | |
| 🟡 | `slug` | The CMC coin name (optional to use in place of `base`) | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion coinpaprika/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ https://api.coinpaprika.com/v1/tickers/`{COIN}`
| ✅ | `base`, `from`, `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, `market` | The symbol of the currency to convert to | | |
| 🟡 | `coinid` | The coin ID (optional to use in place of `base`) | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion cryptocompare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| :-------: | :---------------------: | :--------------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, `market` | The symbol of the currency to convert to | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion currencylayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| ✅ | `base`, `from`, `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, `market` | The symbol of the currency to convert to | | |
| 🟡 | `amount` | An amount of the currency | | 1 |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion dxfeed-secondary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ TSLA ➡️ 'TSLA.US:TEI'
| Required? | Name | Description | Options | Defaults to |
| :-------: | :------------------------------: | :---------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, `coin`, `market` | The symbol of the currency to query | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

`overrides` should contain the following symbol conversions:

Expand Down
2 changes: 1 addition & 1 deletion dxfeed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| Required? | Name | Description | Options | Defaults to |
| :-------: | :------------------------------: | :---------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, `coin`, `market` | The symbol of the currency to query | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

`overrides` should contain the following symbol conversions:

Expand Down
2 changes: 1 addition & 1 deletion finage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Input Params

- `base`, `from`, or `symbol`: The symbol of the asset to query
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../presetSymbols.json)
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../external-adapter/src/overrides/presetSymbols.json)

## Output

Expand Down
2 changes: 1 addition & 1 deletion fixer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This adapter is for [Fixer.io](https://fixer.io/) and supports the convert endpo
| ✅ | `base`, `from`, `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, `market` | The symbol of the currency to convert to | | |
| 🟡 | `amount` | The amount of `base` currency | | 1 |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

## Output

Expand Down
2 changes: 1 addition & 1 deletion iex-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- `base`, `from`, `coin`, `asset` or `symbol`: The symbol to query
- `quote`, `to`, or `market`: The symbol to convert to (required when endpoint is "crypto")
- `endpoint`: The endpoint to query, one of "stock" or "crypto". Default: stock.
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../presetSymbols.json)
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../external-adapter/src/overrides/presetSymbols.json)

## Output

Expand Down
2 changes: 1 addition & 1 deletion kaiko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| :-------: | :------------------------: | :--------------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion metalsapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | | |
| 🟡 | `amount` | The amount fo the `base` currency | | 1 |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

## Output

Expand Down
2 changes: 1 addition & 1 deletion nomics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| :-------: | :-------------------------------: | :--------------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, `coin`, `ids` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`,`market`, `convert` | The symbol of the currency to convert to | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

## Output

Expand Down
2 changes: 1 addition & 1 deletion openexchangerates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| :-------: | :------------------------: | :--------------------------------------: | :-----: | :---------: |
| ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | | |
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | | |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |
### Output

```json
Expand Down
2 changes: 1 addition & 1 deletion polygon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Get FOREX price conversions
| ✅ | `quote`, `to`, or `market` | The symbol of the currency to convert to | `BTC`, `ETH`, `USD` | |
| 🟡 | `amount` | The amount of the `base` to convert | | 1 |
| 🟡 | `precision` | The number of significant figures to include | | 4 |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../presetSymbols.json)| |
| 🟡 | `overrides` | If base provided is found in overrides, that will be used | [Format](../external-adapter/src/overrides/presetSymbols.json)| |

### Output

Expand Down
2 changes: 1 addition & 1 deletion tradermade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- `base`, `from`, or `coin`: The symbol of the currency to query
- `to`: The symbol of the currency to convert to (for FX)
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../presetSymbols.json)
- `overrides`: (not required) If base provided is found in overrides, that will be used. [Format](../external-adapter/src/overrides/presetSymbols.json)

## Output

Expand Down