bcvcurs

command module
v0.0.0-...-a4b0e94 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2022 License: MIT Imports: 17 Imported by: 0

README

BCV currencies

RESTful API to obtain BCV currency values directly from the website (http://www.bcv.org.ve/).

Run local

$ git clone https://github.com/adrianolmedo/bcvcurs.git
$ go install .
$ bcvcurs -addr localhost -port 8080

Run with Docker

$ git clone https://github.com/adrianolmedo/bcvcurs.git
$ make

Note: make by default runs the target defined in the .DEFAULT_GOAL variable of the Makefile.

Content

Endpoints

All currencies

GET: /v1

Response (200 OK):

{
    "data": {
        "dollar": {
            "iso": "USD",
            "symbol": "$",
            "value": 4.4032
        },
        "euro": {
            "iso": "EUR",
            "symbol": "€",
            "value": 5.00608614
        },
        "lira": {
            "iso": "TRY",
            "symbol": "₺",
            "value": 0.3234693
        },
        "ruble": {
            "iso": "RUB",
            "symbol": "₽",
            "value": 0.05774612
        },
        "yuan": {
            "iso": "CNY",
            "symbol": "¥",
            "value": 0.694785
        }
    },
    "message_ok": {
        "content": ""
    }
}

Euro

GET: /v1/euro

Response (200 OK):

{
    "data": {
        "iso": "EUR",
        "symbol": "€",
        "value": 5.04244811
    },
    "message_ok": {
        "content": ""
    }
}

Yuan

GET: /v1/yuan

Response (200 OK):

{
    "data": {
        "iso": "CNY",
        "symbol": "¥",
        "value": 0.7005779
    },
    "message_ok": {
        "content": ""
    }
}

Lira

GET: /v1/lira

Response (200 OK):

{
    "data": {
        "iso": "TRY",
        "symbol": "₺",
        "value": 0.3255186
    },
    "message_ok": {
        "content": ""
    }
}

Ruble

GET: /v1/ruble

Response (200 OK):

{
    "data": {
        "iso": "RUB",
        "symbol": "₽",
        "value": 0.05899348
    },
    "message_ok": {
        "content": ""
    }
}

Dollar

GET: /v1/dollar

Response (200 OK):

{
    "data": {
        "iso": "USD",
        "symbol": "$",
        "value": 4.4369
    },
    "message_ok": {
        "content": ""
    }
}

Errors

Error path

Response (404 Not Found):

{
    "message_error": {
        "content": "path error"
    }
}
Getting data

Response (503 Service Unavailable):

{
    "message_error": {
        "content": "error getting data"
    }
}

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL