API

Bienvenido a la documentación para la API de Aevum. Puedes acceder a distintos endpoints de consulta para información disponible en nuestra base de datos.

Algunos endpoints no requieren autenticación y la consulta se puede realizar directamente en la URL desde el navegador, con una respuesta en formato JSON o CSV. Sin embargo una serie de consultas adicionales requieren autenticación.

Si quieres acceder a la API escríbenos a contacto@aevum.cl

Autenticación

La API de Aevum utiliza un sistema de autenticación por token, donde se le asigna a cada cliente un Token (o código de acceso) específico que debe ser utilizado en la cabecera de cada petición. Si el Token no es válido o no se declara, entonces la petición devolverá un error 401. Este Token debe estar registrado previamente en la plataforma de Aevum.

El sitio espera recibir el Token en la cabecera de la siguiente forma:

Authorization: Token TOKEN

A continuación se muestra como hacerlo en Python.

# Tienes que incluir el siguiente header en cada request

TOKEN = 'tu_token'
headers = {
  'Content-Type': 'application/json',
  'Authorization': f'Token {TOKEN}'
}

Uso de la API y ejemplo para una consulta

La URL general de la API es: https://api.aevum.cl/ y luego se anexa el endpoint de consulta y los parámetros requeridos.

A continuación un ejemplo de consulta usando Python y el endpoint index_prices/ con sus parámetros correspondientes, que entrega una series de precios para ciertos índices. Las consultas se realizan con el método GET

import requests
import pandas as pd

URL = 'https://api.aevum.cl/index_prices/?from_date=2023-01-01&nemo=SP%20IPSA%20ESGT'
TOKEN = 'tu_token' # No olvides reemplazarlo por el tuyo

headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Token {TOKEN}'
}

response = requests.get(URL, json=data, headers=headers)
data = response.json()
df = pd.DataFrame.from_dict(data)
df.to_csv('output.csv', index=False)