dobletau-quant 1.0.5

API para participar en una competencia de trading algoritmico.

DobleTau Quant

DobleTau Quant es una API diseñada para los participantes de la competencia de trading algoritmico. La API permite enviar operaciones automatizadas y consultar resultados de manera sencilla y eficiente.

---

Instalación

Para instalar la librería, ejecuta el siguiente comando en tu terminal:

pip install dobletau-quant

---

Uso Básico

Inicialización

Antes de usar las funciones, debes inicializar la clase BotConnector con el token único que identifica a tu bot. Este token es proporcionado al registrarte en la plataforma.

from dobletau_quant import BotConnector

# Inicializa el cliente con tu token único
bot = BotConnector(token="TU_TOKEN")

---

Funciones Disponibles

1. Enviar una Operación (send_operation)

Envía una operación de compra o venta de un activo. El token del bot se incluye automáticamente durante la inicialización del cliente.

Parámetros:

• activo: Símbolo del activo (ticker) como AAPL, TSLA.
• cantidad: Número entero (positivo para compras, negativo para ventas).

Ejemplo:

bot.send_operation(activo="AAPL", cantidad=10)

Resultado esperado (éxito):

Operación enviada exitosamente.

Posibles errores:

• "La cantidad debe ser un número entero distinto de cero."
• "El activo 'AAPL' no existe en la tabla 'Activos'."
• "Error al enviar la operación: [detalle del error]"

---

2. Consultar el Historial de Operaciones (get_historial)

Devuelve un historial detallado de todas las operaciones realizadas por tu bot. El token del bot se incluye automáticamente.

Ejemplo:

historial = bot.get_historial()
print(historial)

Resultado esperado:

Un DataFrame con el historial, con columnas como:

• bot: Nombre del bot.
• ticker: Activo financiero operado.
• cantidad: Cantidad comprada o vendida.
• precio: Precio al momento de la operación.
• hora: Fecha y hora de la operación.

Ejemplo de salida:

        bot   ticker  cantidad  precio                hora
0     BotX     AAPL        10  150.25  2024-12-22 10:30:00
1     BotX     TSLA       -15  400.50  2024-12-21 12:00:00

Posibles errores:

• "Error al obtener historial: [detalle del error]"

---

Flujo de Trabajo Sugerido

1. Configura tu cliente: Inicializa el cliente con el token único de tu bot.
2. Envia operaciones: Usa send_operation para enviar operaciones de compra y venta simuladas.
3. Analiza resultados: Utiliza get_historial para evaluar el rendimiento de tu bot en la competencia.

---

Validaciones Automáticas

La API incluye validaciones para:

1. Cantidad:
   • Debe ser un número entero distinto de cero.
   • Ejemplo válido: 10 o -5.
   • Ejemplo inválido: 0 o 5.5.
2. Activos:
   • Solo se permiten activos registrados en la tabla Activos.
3. Bots:
   • Cada operación está vinculada al bot identificado por el token proporcionado durante la inicialización.

---

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.

---

Contacto

¿Tienes preguntas o sugerencias?
Escríbenos a [e-mail].