Se implementa un programa que permite leer datos de una API de finanzas, guardarlos en una base de datos y graficarlos.
- Se desarrolla el diseño con el objetivo de lograr un software completamente modular con código reutilizable.
- Se implementa chequeo de errores de ingreso de usuario (Ticker inválido, formato de fecha incorrecto, rango de fecha incorrecto) y de la API (Excepción de request, timeout, error http, etc.).
- Se avisa al usuario que no se obtuvieron resultados (en caso de que el rango de fechas sea feriado)
- Se previene la carga de datos duplicados en la DB
- Se muestra un sumario de los datos en la DB indicando el ticker, y rangos de fechas almacenados para el mismo.
- Se muestran los datos en forma gráfica, graficando el valor de Apertura, Cierre, Máximo y Mínimo.
El software consta de 3 módulos fundamentales:
- Obtención de datos de la API
- Gestión de base de datos
- Muestra de información en pantalla
Para cada uno de los módulos se implementa una clase encargada de gestionar todas las funciones relacionadas. La gestión de la interfaz de usuario es delegada al programa principal, ya que dicha función es específica para cada aplicación por lo que no se busca la modularización de la misma.
Esta clase permite acceder a los datos de stocks de la API Polygon.io. Se utiliza esta API por ser la propuesta por la consigna y porque cumple con los requisitos del software aunque conociendo las limitaciones que genera la utilización de una Key gratuita:
- Solo se pueden acceder a datos de hasta dos años de antigüedad: Se considera suficiente para el testeo de la aplicación
- No se pueden obtener los datos en tiempo real, sino que solo los datos de cierre: Esta limitación no permite implementar gráficos en tiempo real, pero no es una característica que se desee implementar.
- Se pueden realizar hasta 5 llamadas a la API por minuto: Se considera suficiente para el testeo de la aplicación
La API devuelve varios datos para cada período de agregación, pero para el caso de esta aplicación los únicos que se consideran son los siguientes:
o: Valor de apertura en dólares del ticker.
c: Valor de cierre en dólares del ticker.
h: Valor en dólares más alto alcanzado por el ticker.
l: Valor en dólares más bajo alcanzado por el ticker.
t: Time stamp en formato UNIX en milisegundos, correspondientes al inicio del período de agregación. Este valor corresponde a la fecha y hora GMT a las 0 hs de NYC, por lo tanto, en verano de NYC devuelve la hora GMT 4 AM, pero en invierno devuelve la hora GMT 5 AM. Para esta aplicación se trabaja solo con las fechas por lo que no se le da relevancia al huso horario.
results_count: Cantidad de registros devueltos en la consulta.
- Librería datetime: De esta librería se importan los métodos datetime y timedelta. Estos se utilizan para realizar las comprobaciones de las fechas ingresadas y realizar operaciones aritméticas entre ellas.
- Librería request: Se utiliza para hacer los llamados a la API.
En primera instancia se crea una cuenta ingresando a la página https://polygon.io/ y seleccionando "Get free API key". Una vez creada la cuenta y obtendida la clave, se accede a la documentación de stocks de la API en https://polygon.io/docs/stocks/getting-started
Para acceder a la API se debe hacer un request a la dirección https://api.polygon.io/v2 y pasando los parámetros directamente en dicha dirección como en el siguiente ejemplo:
Opcionalmente, se puede enviar la apikey a través de un Authorization header, y es como se implementa en este software, en donde se carga la url con todos los parámetros solicitados por el usuario y se envía la key en el header:
requests.get(request_url, headers=header)Se opta por obtener un período de agregación de 1 día de forma de obtener la máxima resolución posible otorgada por la key gratuita.
Al instanciar la clase se llama a la función constructora, enviando como argumento dirección de la API y la key:
api = PolygonAPI("https://api.polygon.io/v2", "c7Eb8zf4Eptgc6WyITtNPrbJITWpxp_i")
Ambos argumentos se guardan en variables de instancia privadas, ya que no deben ser modificadas por fuera de la clase (esto se logra colocando un doble guión bajo antes del nombre de la variable):
class PolygonAPI:
def __init__(self, url, key):
self.__url = url
self.__api_key = keyObtiene los registros de la API solicitando el ticker, la fecha de inicio y de fin al usuario mediante métodos auxiliares que verifican el correcto ingreso de los datos. Los ingresos del usuario se guardan en variables de instancia accesibles por otras clases, luego, los datos obtenidos de la API se devuelven en formato json, salvo que se produzca un error, en ese caso devuelve cero, en donde el error se gestiona en el main.
Chequeo de errores:
- La fecha inicial es más reciente que la fecha final. En ese caso se vuelve a solicitar un nuevo ingreso para ambas fechas.
- Excepción de timeout. Si la API se demora en entregar los resultados más de lo esperado, se informa al usuario del error y se retorna cero.
- Excepción de request. Si el servidor no responde (este error se produce por ejemplo cuando no hay conexión de internet), se informa al usuario del error y se retorna cero.
- Excepción de TooManyRedirects y HTTPError (respuesta diferente de 200). En ambos casos se pasa la descripción del error que devuelve la excepción al usuario y se retorna cero.
- En caso de otro error se informa al usuario que se produjo un error desconocido y se retorna cero.
Solicita al usuario que ingrese el ticker a consultar y retorna el valor ingresado, pasado previamente a upper case.
Es un método genérico que sirve para solicitar una fecha en el formato admitido por la API. Recibe como argumento un texto a mostrar al usuario para indicarle el dato que debe ingresar. En caso de error vuelve a solicitar el ingreso.
Chequeo de errores:
- Formato de fecha incorrecto (no respesta YYYY-MM-DD).
- Rango de fecha incorrecto. Si se solicitan registros de más de dos años debido a la limitación de la cuenta gratuita de la API.
- Fecha ingresada posterior a la fecha actual del sistema.
Esta clase implementa métodos para grabar en una base de datos localmente, la lectura de la misma y la muestra de un sumario de los datos guardados por consola.
Librería datetime: De esta librería se importa el método datetime. Este se utiliza para formatear las fechas en formato string (YYYY-MM-DD) y para convertir dicho string en timestamp
Librería sqlite3: Se utiliza para crear y acceder a la base de datos. Se opta por sqlite debido a que permite acceder a la base de datos como si fuera un simple archivo local, sin tener que acceder y configurar un servidor como sí pasa con SQL.
Librería pandas: Se utiliza para convertir los datos de la base de datos en un data frame compuesto por filas y columnas, el cual es más fácil de manejar posteriormente.
Al instanciar la clase se llama a la función constructora, enviando como argumento el nombre del archivo de la base de datos, el cual se guarda en la raíz del proyecto:
db = Database('Base.db')En el momento de instanciar, se establece la conexión y se define la variable cur para acceder a la misma:
def __init__(self, file):
self.con = sqlite3.connect(file)
self.cur = self.con.cursor()Este método recibe como argumento los datos a guardar en formato json, luego guarda el nombre del ticker y los datos en una lista. La tabla se crea mediante:
self.cur.execute(
'CREATE TABLE IF NOT EXISTS ' + self.__ticker + ' (v, vw, o, c, h, l, t INTEGER PRIMARY KEY NOT NULL ON CONFLICT IGNORE, n)')En donde se define la key t como ID de la tabla, ya que es un parámetro que no se repite y de esa forma se evita almacenar datos repetidos. Al definirlo como "ON CONFLICT IGNORE" en el caso que se intente grabar datos existentes estos no se sobrescriben y se ignora el error, para lo cual se usa también el comando "INSERT OR IGNORE" para agregar los datos.:
query = 'INSERT OR IGNORE INTO ' + self.__ticker + ' VALUES(?, ?, ?, ?, ?, ?, ?, ?)'
for item in self.__lista:
self.cur.execute(query, tuple(item.values()))
self.con.commit()Adicionalmente se guarda en una tabla especial (inicialmente se crea si no existe) llamada RANGOS los rangos de fecha solicitados por el usuario históricamente para cada ticker en particular. Esto se hace debido a que la API no devuelve la fecha de inicio y fin si es que en las mismas no hay datos, por ejemplo si se solicita como comienzo del período un sábado, la API devuelve como primer fecha la correspondiente al lunes por lo que en ese caso el ingreso del usuario se perdería.
Se utiliza para mostrar al usuario la información contenida en la base de datos. Si se llama sin ningún argumento, devuelve toda la información con el siguiente formato:
Item Ticker Fecha inicial Fecha final
1 MELI 2022-01-01 2022-02-01
2 MELI 2022-03-01 2022-04-01
3 AAL 2021-01-01 2022-02-01
4 AAL 2022-05-01 2022-06-01 Si al realizar el llamado se especifica un ticker en particular, devuelve solo la información para dicho ticker. Esto se logra mediante el uso de argumentos predeterminados:
def summary(self, ticker='*'):
if ticker == '*':
self.cur.execute(f"SELECT * FROM RANGOS")
else:
self.cur.execute(f"SELECT * FROM RANGOS WHERE ticker='{ticker}'")Se utiliza para seleccionar un rango de fechas de los disponibles en la base de datos para un ticker en particular, el cual se devuelve en una tupla. Esta información se utiliza posteriormente para graficar la información.
Se utiliza para obtener de la base de datos la información de un ticker determinado, el cual se pasa como argumento. Los datos se devuelven en un data frame de pandas.
Esta clase se encarga de mostrar los datos en forma gráfica.
matplotlib: Es la librería necesaria para realizar gráficos en pantalla. datetime: Se utiliza para convertir los rangos de fecha a graficar
Este método se encarga de graficar la información en pantalla. Recibe como argumento un dataframe de pandas con los datos a graficar, el ticker y una tupla con el rango de fechas.
Al realizar el llamado se obtiene como resultado un gráfico como el siguiente:
Para ejecutar el programa se debe abrir una consola donde está ubicado el archivo main y ejecutar "py main.py". En caso de que falte alguna librería, ésta debe instalarse previamente mediante el comando pip.
Durante la realización del trabajo y utilizando como base lo incorporado en el curso, se abarcaron los siguientes temas:
- Uso de la documentación de una API en particular para comprender el modo de acceso a la misma.
- Manejo de timestamps en formato UNIX.
- Uso de programación orientada a objetos para modularizar el código
- Uso extensivo de gestión de errores, ya sea de sistema o de ingreso del usuario
- Distintas formas de guardar y obtener información en una base de datos, contemplando la existencia de datos repetidos, tabla o archivo aún no creados.
- Conversión entre distintos formatos de datos.
- Uso de control de versiones utilizando github.
- Uso del lenguaje markdown para la realización de la documentación (este archivo)
- Uso de clases
- Gestión de errores de ingreso del usuario y de sistema como se detalla en esta documentación.