guidospadavecchia / DolarBot-Api

La API oficial de DolarBot

Home Page:https://dolarbot-api.vercel.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Status

Version NPM

Descripción

DolarBot-API es la aplicación backend de DolarBot. Unifica las llamadas a los distintos orígenes de datos en un sólo lugar y bajo un formato estandarizado. Este proyecto es un fork de Castrogiovanni20/api-dolar-argentina.

Nota: La APIs hosteadas en "Deployments" de este repositorio son APIs privadas, utilizadas únicamente por DolarBot. Es por esto que al consultar cualquier endpoint devolverá un código 403 Forbidden. Para utilizar DolarBot-API de forma pública es necesario deployar tu propia instancia y realizar la configuración según se explica continuación.

Configuración

  1. Configurar el parámetro requiresApiKey dentro del archivo package.json. Si se desea utilizar la API de forma pública, se debe configurar requiresApiKey = false, de lo contrario, configurar requiresApiKey = true y crear la variable de entorno DOLARBOT_APIKEY en el servidor que aloja la aplicación. Nota: La misma key debe ser enviada en el header de cada request o de lo contrario la API devolverá un código 403 Forbidden.
  2. Opcionalmente, crear la variable de entorno PORT con el puerto dónde estará escuchando la aplicación.
  3. Deploy.

Endpoints

Cotizaciones del Dólar

Método Endpoint Descripción
GET /api/dolar/oficial Cotización del dólar oficial
GET /api/dolar/blue Cotización del dólar blue
GET /api/dolar/ahorro Cotización del dólar ahorro
GET /api/dolar/tarjeta Cotización del dólar tarjeta
GET /api/dolar/qatar Cotización del dólar Qatar
GET /api/dolar/contadoliqui Cotización dólar contado con liqui
GET /api/dolar/promedio Cotización dólar promedio
GET /api/dolar/bolsa Cotización dólar bolsa
GET /api/dolar/bancos/all Cotización del dólar de todos los bancos
GET /api/dolar/bancos/bbva Cotización del dólar de Banco BBVA
GET /api/dolar/bancos/piano Cotización del dólar de Banco Piano
GET /api/dolar/bancos/hipotecario Cotización del dólar de Banco Hipotecario
GET /api/dolar/bancos/hsbc Cotización del dólar de Banco HSBC
GET /api/dolar/bancos/galicia Cotización del dólar de Banco Galicia
GET /api/dolar/bancos/santander Cotización del dólar de Banco Santander
GET /api/dolar/bancos/macro Cotización del dólar de Banco Macro
GET /api/dolar/bancos/ciudad Cotización del dólar de Banco Ciudad
GET /api/dolar/bancos/supervielle Cotización del dólar de Banco Supervielle
GET /api/dolar/bancos/patagonia Cotización del dólar de Banco Patagonia
GET /api/dolar/bancos/comafi Cotización del dólar de Banco Comafi
GET /api/dolar/bancos/nacion Cotización del dólar de Banco Nación
GET /api/dolar/bancos/bind Cotización del dólar de Banco Industrial
GET /api/dolar/bancos/bancor Cotización del dólar de Banco de Córdoba
GET /api/dolar/bancos/chaco Cotización del dólar de Nuevo Banco del Chaco
GET /api/dolar/bancos/pampa Cotización del dólar de Banco de La Pampa
GET /api/dolar/bancos/provincia Cotización del dólar de Banco Provincia
GET /api/dolar/bancos/icbc Cotización del dólar de Banco ICBC
GET /api/dolar/bancos/brubank Cotización del dólar de Brubank
GET /api/dolar/bancos/reba Cotización del dólar de Rebanking
GET /api/dolar/bancos/roela Cotización del dólar de Banco Roela

Respuestas

Genéricos
{
    fecha: "2020/06/21 23:26:42",
    compra: "68.07",
    venta: "73.07"
}
Bancos
{
    nombre: 'BBVA',
    descripcion: 'Banco BBVA',
    fecha: "2020/06/21 23:26:42",
    compra: "89.02",
    venta: "92.02",
    ventaAhorro: "156.78"
}

Cotizaciones del Euro

