README

Cliente PHP para la API REST del Sistema de Información Económica (SIE) del Banco de México (Banxico).

Su principal función es obtener los valores de las series SF43718 (Tipo de cambio peso-dólar fecha de determinación) y SF60653 (Tipo de cambio peso-dólar fecha liquidación).

También se tiene un método para obtener una serie específica indicando el nombre de la serie y opcionalmente un rango de fechas.

El código de la serie se puede consultar en catálogo de series del SIE.

Instalación

Requisitos

PHP 8.1 o más reciente.
Cliente HTTP conforme a PSR-18, cualquiera de la lista de clientes y adaptadores de php-http.org.

Utilizar Composer

Esta librería depende de librerías que implementen psr/http-client-implementation y psr/http-factory-implementation y utiliza php-http/discovery por lo que al requerirla en tu proyecto se revisan las librerías instaladas y si no encuentra las librerías requeridas, se instalarán automáticamente.

Para agregarla como dependencia en tu proyecto:

composer require xint0/banxico-php

Cómo usar

Token de consulta

Se debe obtener un token de consulta a través de la página de la API REST del SIE del Banxico.

Obtener el tipo de cambio peso - dólar

<?php

use Xint0\BanxicoPHP\SieClient;

/*
 * Indicar el token de consulta en el constructor de la clase `SieClient`
 */
$cliente = new SieClient('e3980208bf01ec653aba9aee3c2d6f70f6ae8b066d2545e379b9e0ef92e9de25');

/*
 * Tipo de cambio MXN-USD fecha liquidación más reciente disponible
 * Devuelve una cadena de caracteres con el monto por ejemplo: '19.7930'
 */
$tipo_de_cambio = $cliente->exchangeRateUsdLiquidation();

/*
 * Tipo de cambio MXN-USD fecha determinación (Fix) más reciente disponible:
 */
$tipo_de_cambio_fix = $cliente->exchangeRateUsdDetermination();

/*
 *  Tipo de cambio MXN-USD fecha liquidación de un día específico:
 */
$tipo_de_cambio_2021_09_16 = $cliente->exchangeRateUsdLiquidation('2021-09-16');

/*
 *  Arreglo con los tipos de cambio MXN-USD fecha liquidación de un rango de fechas.
 * 
 * Cuando se indica un rango de fechas, el método devuelve un arreglo con las fechas como llaves y el tipo de cambio
 * como valor:
 * [
 *     '2021-08-01' => '19.9999',
 *     '2021-08-02' => '19.9999',
 *     ...
 * ];
 */
$tipo_de_cambio_agosto_2021 = $cliente->exchangeRateUsdLiquidation('2021-08-01', '2021-08-31');

/*
 * Consulta de una serie específica indicando el código de la serie y un rango de fechas.
 */
$tasa_objetivo = $cliente->fetchSeries('SF61745', '2024-01-01', '2024-01-31');

Licenciamiento

Este paquete es software libre, se puede distribuir y/o modificarse bajo los términos de la Licencia MIT.

xint0 / banxico-php

Maintainers

Details