Seções da documentação
Cotas e limites
Valem dois limites: uma cota mensal de chamadas, que pertence à conta, e um número de requisições por minuto, que depende da credencial que a requisição leva. Consultar o que resta nunca é contabilizado.
Cota mensal, por conta
A cota pertence à conta, não a uma chave: as chamadas de todas as chaves contam para um único total. Ela é zerada no início de cada mês do calendário em UTC. Uma chamada recusada (uma chave ausente ou inválida, uma calculadora desconhecida, um corpo que não pode ser lido) não custa nada, e uma chamada em que o serviço falha depois de contabilizá-la é devolvida.
| Plano | Chamadas por mês | Chaves | Endpoint em lote |
|---|---|---|---|
| Free | 5 | 1 chave de API | Não |
| Pro · $9 por mês | 100 | 3 chaves de API | Não |
| API · $19 por mês | 10.000 | 5 chaves de API | Sim, até 50 por requisição |
Uma cota esgotada é 402, nunca 401 ou 429; veja Erros.
Uso
GET /api/py/v1/usage responde a uma chave ou a uma sessão conectada com o que a conta usou neste mês e o que resta, o estado do excedente e as chamadas atribuídas a cada uma das suas chaves. Consultá-lo nunca é contabilizado, então um programa pode mostrar as chamadas restantes quantas vezes quiser, dentro do limite por minuto.
A série diária
Adicione ?days=N, um número inteiro de 1 a 90, e a resposta ganha daily: exatamente N entradas {date, calls}, da mais antiga para a mais recente, terminando na data de hoje em UTC. Um dia sem chamadas aparece com 0. Cada dia soma as chamadas da conta em todas as suas chaves, descontadas as chamadas devolvidas. Sem days, a resposta não muda.
| Campo | Descrição |
|---|---|
| tierstring | O plano da conta: free, pro ou api. |
| periodstring | O mês do calendário, YYYY-MM (UTC). |
| resetAtstring | Quando a cota é zerada: o primeiro instante do próximo mês. |
| allowance, used, remaininginteger | A cota do mês, as chamadas contabilizadas nela descontadas as devoluções, e o que resta. |
| overageobject | Excedente com pagamento por uso: se a conta tem direito, se está ativado, e o seu uso e o seu teto. |
| keysarray | Cada chave da conta: keyId, label, client, active, used, lastUsedAt. |
| rateLimitPerMinuteinteger | O limite por minuto da credencial que a requisição levava. |
| daily{date, calls}[] | Só com ?days=N: as chamadas de cada um dos últimos N dias em UTC. |
Cabeçalhos de uso
Toda resposta contabilizada (uma chamada a uma calculadora, um lote, um trabalho enviado com uma chave) traz os mesmos números em cabeçalhos que um navegador consegue ler:
| Cabeçalho | Significado |
|---|---|
| X-Usage-Allowance | A cota mensal da conta. |
| X-Usage-Used | Chamadas contabilizadas neste mês, incluindo esta. |
| X-Usage-Reset | Quando a cota é zerada (ISO-8601, UTC): o primeiro instante do próximo mês. |
| X-Usage-Overage | Presente apenas quando houve excedente com pagamento por uso contabilizado neste mês: quantas chamadas. |
Requisições por minuto, por endereço
O limite por minuto depende da credencial que a requisição leva, não do plano. Acima dele, a API responde 429 com um cabeçalho Retry-After. Os endpoints da autorização de dispositivo seguem o limite sem credencial, não importa o que levem.
| A requisição leva | Requisições por minuto |
|---|---|
| Nenhuma credencial | 30 |
| Sessão conectada | 60 |
| Chave de API | 120 |
Outros limites
- Um lote leva no máximo 50 cálculos; veja Lote.
- 3 trabalhos de simulação na fila ou em execução ao mesmo tempo, por chamador; veja Trabalhos de simulação.