Método Endpoint Descripción
GET /api/euro/oficial Cotización del Euro oficial
GET /api/euro/blue Cotización del Euro blue
GET /api/euro/ahorro Cotización del Euro ahorro
GET /api/euro/tarjeta Cotización del Euro tarjeta
GET /api/euro/qatar Cotización del Euro Qatar
GET /api/euro/bancos/all Cotización del Euro de todos los bancos
GET /api/euro/bancos/nacion Cotización del Euro del Banco Nación
GET /api/euro/bancos/galicia Cotización del Euro del Banco Galicia
GET /api/euro/bancos/bbva Cotización del Euro del Banco BBVA
GET /api/euro/bancos/pampa Cotización del Euro del Banco de La Pampa
GET /api/euro/bancos/chaco Cotización del Euro del Nuevo Banco del Chaco
GET /api/euro/bancos/hipotecario Cotización del Euro del Banco Hipotecario
GET /api/euro/bancos/piano Cotización del Euro del Banco Piano
GET /api/euro/bancos/santander Cotización del Euro del Banco Santander
GET /api/euro/bancos/ciudad Cotización del Euro del Banco Ciudad
GET /api/euro/bancos/supervielle Cotización del Euro del Banco Supervielle
GET /api/euro/bancos/patagonia Cotización del Euro del Banco Patagonia
GET /api/euro/bancos/comafi Cotización del Euro del Banco Comafi
GET /api/euro/bancos/reba Cotización del Euro de Rebanking
GET /api/euro/bancos/roela Cotización del Euro de Banco Roela

Respuestas

Genéricos
{
    fecha: "2021/07/08 00:24:03",
    compra: "124.53",
    venta: "132.41",
}
Bancos
{
    nombre: 'BBVA',
    descripcion: 'Banco BBVA',
    fecha: "2020/06/21 23:26:42",
    compra: "126.45",
    venta: "134.67",
    ventaAhorro: "173.23"
}

Cotizaciones del Real

Método Endpoint Descripción
GET /api/real/oficial Cotización del Real oficial
GET /api/real/blue Cotización del Real blue
GET /api/real/ahorro Cotización del Real ahorro
GET /api/real/tarjeta Cotización del Real tarjeta
GET /api/real/qatar Cotización del Real Qatar
GET /api/real/bancos/all Cotización del Real de todos los bancos
GET /api/real/bancos/nacion Cotización del Real del Banco Nación
GET /api/real/bancos/bbva Cotización del Real del Banco BBVA
GET /api/real/bancos/chaco Cotización del Real del Nuevo Banco del Chaco
GET /api/real/bancos/piano Cotización del Banco Piano
GET /api/real/bancos/ciudad Cotización del Banco Ciudad
GET /api/real/bancos/supervielle Cotización del Banco Supervielle

Respuestas

Genéricos
{
    fecha: "2021/07/08 00:24:03",
    compra: "13.15",
    venta: "15.67",
}
Bancos
{
    nombre: 'BBVA',
    descripcion: 'Banco BBVA',
    fecha: "2020/06/21 23:26:42",
    compra: "13.18",
    venta: "14.96",
    ventaAhorro: "27.32"
}

Otras monedas del mundo

Método Endpoint Descripción
GET /api/monedas/lista Obtiene la lista de monedas disponibles para su consulta
GET /api/monedas/valor/<code> Valor de la moneda especificada contra el Peso Argentino.
Debe ser un código válido de la lista de monedas
GET /api/monedas/historico/<code>/<date> Valores diarios históricos de la moneda especificada contra el Peso Argentino.
Debe ser un código válido de la lista de monedas y una fecha válida en formato yyyy-MM-DD

Respuestas

Lista de monedas
[
  {
    code: "AED",
    name: "United Arab Emirates Dirham",
  },
  {
    code: "AFN",
    name: "Afghan Afghani",
  },

  ...{
    code: "JPY",
    name: "Japanese Yen",
  },
];
Valor
{
    fecha: "2021/07/22 23:43:28",
    valor: "96.41",
}
Histórico
{
  fecha: "2006/05/16",
  valor: "3.03",
}

Crypto

