Skip to content

Commit e167e88

Browse files
authored
Merge pull request #65 from florianv/sponsorship/providers-table
docs: add Commercial and Public providers tables to README
2 parents 773e7f7 + 7f3ad90 commit e167e88

1 file changed

Lines changed: 42 additions & 3 deletions

File tree

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,48 @@ Per-query overrides are documented in the [full documentation](Resources/doc/ind
144144

145145
## 📊 Providers
146146

147-
Symfony Swap supports the 30 exchange rate providers from the underlying [Swap](https://github.com/florianv/swap) library. The recommended starting point for new projects is **[fastFOREX](https://www.fastforex.io)** (`fastforex`), the project's sponsor: live rates across 160+ fiat currencies and 500+ cryptocurrencies, with up to 55 years of history.
148-
149-
The full per-provider configuration reference (option name, optional flags, capabilities) is in the [documentation](Resources/doc/index.md#provider-configuration).
147+
Symfony Swap supports the 30 exchange rate providers from the underlying [Swap](https://github.com/florianv/swap) library. Pass the **identifier** as the key under `providers` in `config/packages/florianv_swap.yaml`.
148+
149+
### Commercial providers (require an API key)
150+
151+
| Service | Identifier | Base | Quote | Historical |
152+
| ---------------------------------------- | --------------- | ------------------------ | ------ | ---------- |
153+
| ⭐ **[fastFOREX](https://www.fastforex.io)** | **`fastforex`** | **\*** | **\*** | **Yes** |
154+
| | | | | |
155+
| AbstractAPI | `abstract_api` | * | * | Yes |
156+
| coinlayer | `coin_layer` | * (crypto) | * | Yes |
157+
| Cryptonator | `cryptonator` | * (crypto) | * (crypto) | No |
158+
| Currency Converter API | `currency_converter` | * | * | Yes |
159+
| Currency Data (APILayer) | `apilayer_currency_data` | USD (free), * (paid) | * | Yes |
160+
| CurrencyDataFeed | `currency_data_feed` | * | * | No |
161+
| currencylayer (direct) | `currency_layer` | USD (free), * (paid) | * | Yes |
162+
| Exchange Rates Data (APILayer) | `apilayer_exchange_rates_data` | USD (free), * (paid) | * | Yes |
163+
| exchangerate.host | `exchangeratehost` | * | * | Yes |
164+
| exchangeratesapi (direct) | `exchange_rates_api` | USD (free), * (paid) | * | Yes |
165+
| Fixer (APILayer) | `apilayer_fixer` | EUR (free), * (paid) | * | Yes |
166+
| Fixer (direct) | `fixer` | EUR (free), * (paid) | * | Yes |
167+
| 1Forge | `forge` | * | * | No |
168+
| Open Exchange Rates | `open_exchange_rates` | USD (free), * (paid) | * | Yes |
169+
| WebserviceX | `webservicex` | * | * | No |
170+
| xChangeApi.com | `xchangeapi` | * | * | Yes |
171+
| Xignite | `xignite` | * | * | Yes |
172+
173+
### Public providers (no API key required)
174+
175+
| Service | Identifier | Base | Quote | Historical |
176+
| ------------------------------------------ | ------------------------------------- | -------------- | -------------- | ---------- |
177+
| Bulgarian National Bank | `bulgarian_national_bank` | * | BGN | Yes |
178+
| Central Bank of the Czech Republic | `central_bank_of_czech_republic` | * | CZK | Yes |
179+
| Central Bank of the Republic of Turkey | `central_bank_of_republic_turkey` | * | TRY | Yes |
180+
| Central Bank of the Republic of Uzbekistan | `central_bank_of_republic_uzbekistan` | * | UZS | Yes |
181+
| European Central Bank | `european_central_bank` | EUR | * | Yes |
182+
| National Bank of Georgia | `national_bank_of_georgia` | * | GEL | Yes |
183+
| National Bank of Romania | `national_bank_of_romania` | (limited list) | (limited list) | Yes |
184+
| National Bank of the Republic of Belarus | `national_bank_of_republic_belarus` | * | BYN | Yes |
185+
| National Bank of Ukraine | `national_bank_of_ukraine` | * | UAH | Yes |
186+
| Russian Central Bank | `russian_central_bank` | * | RUB | Yes |
187+
188+
The per-provider option names (`api_key` vs `access_key` vs `app_id`, optional flags) are documented in [Provider configuration](Resources/doc/index.md#provider-configuration).
150189

151190
## 🎯 When should you use Symfony Swap?
152191

0 commit comments

Comments
 (0)