Referência da API

Esta página lista os enums e modelos compartilhados expostos pelo pacote Python investflex. Campos de estratégia com valores discretos têm enums tipados para que as constantes apareçam no autocomplete da IDE. O SDK serializa cada enum no formato esperado pela API: string para membros (str, Enum) e inteiro para IntEnum.

from investflex.models.common import (
    Side, TimeInForce, OrdType, SecurityExchange,
    AgressionLevel, ExecStrategy, ExecutionType, ExecutionLimit,
    Trigger, CompensateExec, BookDepth, DeltaType, ExecutionMode,
    TriggerType, TriggerEntryType, StopTypeOCO, SniperType,
    RetroalimentType, SelectStopByPrice, ReversionType, CustomOrdType,
    ExitWhen, CandleTimeFrame, CandleUpdate, EntranceMoment,
    PriceUnit, TargetPriceMode, RelativeType, RelativeDirection,
    AlgoStatus,
)

import {
  Side,
  TimeInForce,
  OrdType,
  SecurityExchange,
  AgressionLevel,
  ExecStrategy,
  ExecutionType,
  ExecutionLimit,
  Trigger,
  CompensateExec,
  BookDepth,
  DeltaType,
  ExecutionMode,
  TriggerType,
  TriggerEntryType,
  StopTypeOCO,
  SniperType,
  RetroalimentType,
  SelectStopByPrice,
  ReversionType,
  CustomOrdType,
  ExitWhen,
  CandleTimeFrame,
  CandleUpdate,
  EntranceMoment,
  PriceUnit,
  TargetPriceMode,
  RelativeType,
  RelativeDirection,
  AlgoStatus,
} from "@investflex/sdk";

Enums

Side

Lado da ordem. Tipo do membro: str.

TimeInForce

Validade no nível da estratégia (TimeInForce) e da perna (LegTimeInForce). Tipo do membro: str.

OrdType

Tipo de ordem. O campo enviado é LegOrdType, mantido como alias compatível deste enum. Tipo do membro: str.

SecurityExchange

Enum de conveniência para LegSecurityExchange. O campo aceita SecurityExchange | str, então também é possível passar uma string direta.

Enums de execução e gatilho

AlgoStatus

Status da estratégia na API, conforme o executionengine, não o enum FIX de ordens. is_terminal (Python) e isTerminal() (TypeScript) são verdadeiros somente para FINISHED (5) e CANCELED (7), independentemente das execuções.

Correção de compatibilidade: os antigos membros PARTIALLY_FILLED, FILLED, EXPIRED, DONE, REJECTED e REPLACED eram incorretos e foram removidos, sem aliases numéricos. OrderStatus não mudou. PENDING_NEW mantém o nome público; o motor chama os códigos 10 e 99 de PENDINGNEW e UNKNOWN_STATUS. Os helpers de início continuam aguardando durante aprovação, agendamento e status desconhecido.

Flags Y/N

Alguns campos são booleanos representados como strings na API ("Y" / "N"). O SDK mantém esses campos como literais:

• "Y" — verdadeiro / habilitado
• "N" — falso / desabilitado

Exemplos: init_suspended, bypass_firewall, using_financial_volume, limit_by_volume, consider_cross_orders, simulate_sniper_on_resting, allow_partial_exit, use_auction_open_price, use_level3, use_preservation, use_retroaliment, use_start_when_cross, send_stop_loss_on_end, zerar_stop_loss, to_market_trigger_value_enabled e use_stop_gain_global_finance.

Modelos

Os tipos abaixo são objetos Python tipados que o SDK retorna nos serviços REST e de streaming. Todos são modelos Pydantic v2: os campos podem ser acessados como atributos e .model_dump() produz um dicionário seguro para JSON.

AlgoHandle

Retornado por client.algos.create(...). É uma referência leve para uma estratégia enviada.

StrategySnapshot

Retornado por client.algos.get(...) e emitido por client.algos.stream(). Representa o estado atual de uma estratégia.

Veja Snapshots e Streaming para detalhes do payload completo.

Peça o detalhe. client.algos.get(clord_id, detailed=True) e client.algos.list(detailed=True) pedem o registro completo. Sem isso a corretora responde com um resumo que não traz nem as pernas nem os CustomParameters, então legs vem vazio e todos os parâmetros sob os quais a estratégia está de fato rodando somem — indistinguível de uma estratégia que realmente não tem nenhum.

Modelos de market data (investflex.models.marketdata)

Modelos dos feeds mdhub (investflex.models.mdh)

Produzidos por MarketDataService.parse() para os feeds /mdh (subscribe_trd, subscribe_mbp, …). Todo modelo estende MdhEvent (feed, symbol, security_id, timestamp, campos de sequência); todos os campos são opcionais e campos desconhecidos são preservados. Os nomes seguem o camelCase do wire do broadcaster, com alias em snake_case.

A lista completa de campos por modelo, o formato dos eventos e os equivalentes TypeScript (Mdh*Schema) estão em Feeds mdhub.

Position

Retornado por client.positions.list(), .get(account) e .consolidated(...).

Position.pnl(market_price) calcula o resultado a mercado no cliente usando um preço de referência informado pelo chamador.

User / Account

Retornados por client.users.get(user_name) e client.users.accounts(user_name).

É o único lugar em que a corretora informa quais códigos de conta um login pode negociar: não há endpoint de diretório de contas nem claim de conta no JWT. Deduzir a conta a partir das posições em aberto só encontra contas que já carregam risco — e não encontra nada para um usuário zerado.

Só user_name e accounts podem invalidar este modelo. Todo campo restante vira None se a corretora enviar um formato inesperado, porque perder a lista de contas por causa de um campo que ninguém lê é exatamente a falha que este modelo existe para evitar — para quem trata erro com plano B, é indistinguível de um usuário sem contas. O valor bruto continua acessível via model_extra.

user_type.id vale conhecer: /v1/users/{user_name}/accounts responde lista vazia para um tipo de usuário que não seja assessor nem cliente final, o que distingue "sem permissão" de "nenhuma conta cadastrada".

Cada Account traz code, exchange, type (o código numérico de tipo de conta da corretora, não um rótulo) e name. A bolsa importa: uma conta pertence a exatamente uma, e a corretora recusa a ordem cuja conta não corresponda à bolsa da perna. XBSP é o mercado à vista da B3 e XBMF, o segmento de derivativos — uma ordem de futuros enviada com a conta de ações é rejeitada mesmo que ambos os códigos sejam válidos para o usuário.

User.account_codes(exchange=None) devolve os códigos distintos na ordem da própria corretora, opcionalmente restritos a uma bolsa. client.users.account_codes(user_name) lê o endpoint mais barato /v1/users/{user_name}/accounts, que responde "este login pode negociar?" mas descarta a bolsa.

Helpers

new_clord_id() -> str

Gera um ID cliente seguro para reenvio (uuid4 hexadecimal, 32 caracteres). O SDK chama esse helper automaticamente em client.algos.create(...) quando você não informa clord_id= explicitamente.