KRXDocumentação
Painel
Sistema
Primeira integração? Comece aqui

Entre na sua conta e crie uma chave em Meu painel → API Keys. Nos exemplos, substitua SUA_CHAVE_KRX pela sua chave. No Playground, a chave ativa da conta é carregada automaticamente.

JavaScript: salve como exemplo.mjs e execute node exemplo.mjs com Node.js 20+. Python: instale pip install requests e execute python exemplo.py. TypeScript usa Node.js e as definições @types/node.

Rotas de conta usam o JWT de POST /api/auth/login no cabeçalho Authorization: Bearer TOKEN_DA_SESSAO. IDs e códigos de e-mail devem vir das etapas anteriores do fluxo.

Confira success além do status HTTP: Consultas e Free Fire podem informar falhas em JSON com HTTP 200. Arquivos usam o tipo indicado em Content-Type; o saldo vem em X-KRX-Remaining-Credits.

↓ Baixar especificação OpenAPI
Docs/Sistema
/ SISTEMA

Testar chave

Testar rota

Confirma que a autenticação por API Key, o controle de créditos e o registro de uso estão funcionando.

GET/api/v1/test
AutenticaçãoAPI Key
Custo1 REQ/dia
Respostaapplication/json
Estado Disponível

Exemplo de uso

Enviar echo=teste concluído para validar sua chave e observar o saldo após a cobrança.

KEY

Chave KRX no cabeçalho

Envie x-api-key: SUA_CHAVE_KRX. Os exemplos já incluem esse cabeçalho.

Parâmetros

CampoTipo / presençaComo usar
echoquery stringstringOpcionalTexto opcional devolvido na resposta.
Exemplo: teste concluído

Requisição completa

Copie o exemplo, informe sua credencial e execute. Os parâmetros abaixo correspondem ao caso de uso desta rota.

test.mjsjavascript · 20 linhas
// Node.js 20+. Testar chave
const response = await fetch("https://api.krxdev.site/api/v1/test?echo=teste+conclu%C3%ADdo", {
  "method": "GET",
  "headers": {
    "Accept": "application/json",
    "x-api-key": "SUA_CHAVE_KRX"
  },
  signal: AbortSignal.timeout(90000)
});
​
if (!response.headers.get("content-type")?.includes("application/json")) {
  throw new Error("A API não retornou JSON. Verifique a disponibilidade do servidor.");
}
const payload = await response.json();
if (!response.ok || payload.success === false) {
  throw new Error(payload.error?.message || `Falha HTTP ${response.status}`);
}
​
const resultado = payload.data;
console.log(resultado);
UTF-8 · 663 bytes

Resposta de exemplo

Confirma que a autenticação por API Key, o controle de créditos e o registro de uso estão funcionando.

Exemplo ilustrativo com os campos retornados pela implementação. IDs, datas, saldo e dados dinâmicos mudam a cada chamada.

HTTP 200 · application/jsonjson · 10 linhas
{
  "success": true,
  "status": 200,
  "data": {
    "message": "A KRX está respondendo corretamente.",
    "echo": "teste concluído",
    "remainingCredits": 999,
    "timestamp": "2026-09-18T12:00:00.000Z"
  }
}
UTF-8 · 216 bytes
CampoO que contém
data.messageValor retornado pelo servidor.
data.echoValor retornado pelo servidor.
data.remainingCreditsValor de saldo depois desta chamada.
data.timestampValor retornado pelo servidor.

Falhas e como tratar

401INVALID_API_KEY

A chave não existe, foi revogada ou está ausente.

402INSUFFICIENT_CREDITS

A conta não possui créditos suficientes.

429API_RATE_LIMIT

O limite de requisições da chave foi atingido.

403PLAN_ACCESS_REQUIRED

Seu plano precisa incluir a categoria desta rota.