Método Endpoint Descripción
GET /api/crypto/list Obtiene la lista de criptomonedas disponibles para su consulta
GET /api/crypto/bitcoin Valor del Bitcoin (BTC)
GET /api/crypto/bitcoincash Valor del Bitcoin Cash (BCH)
GET /api/crypto/ethereum Valor del Ethereum (ETH)
GET /api/crypto/monero Valor del Monero (XMR)
GET /api/crypto/litecoin Valor del Litecoin (LTC)
GET /api/crypto/ripple Valor del Ripple (XRP)
GET /api/crypto/dash Valor del DASH (DASH)
GET /api/crypto/<code> Valor de la criptomoneda especificada.
Debe ser un código válido de la lista de criptomonedas

Respuestas

Lista de criptomonedas
[
  {
    code: "bitcoin",
    name: "Bitcoin",
    symbol: "BTC",
  },
  {
    code: "cardano",
    name: "Cardano",
    symbol: "ADA",
  },

  ...{
    code: "ethereum",
    name: "Ethereum",
    symbol: "ETH",
  },
];
Moneda
{
    name: "Bitcoin",
    code: "BTC",
    date: "2021/01/02 01:32:42",
    ars: "4467101.00",
    arsTaxed: "7370716.65",
    usd: "49817.00",
    usd24hchange: "5.26",
    usd24hvolume: "165987845.58",
    usdMarketCap: "126457986545412.23"
}

Metales

Método Endpoint Descripción
GET /api/metales/oro Valor internacional del Oro
GET /api/metales/plata Valor internacional de la Plata
GET /api/metales/cobre Valor internacional del Cobre

Respuestas

{
    fecha: "2021/01/02 01:32:14",
    valor: "1893.40",
    unidad: "Onza",
    moneda: "USD"
}

Venezuela

Método Endpoint Descripción
GET /api/vzla/dolar Cotizaciones del dólar en bolívares (VEF)

Respuestas

{
    fecha: "2021/01/07 19:33:21",
    paralelo: "1446012.11",
    bancos: "1231206.11",
    moneda: "USD"
}

Indicadores BCRA

Método Endpoint Descripción
GET /api/bcra/riesgopais Valor del Riesgo País
GET /api/bcra/reservas Reservas del BCRA en dólares
GET /api/bcra/circulante Total de pesos en circulación

Respuestas

Riesgo país
{
    fecha: "2020/11/22 19:58:37",
    valor: "1245"
}
Reservas y circulante
{
    fecha: "2020/11/22 19:58:37",
    valor: "39120000000",
    moneda: "USD"
}

Evolución histórica

Método Endpoint Descripción
GET /api/evolucion/dolar/oficial Evolución mensual anualizada del Dólar oficial
GET /api/evolucion/dolar/ahorro Evolución mensual anualizada del Dólar ahorro
GET /api/evolucion/dolar/blue Evolución mensual anualizada del Dólar blue
GET /api/evolucion/real/oficial Evolución mensual anualizada del Real oficial
GET /api/evolucion/real/ahorro Evolución mensual anualizada del Real ahorro
GET /api/evolucion/euro/oficial Evolución mensual anualizada del Euro oficial
GET /api/evolucion/euro/ahorro Evolución mensual anualizada del Euro ahorro

Respuestas

{
    fecha: "2020/11/22 19:59:46",
    meses: [
        {
            anio: "2019",
            mes: "11",
            valor: "66.20"
        },
        {
            anio: "2019",
            mes: "12",
            valor: "69.71"
        },
        {
            anio: "2020",
            mes: "1",
            valor: "77.00"
        },

        ...

        {
            anio: "2020",
            mes: "9",
            valor: "136.80"
        },
        {
            anio: "2020",
            mes: "10",
            valor: "165.16"
        },
    ],
}

Integraciones

Agradecimientos

  • @Castrogiovanni20 - Por proveer el código del proyecto original y permitirme usar su API libremente.

Licencia

DolarBot-API es open-source, libre y gratuita. Está licenciada bajo la MIT License.

Contribuciones

Invitame un café en cafecito.app

Hecho con 💙 en node.js

About

La API oficial de DolarBot

https://dolarbot-api.vercel.app/

License:MIT License


Languages

Language:JavaScript 100.0%