# Formatar número

> Formata um número com as casas decimais e os separadores que você escolher: 1995.5 vira 1.995,50.

Endereço: https://docs.nextags.com.br/referencia/ferramentas/formatar-numero/
Tipo: Endpoint

```http
POST https://app.nextagsai.com.br/api/tools/format_number
X-ACCESS-TOKEN: <sua chave de API>
```

Formata um número com as casas decimais e os separadores que você escolher: `1995.5` vira `1.995,50`. Use para mostrar um valor em reais numa mensagem.

Autenticação: Mande a chave de API da conta no cabeçalho `X-ACCESS-TOKEN` de cada chamada. Veja [Autenticação com a chave de API](https://docs.nextags.com.br/comecar/autenticacao/).

## Corpo da requisição (formulário, application/x-www-form-urlencoded)

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `number` | number | sim | O número, com ponto decimal (`1995.5`). |
| `decimals` | integer | não | Quantas casas decimais, como `2`. |
| `decimal_separator` | string | não | O separador decimal, como `,`. |
| `thousands_separator` | string | não | O separador de milhar, como `.`. |

```json
{
  "number": 1995.5,
  "decimals": 2,
  "decimal_separator": ",",
  "thousands_separator": "."
}
```

## Exemplo

```bash
curl -X POST "https://app.nextagsai.com.br/api/tools/format_number" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  --data-urlencode 'number=1995.5' \
  --data-urlencode 'decimals=2' \
  --data-urlencode 'decimal_separator=,' \
  --data-urlencode 'thousands_separator=.'
```

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

O número formatado, em `data`.

| Campo | Tipo | Descrição |
|---|---|---|
| `data` | string ou number | O número formatado. Com separadores, vem como texto. |

```json
{
  "data": "1.995,50"
}
```

### 401 Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja [Autenticação](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```