|
| 1 | +from io import StringIO |
| 2 | + |
| 3 | +import requests |
| 4 | +import pandas as pd |
| 5 | + |
| 6 | +from bcb.utils import Date |
| 7 | + |
| 8 | +""" |
| 9 | +Sistema Gerenciador de Séries Temporais (SGS) |
| 10 | +
|
| 11 | +O módulo ``sgs`` obtem os dados do webservice do Banco Central, |
| 12 | +interface json do serviço BCData/SGS - |
| 13 | +`Sistema Gerenciador de Séries Temporais (SGS) |
| 14 | +<https://www3.bcb.gov.br/sgspub/localizarseries/localizarSeries.do?method=prepararTelaLocalizarSeries>`_. |
| 15 | +""" |
| 16 | + |
| 17 | + |
| 18 | +class SGSCode: |
| 19 | + def __init__(self, code, name=None): |
| 20 | + if name is None: |
| 21 | + if isinstance(code, int) or isinstance(code, str): |
| 22 | + self.name = str(code) |
| 23 | + self.value = int(code) |
| 24 | + else: |
| 25 | + self.name = str(name) |
| 26 | + self.value = int(code) |
| 27 | + |
| 28 | + |
| 29 | +def _codes(codes): |
| 30 | + if isinstance(codes, int) or isinstance(codes, str): |
| 31 | + yield SGSCode(codes) |
| 32 | + elif isinstance(codes, tuple): |
| 33 | + yield SGSCode(codes[1], codes[0]) |
| 34 | + elif isinstance(codes, list): |
| 35 | + for cd in codes: |
| 36 | + _ist = isinstance(cd, tuple) |
| 37 | + yield SGSCode(cd[1], cd[0]) if _ist else SGSCode(cd) |
| 38 | + elif isinstance(codes, dict): |
| 39 | + for cd in codes: |
| 40 | + yield SGSCode(codes[cd], cd) |
| 41 | + |
| 42 | + |
| 43 | +def _get_url_and_payload(code, start_date, end_date, last): |
| 44 | + payload = {"formato": "json"} |
| 45 | + if last == 0: |
| 46 | + if start_date is not None or end_date is not None: |
| 47 | + payload["dataInicial"] = Date(start_date).date.strftime("%d/%m/%Y") |
| 48 | + end_date = end_date if end_date else "today" |
| 49 | + payload["dataFinal"] = Date(end_date).date.strftime("%d/%m/%Y") |
| 50 | + url = "http://api.bcb.gov.br/dados/serie/bcdata.sgs.{}/dados".format(code) |
| 51 | + else: |
| 52 | + url = ( |
| 53 | + "http://api.bcb.gov.br/dados/serie/bcdata.sgs.{}/dados" "/ultimos/{}" |
| 54 | + ).format(code, last) |
| 55 | + |
| 56 | + return {"payload": payload, "url": url} |
| 57 | + |
| 58 | + |
| 59 | +def _format_df(df, code, freq): |
| 60 | + cns = {"data": "Date", "valor": code.name, "datafim": "enddate"} |
| 61 | + df = df.rename(columns=cns) |
| 62 | + if "Date" in df: |
| 63 | + df["Date"] = pd.to_datetime(df["Date"], format="%d/%m/%Y") |
| 64 | + if "enddate" in df: |
| 65 | + df["enddate"] = pd.to_datetime(df["enddate"], format="%d/%m/%Y") |
| 66 | + df = df.set_index("Date") |
| 67 | + if freq: |
| 68 | + df.index = df.index.to_period(freq) |
| 69 | + return df |
| 70 | + |
| 71 | + |
| 72 | +def get(codes, start=None, end=None, last=0, multi=True, freq=None): |
| 73 | + """ |
| 74 | + Retorna um DataFrame pandas com séries temporais obtidas do SGS. |
| 75 | +
|
| 76 | + Parameters |
| 77 | + ---------- |
| 78 | +
|
| 79 | + codes : {int, List[int], List[str], Dict[str:int]} |
| 80 | + Este argumento pode ser uma das opções: |
| 81 | +
|
| 82 | + * ``int`` : código da série temporal |
| 83 | + * ``list`` ou ``tuple`` : lista ou tupla com códigos |
| 84 | + * ``list`` ou ``tuple`` : lista ou tupla com pares ``('nome', código)`` |
| 85 | + * ``dict`` : dicionário com pares ``{'nome': código}`` |
| 86 | +
|
| 87 | + Com códigos numéricos é interessante utilizar os nomes com os códigos |
| 88 | + para definir os nomes nas colunas das séries temporais. |
| 89 | + start : str, int, date, datetime, Timestamp |
| 90 | + Data de início da série. |
| 91 | + Interpreta diferentes tipos e formatos de datas. |
| 92 | + end : string, int, date, datetime, Timestamp |
| 93 | + Data de início da série. |
| 94 | + Interpreta diferentes tipos e formatos de datas. |
| 95 | + last : int |
| 96 | + Retorna os últimos ``last`` elementos disponíveis da série temporal |
| 97 | + solicitada. Se ``last`` for maior que 0 (zero) os argumentos ``start`` |
| 98 | + e ``end`` são ignorados. |
| 99 | + multi : bool |
| 100 | + Define se, quando mais de 1 série for solicitada, a função retorna uma |
| 101 | + série multivariada ou uma lista com séries univariadas. |
| 102 | + freq : str |
| 103 | + Define a frequência a ser utilizada na série temporal |
| 104 | +
|
| 105 | + Returns |
| 106 | + ------- |
| 107 | +
|
| 108 | + ``DataFrame`` : |
| 109 | + série temporal univariada ou multivariada, |
| 110 | + quando solicitado mais de uma série (parâmetro ``multi=True``). |
| 111 | +
|
| 112 | + ``list`` : |
| 113 | + lista com séries temporais univariadas, |
| 114 | + quando solicitado mais de uma série (parâmetro ``multi=False``). |
| 115 | + """ |
| 116 | + dfs = [] |
| 117 | + for code in _codes(codes): |
| 118 | + urd = _get_url_and_payload(code.value, start, end, last) |
| 119 | + res = requests.get(urd["url"], params=urd["payload"]) |
| 120 | + if res.status_code != 200: |
| 121 | + raise Exception("Download error: code = {}".format(code.value)) |
| 122 | + df = pd.read_json(StringIO(res.text)) |
| 123 | + df = _format_df(df, code, freq) |
| 124 | + dfs.append(df) |
| 125 | + if len(dfs) == 1: |
| 126 | + return dfs[0] |
| 127 | + else: |
| 128 | + if multi: |
| 129 | + return pd.concat(dfs, axis=1) |
| 130 | + else: |
| 131 | + return dfs |
0 commit comments