Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/me-io/go-swap
💱 Currency exchange rates server - Golang "ƓØ"
https://github.com/me-io/go-swap
currency currency-converter currency-exchange currency-exchange-rates currency-rates currencylayer exchange exchange-rates fixer golang money
Last synced: 1 day ago
JSON representation
💱 Currency exchange rates server - Golang "ƓØ"
- Host: GitHub
- URL: https://github.com/me-io/go-swap
- Owner: me-io
- License: mit
- Created: 2018-09-06T16:20:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T19:08:07.000Z (about 6 years ago)
- Last Synced: 2024-04-14T09:46:49.349Z (7 months ago)
- Topics: currency, currency-converter, currency-exchange, currency-exchange-rates, currency-rates, currencylayer, exchange, exchange-rates, fixer, golang, money
- Language: Go
- Homepage: https://go-swap-server.herokuapp.com/swagger/
- Size: 272 KB
- Stars: 37
- Watchers: 8
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Currency Exchange Server - Golang
[](https://travis-ci.org/me-io/go-swap)
[](https://goreportcard.com/report/github.com/me-io/go-swap)
[](https://coveralls.io/github/me-io/go-swap?branch=master)
[](https://godoc.org/github.com/me-io/go-swap)
[](https://github.com/me-io/go-swap/releases)
[](https://meabed.com)
[](https://microbadger.com/images/meio/go-swap-server)
[](https://microbadger.com/images/meio/go-swap-server)
[](https://hub.docker.com/r/meio/go-swap-server)
Swap allows you to retrieve currency exchange rates from various services such as **[Google](https://google.com)**, **[Yahoo](https://yahoo.com)**, **[Fixer](https://fixer.io)**, **[CurrencyLayer](https://currencylayer.com)** or **[1Forge](https://1forge.com)**
and optionally cache the results.
## Playground
#### /GET Examples for single exchanger:
- [GET /convert?from=USD&to=AED&amount=2&exchanger=yahoo](https://go-swap-server.herokuapp.com/convert?from=USD&to=AED&amount=100&exchanger=yahoo)
- [GET /convert?from=EUR&to=GBP&amount=1&exchanger=google&cacheTime=300s](https://go-swap-server.herokuapp.com/convert?from=EUR&to=GBP&amount=100&exchanger=google&cacheTime=300s)
- [GET /convert?from=USD&to=SAR&amount=1&exchanger=themoneyconverter](https://go-swap-server.herokuapp.com/convert?from=USD&to=SAR&amount=100&exchanger=themoneyconverter)
#### /POST Examples for single or multi exchanger:
- CURL examples:
```bash
curl -X POST \
https://go-swap-server.herokuapp.com/convert \
-H 'Content-Type: application/json' \
-d '{
"amount": 2.5,
"from": "USD",
"to": "AED",
"decimalPoints": 4,
"cacheTime": "120s",
"exchanger": [
{
"name": "yahoo"
},
{
"name": "google"
},
{
"name": "themoneyconverter",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:21.0) Gecko/20100101 Firefox/21.0"
}
]
}'
# Response example
# {
# "to": "AED",
# "from": "USD",
# "exchangerName": "yahoo",
# "exchangeValue": 3.6721,
# "originalAmount": 2.5,
# "convertedAmount": 9.1802,
# "convertedText": "2.5 USD is worth 9.1802 AED",
# "rateDateTime": "2018-09-30T07:45:45Z",
# "rateFromCache": false
# }
```
- [Run in SwaggerUI](https://go-swap-server.herokuapp.com/swagger)
- [](https://app.getpostman.com/run-collection/5f8445ef9a390fd3faa1)
## QuickStart
```bash
# Or using docker
$ docker pull meio/go-swap-server:latest && \
docker run --rm --name go-swap-server -p 5000:5000 -it meio/go-swap-server:latest
```
### Programmatically
```bash
$ go get github.com/me-io/go-swap
```
```go
package main
import (
"fmt"
ex "github.com/me-io/go-swap/pkg/exchanger"
"github.com/me-io/go-swap/pkg/swap"
)
func main() {
SwapTest := swap.NewSwap()
SwapTest.
AddExchanger(ex.NewGoogleApi(nil)).
Build()
euroToUsdRate := SwapTest.Latest("EUR/USD")
fmt.Println(euroToUsdRate.GetRateValue())
}
```
## Features
- Convert with Single exchange source `/GET`
- Convert with Multi exchange sources with fallback mechanism `/POST`
- Google
- Yahoo
- CurrencyLayer
- Fixer.io
- themoneyconverter.com
- openexchangerates.org
- 1forge.com
- Rate Caching - `120s Default`
- Memory - `Default`
- Redis
- Rate decimal points rounding `4 Default`
- Swagger UI
- Clear API Request and Response
- Docker image, Binary release and Heroku Demo
- Clear documentation and 90%+ code coverage
- Unit tested on live and mock data
### Screens
## Documentation
The documentation for the current branch can be found [here](#documentation).
## Services
|Exchanger |type |# |$|
|:--- |:---- |:--- |:---|
|[Google][1] |HTML / Regex |:heavy_check_mark: |Free|
|[Yahoo][2] |JSON / API |:heavy_check_mark: |Free|
|[Currency Layer][3] |JSON / API |:heavy_check_mark: |Paid - ApiKey|
|[Fixer.io][4] |JSON / API |:heavy_check_mark: |Paid - ApiKey|
|[1forge][7] |API |:heavy_check_mark: |Freemium / Paid - ApiKey|
|[The Money Converter][5] |HTML / Regex |:heavy_check_mark: |Free|
|[Open Exchange Rates][6] |API |:heavy_check_mark: |Freemium / Paid - ApiKey|
[1]: //google.com
[2]: //yahoo.com
[3]: //currencylayer.com
[4]: //fixer.io
[5]: //themoneyconverter.com
[6]: //openexchangerates.org
[7]: //1forge.com
### Uptime Monitor
## TODO LIST
- [ ] error structure for empty json or regex not matched
- [ ] convert panic to api json error
- [ ] increase tests
- [ ] verbose logging
- [ ] godoc
- [ ] static bundle public folder `./cmd/server/public`
- [ ] v 1.0.0 release ( docker / binary github / homebrew mac )
- [ ] support historical rates if possible
- [ ] benchmark & performance optimization ` memory leak`
- [ ] contributors list
## Contributing
Anyone is welcome to [contribute](CONTRIBUTING.md), however, if you decide to get involved, please take a moment to review the guidelines:
* [Only one feature or change per pull request](CONTRIBUTING.md#only-one-feature-or-change-per-pull-request)
* [Write meaningful commit messages](CONTRIBUTING.md#write-meaningful-commit-messages)
* [Follow the existing coding standards](CONTRIBUTING.md#follow-the-existing-coding-standards)
#### Credits
> Inspired by [florianv/swap](https://github.com/florianv/swap)
## License
The code is available under the [MIT license](LICENSE.md).