xint0/banxico-php

Cliente PHP para la API ReST del SIE del Banco de México

1.0.3 2023-08-02 22:56 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• php-http/client-common: ^2.0
• php-http/discovery: ^1.0
• php-http/httplug: ^2.2
• psr/http-client-implementation: ^1.0
• psr/http-factory-implementation: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• guzzlehttp/psr7: ^2.0
• php-http/message: ^1.0
• php-http/mock-client: ^1.0

MIT

• Rogelio Jacinto

• rest
• api
• client
• SIE
• cliente
• Banco de Mexico

README

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

Instalación

Requisitos

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

Utilizar Composer

Instalar con el adaptador para Guzzle 7 por ejemplo:

composer require xint0/banxico-php php-http/guzzle7-adapter

Si ya se tiene definido un cliente PSR-18 en el proyecto, se puede instalar solo el cliente:

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');

Licenciamiento

Los derechos de autor de este software pertenecen a su autor Rogelio Jacinto. Copyright 2018-2021 Rogelio Jacinto. Todos los derechos reservados.

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