CLI

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

Uso

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

databolsa --list                          # todos os comandos
databolsa getStock PETR4                  # perfil de uma ação
databolsa getStockIndicators PETR4        # indicadores fundamentalistas
databolsa screenStocks --sector Bancos    # screening com filtros
databolsa listDividends VALE3 --json      # JSON cru p/ pipes e scripts
databolsa getPortfolio                    # sua carteira (escopo da chave)

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

databolsa screenFiis --segment Logística --json | jq '.items[].ticker'

Operações de escrita (criar carteira, lançar transação, importar planilha) também viram comandos — elas modificam a sua carteira real (guia completo):

databolsa createPortfolio --name "Dividendos"
databolsa addPortfolioTransaction ID --asset_type stock --symbol PETR4 \
  --kind buy --trade_date 2026-07-10 --quantity 100 --price 38.10
databolsa importPortfolioFile ID --file negociacao-2026.xlsx   # xlsx da B3 ou CSV

Em uploads, --file <caminho> lê o arquivo local e preenche content_base64/filename por você.

Flags globais

Flag	O que faz
`--json`	saída JSON crua (sem formatação)
`--api-url <url>`	aponta para um self-host
`--help`, `--version`	o de sempre

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

Código aberto: packages/cli.

Uso

Flags globais

On this page