XP Investimentos

Dados do Data Access da XP Inc. para escritórios parceiros e consolidadores: contas, assessores, custódia, captação, positivador, posição, extrato e saldo dos clientes.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 29 actions:

Action	Purpose	Parameters
get_api_v1_account	Frequência de atualização: D-1. A API de Detalhes de Conta do Cliente possui característica de ser uma tabela de dimensão, ou seja, os dados de um mesmo cliente podem aparecer mais de uma vez ao longo do tempo, refletindo alterações cadastrais e de relacionamento. Um mesmo cliente pode possuir múltiplos registros, estando associado a um dimAccountCode diferente e mesmos valores de accountCode, enquanto o vínculo lógico com a conta permanece. Dessa forma: - A coluna dimAccountCode irá variar en	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_account_advisor_relation	Frequência de atualização: D-1 Retenção 60 dias. A API de Clientes do Escritório versus tempo representa uma fato histórica que registra a relação entre cliente, assessor e escritório ao longo do tempo. Essa base pode repetir os dados do mesmo cliente por até 60 dias, pois cada registro representa o vínculo daquele cliente em uma determinada data de referência. Por isso, ao consultar a API, é esperado encontrar até 60 ocorrências do mesmo cliente, refletindo seu histórico nesse período. Com	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_active_customer	Frequência de atualização: D-1. Retorna informações de clientes ativos cadastrados no parceiro e sua condição de atividade mensal na visão Corretora. Uma conta é considerada ativa quando possui custódia em ativos em qualquer valor, ou custódia financeira saldo em conta corretora maior que 100, ou quando houve operação em Renda Variável RV ou compromissadas nos últimos 30 dias; essa regra é aplicada no último dia de cada mês e define o status mensal de atividade da conta na visão Corretora.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_auc	Frequência de atualização: D-1. Custódia por produto e cliente em uma base diária.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_financial_institution	Frequência de atualização: D-1. A funcionalidade de Instituição Financeira disponibiliza, em um só lugar, a lista oficial de todas as instituições do mercado financeiro — como bancos, fundos, securitizadoras, financeiras e outras entidades reguladas. Ela centraliza códigos e nomes padronizados dessas instituições por exemplo, “XP Trend”, “Itaú Unibanco”, “Revolut SCD S.A.”, “UBS Brasil”, garantindo que todos os produtos, relatórios e integrações utilizem a mesma referência.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_inflow	Frequência de atualização: D-1. Registros de captação, considerando apenas novos aportes. Observações: - Os dados disponíveis são apenas de movimentações Onshore. - O tempo de sensibilização na captação varia por produto financeiro.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_movement_type	Frequência de atualização: D-1. Descrição dos tipos de movimentações financeiras.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_office_channel	Frequência de atualização: D-1. Informações do parceiro matriz e das filiais.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_product_partner	Frequência de atualização: D-1. Catálogo de produtos financeiros exclusivos do parceiro autenticado. Retorna apenas os produtos disponíveis para o parceiro que faz a requisição. O catálogo inclui registros de produtos offshore, identificáveis através do campo productType. Os valores possíveis são: - Digital: Produtos de conta offshore disponível no app referência histórica: 'PROJETO DISNEY' - PWM: Produtos de contas offshore separadas Para filtrar produtos offshore com classificação 'OTHER	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_time	Frequência de atualização: D-1. Dimensão de tempo.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_positivador	Frequência de atualização: D-1. Informações detalhadas de clientes, segmentação e movimentação financeira.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_reprocessing_log	Frequência de atualização: D-1. Esta API permite consultar informações do log de reprocessamento dos endpoints disponíveis, indicando o período que deve ser consumido na data de referência para garantir a atualização das informações. Utiliza sintaxe OData para filtros avançados, além de suportar paginação e contagem de registros.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_consolidated_positions_customer_by_customer_code	Frequência de atualização: D0 ou Mensal. Obtém dados de posição consolidada do cliente: - Retorna a Posição diária D0 - Posição diária D0 - Retorna a Posição histórica de um mês anterior quando informado o parâmetro monthYear - Posição histórica - Caso você não precise da informação atualizada em tempo real, evite realizar chamadas para buscar dados em D0 dia corrente, para não consumir recursos desnecessariamente. - Recomenda-se aguardar pelo menos 5 minutos antes de buscar nova atualização.	customerCode (string) required monthYear (string)
get_api_v2_positions_customers_by_customer_code	Frequência de atualização: D-3. Essa API obtém os dados das posições de um cliente baseado na data de referência e no filtro de produtos. As consultas são realizadas por cliente, intervalo de datas e tipos de produtos, retornando arrays separados por categoria de produto COE, Fundos, Renda Fixa, Conta Corrente, Previdência, Repo, Tesouro, Ações e Fundos Negociados. Observação: O intervalo de dias entre as datas inicial e final de referência não pode ser maior que 15 dias.	customerCode (integer) required startDate (string) required endDate (string) required productTypes (array) required
get_api_v1_wealth_evolution_customer_by_customer_code	Frequência de atualização: D-3. Obtém dados de evolução patrimonial de clientes. Os dados retornados referem-se a D-3, ou seja, consolidados até três dias antes da data da consulta. Observação: O intervalo de dias entre as datas inicial e final de referência não pode ser maior que 31 dias. Essas informações do EVP são processadas a cada 24 horas. Portanto, se os dados foram atualizados em uma data/hora inferior a 24 horas em relação à data e hora atual, o dado ainda é considerado atualizado.	customerCode (integer) required startDate (string) required endDate (string) required
get_api_v1_investment_account_statement_customer_by_customer_code	Frequência de atualização: D0. Obtém dados de movimentações financeiras da conta investimento do cliente em D0. Observação: O parâmetro productType aceita apenas o valor TED no momento, filtrando a resposta para mostrar somente movimentações TED.	customerCode (integer) required startDate (string) required endDate (string) required page (integer) required productType (string) pageSize (integer) required
get_api_v1_investment_account_balance_customer_by_customer_code	Frequência de atualização: D0. Esta API fornece informações detalhadas sobre o saldo das contas de investimento de um cliente no dia corrente que é feita a chamada na API. São retornados dados como valor, conta, marca, e data da última atualização.	customerCode (string) required
get_api_v1_digital_account_balance_customer_by_customer_code	Frequência de atualização: D0. Esta API permite obter informações detalhadas sobre o saldo da conta digital do cliente, incluindo saldo disponível, bloqueado e limite de cheque especial. Utilizada para consultar no dia corrente D0 os principais saldos financeiros dos clientes vinculados a um parceiro parceiro.	customerCode (integer) required
get_api_v2_operations_customers_by_customer_code	Frequência de atualização: D-3. Esta API permite obter informações detalhadas sobre as operações financeiras movimentações realizadas pelos clientes, incluindo fundos, renda fixa, previdência, tesouro, COE, ações, fundos negociados e operações de repos. As consultas são por cliente e por intervalo de datas. Observação: O intervalo de dias entre as datas inicial e final de referência não pode ser maior que 15 dias.	customerCode (string) required productTypes (array) required startDate (string) required endDate (string) required
get_api_v1_midia	Frequência de atualização: D-1. API para obtenção de dados de tentativas de cadastro de clientes em jornadas digitais do parceiro, incluindo contexto de mídia, origem de acesso e informações técnicas da interação.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_terms	Frequência de atualização: D-1. Disponibiliza a consulta dos termos contratuais assinados ou não pelos clientes e permite que o parceiro verifique, para um determinado cliente, quais termos foram aceitos, quais estão pendentes e os detalhes de cada aceite Data, Versão, Status.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_advisor	Disponível para: parceiros B2B. Frequência de atualização: D-1. Informações dos assessores.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_commission	Disponível para: parceiros B2B. Frequência de atualização: D-1. Fechamento mensal de comissão.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_crm_tag	Disponível para: parceiros B2B. Frequência de atualização: D-1. Informações das tags associadas às contas de clientes.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_crm_task	Disponível para: parceiros B2B. Frequência de atualização: D-1. Detalhes das tarefas relacionadas às contas dos clientes.	$filter (string) $skip (integer) $top (integer) $count (boolean)
get_api_v1_advisor_office	Disponível para: parceiros WS. Frequência de atualização: D-1. Esta API permite obter uma lista de assessores vinculados a um parceiro específico em D-1. Inclui dados como nome, e-mail, código do parceiro, se o assessor é master e se está ativo.	isMaster (boolean) isActive (boolean) page (integer) limit (integer)
get_api_v1_contracts_by_customer_code	Disponível para: parceiros WS. Frequência de atualização: D-0. Esta API retorna o estado do contrato por cliente, consultando o vínculo contratual associado ao código informado no path.	customerCode (integer) required
get_api_v2_customers	Disponível para: parceiros WS, consolidadores. Frequência de atualização: D-0. Esta API retorna, em D-0, os dados dos clientes habilitados para o escritorio. A consulta pode ser feita de forma completa para o escritorio ou filtrada pelo parametro opcional customerCode.	customerCode (integer)
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)