Referencia API
Para los detalles de cualquier metodo de bcrpy, se puede hacer una busqueda rapida de algun metodo con Ctrl+F y escribiendo el nombre del metodo
(ejemplo: Ctrl+F “plot”).
Metodos globales
- class bcrpy.save_dataframe(df, filename)
Guarda la informacion de datos almacenados y procesados por Python en un archivo
Parametros
- filename: str
Nombre del archivo para guardar. Si el nombre termina con el sufijo “.csv”, se guarda como archivo CSV, si termina con “.md”, se guarda como archivo Markdown. En otro caso, el archivo se guarda en formato de Python [‘pickle’]
Metodos locales a la clase bcrpy.Marco
- class bcrpy.Marco
- __init__()
Este es el marco principal para almacenar variables y ejecutar metodos para extraer, buscar y manejar datos.
Parametros
- metadata: pandas.DataFrame
Los metadatos de las series estadísticas del BRCPData, los cuales pueden ser reducidos con el metodo refine_metadata de esta class.
- data: pandas.DataFrame
Los datos extraidos del BRCPData de acuerdo a la informacion declarada en las variables constructoras (vea metodo parameters()) con el metodo GET() de esta clase.
- codigoslist(str)
lista de codigos de series en interes para usar con los metodos de esta class.
- formatostr
formato para extraer / procesar datos (predeterminado: json)
- fechainistr
fecha de inicio para la(s) serie(s) seleccionada(s) en mes año (A) y mes (M) (formato AAAA-M)
- fechafinstr
fecha de final para la(s) serie(s) seleccionada(s) en mes año (A) y mes (M) (formato AAAA-M)
- idiomastr
idioma seleccionado (predeterminado: ing) otra opcion es ‘esp’
- parameters()
Declara el estado actual de todas las variables constructoras de la clase Marco.
- get_metadata(filename='metadata.csv')
Extrae todos los metadatos de BCRPData.
Parametros
- filenamestr
Nombre del archivo para guardar todos los metadatos extraidos como un archivo .csv (predeterminado: ‘metadata.csv’). Si se desea no guardar un archivo, cambiar a filename=’’
- load_metadata(filename='metadata.csv')
Carga los metadatos guardados como archivo .csv a Python.
Parametros
- filenamestr
Nombre del archivo .csv del cual cargar los metadatos a Python.
- save_metadata(filename='metadata_new.csv')
Guarda los metadatos de self.metadata como archivo .csv
Parametros
- filenamestr
Nombre para el archivo .csv (predeterminado = ‘metadata_new.csv’)
- query(codigo='PD39793AM')
Consulta (query) de codigo de serie, impresa en formato json.
Parametros
- codigostr
Nombre de codigo de series a consultar
- query_dict(codigo='PD39793AM')
- wordsearch(keyword='economia', cutoff=0.65, columnas='all')
Realiza una búsqueda difusa de palabras clave (keyword) en los metadatos de BCRPData. Regresa una tabla de datos en formato pandas.DataFrame de los metadatos asociados con aquella palabra.
Parametros
- keywordstr
Palabra clave para reducir los metadatos
- cutofffloat
Este es la metrica de similitud de palabras (predeterminado=0.65). Un cutoff de 1.00 solo regresara metadatos que contienen palabras que coinciden con la palabra clave al 100%.
- columnasstr
Indices de columnas de los metadatos seleccionados para correr el metodo. Predeterminado=’all’ corre el metodo en todas las columnas. Seleccion por indice: e.g. [0,2,4] busca en la primera, tercera, y quinta columna.
- refine_metadata(filename=False)
Reduce los metadatos en self.metadata a aquellos perteneciendo a los codigos de serie declarados en self.codigos.
Parametros
- filenamestr (opcional)
Nombre para guardar la informacion de la modificada self.metadata como un archivo .csv
- order_columns(hacer=True)
sub-metodo para re-ordenar columnas de acuerdo a como fueron definidos en objeto.codigos (vea metodo GET() parametro “orden”)
Parametros
- hacerbool
ordenarlas (True)
- GET(forget=False, order=True, datetime=True)
Extrae los datos del BCRPData selecionados por las previamente-declaradas variables objeto.codigos, objeto.fechaini, objeto.fechafin, objeto.formato, y objeto.idioma.
Parametros
- forgetbool
Si True, se restablecerá el caché y se obtendrán los datos nuevamente incluso si ya existen en el caché.
- orderbool
Las columnas mantienen el orden declarados por el usuario en objeto.codigos con opcion order=True (predeterminado). Cuando order=False, las columnas de los datos es la predeterminada por BCRPData.
- datetimebool
Formato de las fechas en el pandas.Dataframe. Predeterminado: True convierte fechas con el formato str(MMM.YYYY) (ejemplo Apr.2022) de BCRPData a la estructura de datos Timestamp(YYYY-MM-01) que es elastico para las graficas visuales y otra manipulacion de datos. False mantiene el formato rigido str(MMM.YYYY) de BCRPData.
Devuelve
- pandas.DataFrame
Un DataFrame que contiene los datos de las series temporales seleccionadas.
- get_data_for_chunk(chunk)
- largeGET(codigos=[], chunk_size=100, turbo=True, nucleos=4)
Extrae los datos del BCRPData seleccionados para cantidades mayores a 100 series temporales.
Parametros
- codigoslist
Lista de códigos de series temporales a obtener y/o obtenidos [para el caso de turbo (computo paralelo)] (por defecto es una lista vacía).
- chunk_sizeint
Número de series temporales para obtener en cada fragmento (por defecto es 100).
- turbobool
Indica si se debe utilizar el modo “turbo” para la extracción paralela (por defecto es True).
- nucleosint
Número de núcleos de procesador “cores” a utilizar en el modo “turbo” (por defecto es 4).
Devuelve
- pandas.DataFrame
Un DataFrame que contiene los datos de las series temporales seleccionadas.