banxico

Implements the client for Series.

class satcfdi.apis.banxico.SieAPIRest(bmx_token: str, url_prefix: str = 'https://www.banxico.org.mx')[source]

Bases: object

SIE-BANXICO API API de consulta de series de tiempo del Banco de México version: 1.4.3-hotfix1

metadatos_series_using_get(id_series: str) → str[source]

Series metadata Send a get request to SieAPIRest/service/v1/series/{idSeries}.

Parameters

id_series – idSeries

Returns

OK

datos_series_using_get(id_series: str, decimales: Optional[str] = None, incremento: Optional[str] = None) → str[source]

Series data Send a get request to SieAPIRest/service/v1/series/{idSeries}/datos.

Parameters

  • id_series – idSeries

  • decimales – ‘sinCeros’ to remove trailing zeros to the right of the decimal point.

  • incremento – ‘PorcObsAnt’, ‘PorcAnual’, ‘PorcAcumAnual’.

Returns

OK

datos_oportuno_series_using_get(id_series: str, decimales: Optional[str] = None, incremento: Optional[str] = None) → str[source]

Last data Send a get request to SieAPIRest/service/v1/series/{idSeries}/datos/oportuno.

Parameters

  • id_series – idSeries

  • decimales – ‘sinCeros’ to remove trailing zeros to the right of the decimal point.

  • incremento – ‘PorcObsAnt’, ‘PorcAnual’, ‘PorcAcumAnual’.

Returns

OK

obten_rango_datos_series_using_get(id_series: str, fecha_inicial: str, fecha_final: str, decimales: Optional[str] = None, incremento: Optional[str] = None) → str[source]

Data range Send a get request to SieAPIRest/service/v1/series/{idSeries}/datos/{fechaInicial}/{fechaFinal}.

Parameters

  • id_series – idSeries

  • fecha_inicial – fechaInicial

  • fecha_final – fechaFinal

  • decimales – ‘sinCeros’ to remove trailing zeros to the right of the decimal point.

  • incremento – ‘PorcObsAnt’, ‘PorcAnual’, ‘PorcAcumAnual’.

Returns

OK

metadatos_series_versionadas_using_get(id_series: str) → str[source]

Series versions metadata Send a get request to SieAPIRest/service/v1/series/{idSeries}/versiones.

Parameters

id_series – idSeries

Returns

OK

datos_series_versionadas_using_get(id_series: str, id_version: str, decimales: Optional[str] = None, incremento: Optional[str] = None) → str[source]

Series data Send a get request to SieAPIRest/service/v1/series/{idSeries}/versiones/{idVersion}/datos.

Parameters

  • id_series – idSeries

  • id_version – idVersion

  • decimales – ‘sinCeros’ to remove trailing zeros to the right of the decimal point.

  • incremento – ‘PorcObsAnt’, ‘PorcAnual’, ‘PorcAcumAnual’.

Returns

OK