DataBolsa docs

CLI

@databolsa/cli — dados públicos no terminal, com descoberta pelo contrato e atalho para a Wallet.

npm install -g @databolsa/cli
# ou sem instalar:
npx -y @databolsa/cli getHealth

Configure a chave (criada em databolsa.com/conta/config):

export DATABOLSA_API_KEY=db_live_SUACHAVE

Para agentes de código

A skill pública databolsa-cli ensina Claude Code, Pi e outros agentes a usar a CLI com JSON estruturado e descobrir os comandos atuais pelo contrato:

npx skills add databolsahq/databolsa --skill databolsa-cli --agent claude-code

Veja o guia de Agent Skills para instalar e atualizar. A skill usa DATABOLSA_API_KEY somente pelo ambiente; nunca coloque a chave num prompt ou arquivo versionado.

Uso

Um comando por operação do contrato — mesmos nomes da referência:

databolsa --list                          # todos os comandos
databolsa getObjectHistory <id> --facts close --limit 5 # série de fechamento do papel
databolsa getStockIndicators PETR4        # indicadores fundamentalistas
databolsa resolveObject --q PETR4         # a ficha do papel no grafo de objetos
databolsa rankObjects --kind equity_security --fact pl --where 'pl<10' --order asc # screening
databolsa listCorporateEvents VALE3 --json # JSON cru p/ pipes e scripts
databolsa listInsiderMoves PETR4          # saldo mensal de insiders no papel

--json imprime a resposta crua — combina com jq:

databolsa rankObjects --kind fund --subkind fii --fact fii_dy_12m_current --where 'fii_segment=Logística' --json | jq '.data[] | [.name, .value]'

Carteiras, suitability e suas escritas pertencem ao contrato separado da Wallet. Use o cliente próprio ou o atalho descrito abaixo; não tente uma operação de carteira diretamente no contrato de mercado.

Atalho da Wallet

A CLI principal mantém um atalho para a Wallet. O primeiro token wallet seleciona o contrato próprio da extensão e usa o mesmo motor, chave e flags.

databolsa wallet --list
databolsa wallet listPortfolios
databolsa wallet getPortfolioDetail ID --json | jq .totals

A credencial ou conexão OAuth determina um único workspace, e a CLI não troca essa vinculação. Use outra credencial ou refaça o consentimento OAuth para agir em outro workspace.

O atalho não indica que a Wallet esteja instalada: --list e --help apenas leem o contrato e podem funcionar sem acesso. Uma chamada real em workspace sem a extensão responde 404 wallet_not_installed; se estiver suspensa, leituras continuam e escritas respondem 403 wallet_suspended.

@databolsa/wallet-cli (databolsa-wallet …) é a entrada canônica e deve ser preferida em scripts e integrações duradouras. Dentro do checkout do DataBolsa, use bun run cli:wallet -- <operação> para não deixar o workspace npm sombrear o binário publicado. O atalho não estabelece um padrão para outras extensões. Veja Wallet.

Flags globais

FlagO que faz
--jsonsaída JSON crua (sem formatação)
--api-url <url>aponta para um self-host
--help, --versiono de sempre

Códigos de saída: 0 ok · 1 erro da API · 2 uso incorreto · 3 recurso indisponível.

Código aberto: packages/core/cli.