## Portal da Transparência / Auxílio Emergencial
Retorna as 50 primeiras parcelas do Auxílio Emergencial a partir do CPF ou NIS que é enviado para a consulta de Benefícios do Portal da Transparência, limitado aos últimos 12 meses.


### Site URL
- https://portaldatransparencia.gov.br/beneficios/auxilio-emergencial

### Request
POST endpoint: `https://api.infosimples.com/api/v2/consultas/portal-transparencia/auxilio`



| Parameter    | Description                                                                                                                                                       |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*       | The token that will authenticate and authorize the request.                                                                                                       |
| cpf**        | CPF do beneficiário.                                                                                                                                              |
| nis**        | NIS do beneficiário.                                                                                                                                              |
| municipio**  | Nome do município.                                                                                                                                                |
| data_inicio* | Start date in ISO 8601 format. For example, April 22, 1985 is represented as "1985-04-22". Make sure to include leading zeros; the format "1985-4-22" is invalid. |
| data_fim*    | End date in ISO 8601 format. For example, April 22, 1985 is represented as "1985-04-22". Make sure to include leading zeros; the format "1985-4-22" is invalid.   |

> * Required parameter.

> ** Optional parameter. Sometimes it is necessary to set at least one of the optional parameters for the service to work properly.


### Response examples (OK)
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": {
    "api_version": "v2",
    "service": "portal-transparencia/auxilio",
    "parameters": {
      "cpf": "11111111111"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.2",
    "requested_at": "2021-06-30T14:37:09.000-03:00",
    "elapsed_time_in_milliseconds": 24004,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX18eVzY1imj++t9yU41NkTl0g8j1Z1p54tzQftm1RaG43TL1yMsyTGDfztRrJzROhsSoDvtAlLD3Vg=="
  },
  "data_count": 1,
  "data": [
    {
      "beneficiario": "Nome de Exemplo",
      "cpf": "***.111.111-**",
      "nis": "1.111.111.111-1",
      "parcelas": [
        {
          "mes_disponibilizacao": "12/2020",
          "parcela": "9ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "202,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 202
        },
        {
          "mes_disponibilizacao": "11/2020",
          "parcela": "8ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "202,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 202
        },
        {
          "mes_disponibilizacao": "10/2020",
          "parcela": "7ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "202,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 202
        },
        {
          "mes_disponibilizacao": "09/2020",
          "parcela": "6ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "202,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 202
        },
        {
          "mes_disponibilizacao": "08/2020",
          "parcela": "5ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "600,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 600
        },
        {
          "mes_disponibilizacao": "07/2020",
          "parcela": "4ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "600,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 600
        },
        {
          "mes_disponibilizacao": "06/2020",
          "parcela": "3ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "600,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 600
        },
        {
          "mes_disponibilizacao": "05/2020",
          "parcela": "2ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "600,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 600
        },
        {
          "mes_disponibilizacao": "04/2020",
          "parcela": "1ª",
          "uf": "SP",
          "municipio": "São Paulo",
          "enquadramento": "BOLSA FAMILIA",
          "valor": "600,00",
          "observacao": "Exemplo de texto",
          "normalizado_valor": 600
        }
      ],
      "site_receipt": null
    }
  ],
  "site_receipts": []
}
```


### Preview file

The preview file (`site_receipts`) in the response JSON may be **synthesized by Infosimples** using data from the source (website/app) that processed the automation if the file generated by the source is not suitable for viewing.

### Code snippets


#### Python
```python
# Tested with: Python 3.10.19, Python 3.14.0
import requests

url = 'https://api.infosimples.com/api/v2/consultas/portal-transparencia/auxilio'
args = {
  "cpf":         "VALUE_OF_PARAMETER_CPF",
  "nis":         "VALUE_OF_PARAMETER_NIS",
  "municipio":   "VALUE_OF_PARAMETER_MUNICIPIO",
  "data_inicio": "VALUE_OF_PARAMETER_DATA_INICIO",
  "data_fim":    "VALUE_OF_PARAMETER_DATA_FIM",
  "token":       "WRITE_YOUR_TOKEN_HERE",
  "timeout":     "300"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

if response_json['code'] == 200:
  print("Retorno com sucesso: ", response_json['data'])
elif response_json['code'] in range(600, 799):
  mensagem = "Resultado sem sucesso. Leia para saber mais: \n"
  mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message'])
  mensagem += "; ".join(response_json['errors'])
  print(mensagem)

print("Cabeçalho da consulta: ", response_json['header'])
print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts'])
```


## We are here to help
Do you still need to figure something out? Reach us at [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) and our highly qualified support team will be happy to help.