Skip to content

Latest commit

 

History

History
194 lines (130 loc) · 8.93 KB

README.md

File metadata and controls

194 lines (130 loc) · 8.93 KB
Raw

pyDolarVenezuela API

La API de pyDolarVenezuela es una herramienta eficiente y confiable que brinda información en tiempo real sobre el valor del dólar y euro en Venezuela. Además, facilita la conversión precisa entre bolívares y estas monedas extranjeras.

Swagger API: https://pydolarve.org/apidocs

URL base

https://pydolarve.org/

Endpoints

GET /

Este endpoint muestra un mensaje de bienvenida y proporciona un enlace a la documentación de la API.

GET /api/v1/<currency>

Este endpoint permite obtener todas las entidades de seguimiento del dólar y/o euro, junto con su nombre correspondiente, cambio y fecha de la última actualización. Ademas permite obtener información sobre el monitor en una página específica.

Las páginas disponibles son:

  • Fuentes directas:
Página web Ruta
Banco Central de Venezuela api/v1/dollar?page=bcv
EnParaleloVzla api/v1/dollar?page=enparalelovzla
Italcambio api/v1/dollar?page=italcambio
  • Fuentes informativas:
Página web Ruta
AlCambio api/v1/dollar?page=alcambio
Criptodolar api/v1/<currency>?page=criptodolar
Dolartodayn api/v1/dollar?page=dolartoday

Ruta:

  • currency: La moneda en la que se expresarán los precios (dollar, euro).
Parámetros Tipo Descripción
page string Opcional. Indica el nombre de la página donde deseas obtener su valor.
monitor string Opcional. Indica el monitor específico.
format_date string Opcional. Indica el tipo de formato de fecha. (iso, timestamp, default)

El parámetro format_date permite obtener la fecha en diferentes formatos. Por defecto, la fecha se muestra en formato DD/MM/YYYY, HH:mm AM/PM. Si deseas obtener la fecha en formato ISO o timestamp, puedes especificarlo en el parámetro format_date.

GET /api/v1/<currency>/history

Este endpoint le permite conocer el historial de precios de un monitor especificando la fecha de inicio y finalización.

Ruta:

  • currency: La moneda en la que se expresarán los precios (dollar, euro).

Header:

  • Authorization: El token de autorización correspondiente al usuario.
Parámetros Tipo Descripción
page string Indica el nombre de la página donde deseas obtener su valor.
monitor string Indica el monitor específico.
start_date string Fecha de inicio del historial. DD-MM-YYYY
end_date string Fecha de fin del historial. DD-MM-YYYY
format_date string Opcional. Indica el tipo de formato de fecha. (iso, timestamp, default)

GET /api/v1/<currency>/changes

Este endpoint permite conocer los cambios que ha obtenido el monitor en un día concreto. (Actualizaciones de precios)

Ruta:

  • currency: La moneda en la que se expresarán los precios (dollar, euro).

Header:

  • Authorization: El token de autorización correspondiente al usuario.
Parámetros Tipo Descripción
page string Indica el nombre de la página donde deseas obtener su valor.
monitor string Indica el monitor específico.
date string Fecha de la cual se desea obtener los precios. DD-MM-YYYY
format_date string Opcional. Indica el tipo de formato de fecha. (iso, timestamp, default)

GET /api/v1/<currency>/conversion

Este endpoint convierte un valor en bolívares a su equivalente a estas monedas extranjeras y viceversa.

Ruta:

  • currency: La moneda en la que se expresarán los precios (dollar, euro).
Parámetros Tipo Descripción
type string Indica el tipo de conversión. Puede ser VES o USD o EUR.
value float or integer Indica el valor a convertir.
page string Indica el nombre de la página donde deseas obtener su valor.
monitor string Indica el monitor específico.

Webhooks

La API de pyDolarVenezuela también permite configurar webhooks para recibir notificaciones en tiempo real sobre los cambios de precios de los monitores. Para ello, debes proporcionar la URL de tu servidor y el token de autorización correspondiente.

GET /api/user/get-webhook

Este endpoint permite obtener todos los webhooks configurados por el usuario.

Header:

  • Authorization: El token de autorización correspondiente al usuario.

POST /api/user/set-webhook

Este endpoint permite configurar un webhook para recibir notificaciones en tiempo real sobre los cambios de precios de los monitores.

Header:

  • Authorization: El token de autorización correspondiente al usuario.

El token_secret es una clave secreta que se utilizará para verificar la autenticidad de las solicitudes entrantes. Y sera enviado en el header Authorization como Bearer <token_secret>.

Body:

{
  "url": "string",
  "certificate_ssl": true,
  "token_secret": "string",
  "monitors": [
    {
      "page": "string",
      "currency": "string", // dollar or euro
      "monitor": "string"
    }
  ]
}

Note

Una vez configurado el webhook, el servidor enviará una solicitud POST a la URL proporcionada cada vez que se produzca un cambio, despues de 3 intentos fallidos su estado pasará a false.

DELETE /api/user/del-webhook

Este endpoint permite eliminar un webhook configurado previamente.

Header:

  • Authorization: El token de autorización correspondiente al usuario.

Actividad

Alt

Uso

Para obtener información actualizada sobre el precio del dólar en Venezuela de EnParaleloVzla, puedes hacer una solicitud GET a la siguiente URL:

curl -X GET "https://pydolarve.org/api/v1/dollar?monitor=enparalelovzla"

Para obtener información sobre el dólar en una página específica, puedes hacer una solicitud GET a la siguiente URL:

curl -X GET "https://pydolarve.org/api/v1/dollar?page=bcv"

Sponsors

Individual Sponsors


José Gregorio
Bryan
Victor Noguera

Apoya este proyecto

Si deseas conocer características interesantes de la API de por vida, considera hacer una donación o suscribirte a través de Ko-fi. Tu apoyo contribuirá al continuo desarrollo del proyecto y al mantenimiento de los servicios en los que está alojado.

Características Gratis Token
Solicitudes API 500/hora ∞
Historial de precios No Sí
Webhooks No Sí

Envíame un mensaje privado desde Ko-fi para que pueda proporcionarte el token de acceso.

ko-fi

Contributores