Referência da documentação do QuantCraft

O QuantCraft traz dois tipos de documentação complementares: tópicos integrados que você lê dentro do IDE e Markdown de referência de estratégias incluído no produto para o detalhe da API. Juntos, descrevem como escrever estratégias, executar backtests e usar o IDE. Esta documentação web espelha muitos desses tópicos — comece pela Introdução ou por Primeiros passos.

---

Onde ler a documentação no aplicativo

1. Abra o QuantCraft pelo aplicativo principal.
2. Expanda a barra lateral direita (se estiver recolhida).
3. Abra a aba Documentation (ao lado do QuantCraft AI).

Você chega a um índice pesquisável de tópicos. Digite na caixa de busca para filtrar por título, resumo ou palavras-chave incorporadas (por exemplo on_finish, PaperAccount, chart_indicator_series).

Toque em um cartão de tópico para abrir o artigo completo. Use Back para voltar ao índice.

---

Índice de tópicos (no aplicativo)

Os tópicos são agrupados em duas seções, como na barra lateral Documentation.

Getting started

Reference

Qualquer cartão do índice que ainda não abra um artigo completo aparece rotulado como Soon na interface.

---

Como a documentação integrada se relaciona com o seu fluxo de trabalho

Use este mapa rápido quando estiver fazendo algo no IDE:

Os artigos integrados são escritos para autores de estratégias e usuários do IDE. A configuração de servidor do QuantCloud para operadores não é coberta por esta documentação pública.

---

Importações de estratégia

Escreva toda importação como quantcraft.*, com nomes de módulo sem sufixo (por exemplo quantcraft.inputs, não quantcraft.inputs_module). Os caminhos antigos ide.* e quantcraft.*_module ainda funcionam, assim como quantcraft.backtest.* — o antigo nome do pacote antes de ser renomeado para quantcraft.process.* —, de modo que as estratégias existentes continuam funcionando sem alterações — mas não escreva código novo com eles.

Reexportações mais curtas também funcionam: quantcraft.indicator_series, quantcraft.account. Para Fama-French, prefira from quantcraft import fama_french e leia fama_french.qc dentro dos callbacks.

Acesso às linhas Fama-French: dataset["rows"] é um dict YYYYMM → valores, não uma lista. Use .row(...) ou .rows_chronological(...); latest_row(...) somente em execuções forward (no backtest é antecipação — veja Fatores Fama-French). Não use rows[0] / rows[-1].

Não use pacotes internos como quantcraft.b2.* (a camada de download de dados por trás dos carregadores de preços e dados fundamentalistas) nem quantcraft.ai_assistant.* em scripts de estratégia — são auxiliares internos, não a API de estratégias. Não confunda quantcraft.process.ohlcv (API OHLCV de estratégias) com quantcraft.b2.ohlcv (camada de dados interna).

Auxiliares transversais

quantcraft.cross_sectional tem auxiliares vetorizados para comparar muitos símbolos de uma vez (numpy): stack_field, latest_return, latest_sma, latest_std, latest_rsi, rank, zscore, demean, winsorize, além de ColumnarBarArena.

Somente execuções forward / em massa como escrito. Em um backtest, rt.qc_ohlcv_by_symbol guarda o intervalo completo carregado de cada símbolo, então "o mais recente" ali significa a última barra do teste — antecipação. Em um backtest, colete os fechamentos de cada símbolo a partir da sua bar enquanto a execução avança e passe esses arrays aos auxiliares.

Identificadores de módulo vs nomes importados

quantcraft.process.runtime e quantcraft.fama_french são aliases de módulo, então o acesso por atributo lê o valor vivo da sessão:

Todo o resto reexporta nomes por valor, então from ... import <name> vincula um instantâneo tirado no momento da importação.

Para os identificadores que o mecanismo atribui a cada execução, o mecanismo revincula esses nomes no arquivo raiz do algoritmo depois de carregá-lo, então a forma from ... import é segura ali — para os nomes que ele revincula:

• Backtest / Debug Test: account, chart_indicators, get_bar, qc_ohlcv, qc_ohlcv_by_symbol, qc_ohlcv_by_tf, qc_fundamentals, qc_fama_french, qc_calendar.
• Execuções forward: apenas account, qc_fundamentals e qc_fama_french — então, para chart_indicators e os identificadores OHLCV, use rt.<name> ali.

Um módulo auxiliar separado é diferente: ele permanece em cache em sys.modules entre execuções no mesmo processo, então um nome importado mantém o identificador da sessão vigente na primeira importação — desatualizado para a próxima execução (forward / em massa). Nos módulos auxiliares, importe o módulo e use acesso por atributo:

from quantcraft.inputs import params é a exceção: params é um único objeto vivo cujos valores mudam a cada execução, então a forma from é segura em qualquer lugar — veja Parâmetros de entrada.

---

Referência de estratégia incluída (Markdown)

Para o comportamento dos módulos linha a linha, os contratos dos callbacks e os detalhes do mecanismo, o produto também inclui Markdown no pacote quantcraft-dev (conceitualmente: "referência de estratégias do QuantCraft"). Um sumário típico é este:

Esses arquivos são voltados a autores de estratégias que precisam dos nomes e contratos exatos. Tópicos avançados como BACKTEST_MODULE (ponto de entrada WebSocket do backtest) e IDE_BACKTEST_RUNNER (executor em subprocesso) estão incluídos no pacote para colaboradores, mas não são caminhos principais de usuário. O QuantCraft AI no IDE vem pré-carregado com esse material para que as respostas fiquem alinhadas aos módulos distribuídos.

---

Outras superfícies de ajuda no QuantCraft

Elas não são a aba Documentation, mas fazem parte do mesmo "ecossistema de referência" para os usuários:

• QuantCraft AI — Faça perguntas em linguagem natural; as respostas podem citar o mesmo corpus de desenvolvimento. Conecte um modelo em AI → API Providers (sua própria chave, ou QuantCraft Premium / opções hospedadas).
• Importar e exportar — Mova arquivos .py (e relacionados) entre o disco e o espaço de trabalho.
• Resultados dos testes — Gráfico de patrimônio, métricas, operações e exportação HTML após um backtest.

---

Dicas de busca

• Prefira termos curtos que aparecem no código: on_finish, params, chart_indicator_series, coerce_chart_time, pane_id.
• Se nada corresponder, limpe a busca — o índice lista cada tópico por seção.
• Ideias que cruzam tópicos (por exemplo "dados fundamentalistas + on_bar") costumam precisar de dois artigos: abra Dados fundamentalistas para o formato dos dados e depois Ciclo de vida da estratégia para saber quando estão disponíveis.

---

Histórico do documento

A documentação integrada é mantida junto com o runtime de estratégias. Quando os módulos Python ou a carga do backtest mudam, os tópicos integrados e o Markdown incluído são atualizados juntos para que exemplos e nomes permaneçam sincronizados. Os exemplos de importação de estratégia são escritos em todo o texto com caminhos quantcraft.* sem sufixo; os caminhos antigos ide.*_module e quantcraft.*_module são documentados apenas como auxílio de leitura para scripts existentes.