Jump to Content
Home
Guia Geral
API Reference
Novidades
Fórum de discussão
Fale Conosco
v1
v2
v3
v4
v4.1
Suporte
Perguntas Frequentes
API Reference
Suporte
Perguntas Frequentes
v4 - API Cadastro
Home
Guia Geral
API Reference
Novidades
Fórum de discussão
Fale Conosco
Autenticação
All
Pages
Start typing to search…
JUMP TO
BEM-VINDO(A)
Introdução
Conceitos importantes
API Cadastro V2
Introdução
Autenticação
Gerar Token
post
Criar Usuário
post
Criar Usuário com Permissões
post
Atribuir Permissão
put
Onboarding
Cliente
Cadastrar Cliente
post
Atualizar Cliente
post
Consultar Um Cliente Pelo Seu ID
get
Detalhar Cliente
post
Buscar Clientes Em Renovação
get
Renovar Cliente
post
Consultar Pendências Cadastrais
get
Schema
Cadastrar Um Novo Esquema JSON
post
Listar Esquemas JSON
get
Consultar Um Esquema JSON Específico Pelo Seu ID
get
Atualizar Um Esquema JSON Existente
put
Inativar Um Esquema JSON Existente
patch
Ativar Um Esquema JSON Existente
patch
Domínio
Consultar Domínio
get
Atualizar Os Dados De Um Domínio Existente
put
Detalhar Os Dados De Um Domínio Com Base Em Parâmetros Específicos
get
Cadastrar Um Novo Domínio
post
Consultar Domínio
get
Atualizar Os Dados De Um Domínio Existente
put
Detalhar Os Dados De Um Domínio Com Base Em Parâmetros Específicos
get
Cadastrar Um Novo Domínio
post
Backoffice
Customer
Criar Nova Conta
post
Bloquear Conta
post
Consultar Bloqueios De Conta
get
Desbloquear Conta
post
Encerrar Conta
post
Consultar Encerramento De Conta
get
Reintegrar Cliente
post
Reprocessar Validação
post
Solicitar Processamento Da Integração Com Sincad
post
Enviar Notificação Para O Cliente
post
Enviar Evento De Atualização Da Visão De Clientes
post
UserView
Atualizar Campos Para Visão De Usuário
put
Consultar Campos Para Visão De Usuário
get
Process
Consultar Protocolo Ativo De Um Cliente
get
Consultar Protocolos De Um Cliente
get
Person
Consultar Uma Persona Criada
get
Consultar Dados Cadastrais De Uma Persona
post
Dashboard
Consultar Clientes Por Estado
get
CustomerUpdateValidation
Consultar Campos Para Validação De Atualização Cadastral
get
Cadastrar Campos Para Validação De Atualização Cadastral
post
Consultar Validação De Atualização Cadastral Por ID
get
Atualizar Campos Para Validação De Atualização Cadastral
put
Excluir Campos Para Validação De Atualização Cadastra
del
CustomerState
Consultar Estados Do Cliente
get
Consultar Pendências
get
Consultar Estado
get
Alterar Estado
post
Listar Cadastros Concluídos
get
Listar Cadastros Não Concluídos
get
Listar Cadastros Expirados
get
Listar Cadastros Renovados
get
Consultar Cadastros Agrupados Pela Persona
get
CustomerPendency
Aprovar Pendências
post
Confirmar Aprovação De Pendências
put
Aprovar Pendências De Atualização
post
Consultar Pendências De Atualização
get
Validation
Solicitar Validação
post
Consultar Validação
get
Consultar Dossie
get
Solicitar Reprocessamento
post
Storage
Obter Um Arquivo
get
Listar Todos Os Arquivos De Um Cliente
get
Salvar Um Arquivo
post
Deletar Um Arquivo
del
Suitability
Mercado
Consultar Mercado Por ID
get
Atualizar Mercado
put
Excluir Mercado
del
Consultar Mercado
get
Criar Mercado
post
Produtos
Criar Produto
post
Consultar Produto
get
Atualizar Produto
put
Excluir Produto.
del
Perfis
Listar Perfis
get
Criar Perfil
post
Atualizar Perfil
put
Excluir Perfil.
del
Quiz
Consultar Quiz Por ID
get
Criar Quiz
post
Atualizar Quiz
put
Excluir Quiz
del
Buscar Quiz Ativo Por Schema
get
Listar Quizzes Ativos
get
Risco
Validar Risco
post
Suitability
Consultar Perfil Suitability
get
Criar Perfil Suitability
post
Desativar Perfil Suitability
patch
Alterar E Renovar Perfil Suitability.
post
SuitabilityVersion
Consultar Versão Do Suitability
get
Criar Versão Do Suitability
post
Atualizar Versão Do Suitability
patch
Terms
Assinatura
Consultar Assinatura
get
Consultar Uma Assinatura Pelo Seu ID
get
Assinar Termo
post
Excluir Assinatura
del
Validar Assinatura
post
Listar Termos Assinados Por Identificador Externo
get
Termos
Consultar Termos
get
Criar Termo
post
Consultar Um Termo Pelo Seu ID
get
Atualizar Termo
put
Excluir Termo
del
API MARKET DATA
Introdução
Autenticação em Market Data
Autenticação
post
Cotações de Ativos
Consulta de cotação de ativo
get
Consulta das maiores altas
get
Consulta das maiores baixas
get
Consulta à lista de mercados
get
Consulta à lista de papéis por empresa
get
Consulta à lista de ativos de um índice
get
Consulta à lista de opções de um ativo
get
Consulta à lista de índices de um mercado
get
Consulta às informações de um ativo
get
Livro de Ofertas
Consulta do livros de ofertas
get
Consulta de melhores ofertas do livro de ofertas
get
Consulta do livro de ofertas agregado
get
Gráfico de ativos
Consulta de uma determinada quantidade de candles
get
Consulta de candles por período (data inicial e final)
get
Aplicações de Notícias
Consulta de notícias por período
get
Consulta de notícias por código
get
Consulta de notícias por código de agência
get
Consulta à uma quantidade determinada de notícias
get
Consulta a fatos relevantes por período
get
Consulta a fatos relevantes de um ativo por período
get
Consulta a fatos relevantes de uma agência por período
get
Consulta à lista de agências de notícias
get
Consulta de notícias que contém um texto específico
get
Negócios realizados
Consulta de negócios realizados por período
get
Consulta de negócios realizados por data
get
Volume por preço
Consulta de volume negociado por preço
get
Ranking de corretoras
Consulta de cross ranking por corretora
get
Consulta de ranking de corretoras por ativo
get
APIs FTP
Tick By Tick
API Trading
Introdução
Autenticação Tradicional
Autenticação Signin
post
Autenticação Broken Service Login
post
Autenticação IAM
Token de Autenticação
post
Token de Negociação
post
Broken Service Login
get
Envio de Ordem
Envio de ordens
Envio de Ordem a Limite
post
Envio de Ordem a Mercado
post
Envio de Ordem Stop
post
Envio de Ordem Stop OCO (One Cancels the Other)
post
Envio de Ordem Stop Mult
post
Envio de Ordem Stop Conditional
post
Envio de Ordem Start
post
Envio de Ordem Stop Moving
post
Edição de ordem
post
Cancelamento de ordem
post
Histórico de ordens
Consulta de histórico de ordens
get
Consulta de ordens enviadas no dia atual por mercado
get
Consulta de ordens enviadas no dia atual por mercado, ativo e status
get
API Dados Financeiros
Introdução
Autenticação em Dados Financeiros
Autenticação
post
Dados Financeiros
Posição Financeira - Completa
get
Posição Financeira - Do dia(aberta)
get
Posição Financeira - Resumida
get
Custos da Conta
get
Ajustes BMF da conta
get
Lucro/Prejuízo Day Trade
get
Limite Operacional
get
Risco Operacional
get
Renda Variável
Custódia em Renda Variável
get
Margens e Garantias
get
Posição em BOVESPA
get
Posição em BM&F
get
Clubes de Investimento
Resumo da Posição
get
Lista de Títulos
get
Detalhamento do Título
get
Tesouro Direto
Resumo da Posição
get
Lista de Títulos
get
Detalhamento do Título
get
Renda Fixa
Resumo da Posição
get
Lista de Títulos
get
Detalhamento do Título
get
Fundos de Investimento
Resumo da Posição
get
Lista de Títulos
get
Detalhamento do Título
get
Proventos
Lista de Proventos
get
Proventos por Ativo
get
Previdência
Lista de Títulos
get
Detalhamento do Título
get
Aluguel de Ações
Lista de Títulos
get
Detalhamento do Título
get
Garantias
Lista de Títulos
get
Detalhamento do Título
get
Termos
Lista de Títulos
get
Detalhamento do Título
get
Alocação de Garantia
Alocação de Garantia
get
Alocação de Garantia
get
API Alocação de Garantia
Introdução
Alocar Garantia
post
Editar Garantia
put
Desalocar Garantia
del
Consultar Garantia Filtro
get
Consultar Garantia
get
Consultar Garantia Pelo ID
get
API Dados Fundamentalista
Introdução
Autenticação
post
Empresas
Listar Empresas
get
Consultar Empresa
get
Listar Relatórios Brutos
get
Listar Todos Relatórios
get
Listar Todos Índices
get
Listar Índices de Avaliação
get
Listar Transações Internas
get
Macroeconomia
Listar Indicadores Macroecônomicos
get
Consultar um Indicador
get
SUPORTE
Perguntas frequentes
Suporte Técnico
Fale Conosco
APIS EM CONSTRUÇÃO
Novas APIs em construção
Powered by
Autenticação
Ask AI
Exemplo de código para criptografia do usuário e senha no envio de Token.
