@databolsa/credit-sdk

Cliente TypeScript tipado da mesa de crédito do DataBolsa. Watchlists, notas, alertas e revisões de regulamento vivem em contrato separado dos dados públicos de mercado.

São sete métodos, um por operação do contrato: o catálogo, o spec e a execução de Functions (leituras) e Actions (escritas). Não há método por recurso — cada capacidade é chamada por id, com sujeito e input no corpo.

Uso

npm install @databolsa/credit-sdk

import { DataBolsaCredit } from "@databolsa/credit-sdk";

const credit = new DataBolsaCredit({
  apiKey: process.env.DATABOLSA_CREDIT_API_KEY,
});

// quem sou eu e em que mesas tenho assento
const me = await credit.executeFunction("credit.me.get", { input: {} });
const orgId = me.result.organizations[0].org_id;

// o que a mesa lê
const { data: leituras } = await credit.listFunctions();

// uma leitura, no sujeito (a mesa)
const notas = await credit.executeFunction("credit.notes.list", {
  subject: { entity_id: orgId },
  input: { limit: 20 },
});

// uma escrita; o spec diz se ela exige `confirmed`
await credit.executeAction("credit.note.create", {
  input: { org: orgId, entity_id: "12345678000195", body: "Concentração subiu." },
  confirmed: true,
});

A chave é pessoal e deve permanecer no servidor. A mesa vem da própria chave, fixada quando ela foi criada — crie-a dentro da mesa em que quer agir.

Descobrir a superfície atual

• listFunctions() e listActions() enumeram as capacidades; getFunction(id) e getAction(id) trazem o input_schema, o sujeito, as unidades e — nas Actions — efeitos, confirmação e evento de auditoria.
• Consulte o OpenAPI da mesa para as sete operações, seus schemas e os erros.
• O pacote exporta CreditPaths, gerado do mesmo contrato.
• Use npx -y @databolsa/credit-cli --list e npx -y @databolsa/credit-cli <operação> --help para descoberta interativa.

DataBolsaCreditError expõe status e o corpo problem+json em problem.

Recursos fora da mesa respondem 404. Licença vencida bloqueia escritas com 402, mas mantém leituras. Toda escrita é auditada. Preserve as unidades e o significado de null descritos pelo contrato.

O mesmo contrato está disponível em @databolsa/credit-cli e @databolsa/credit-mcp. Para dados públicos de crédito e mercado, use @databolsa/sdk.

Apache-2.0. O DataBolsa fornece informação e contexto, não decisão de crédito.